Pink-Crab/Perique-Route

<?php

declare(strict_types=1);

/**
 * THe Abstract base for all routes and groups.
 *
 * @package PinkCrab\Route\Route
 * @author Glynn Quelch glynn@pinkcrab.co.uk
 * @since 0.0.1
 */

namespace PinkCrab\Route\Route;

use WP_REST_Request;
use PinkCrab\WP_Rest_Schema\Argument\Argument;

abstract class Abstract_Route {

    /**
     * @var string
     */
    protected string $namespace = '';

    /**
     * @var Argument[]
     */
    protected array $arguments = array();

    /**
     * @var array<int, callable(WP_REST_Request $request):bool>
     */
    protected array $authentication = array();

    /**
     * Get the value of namespace
     *
     * @return string
     */
    public function get_namespace(): string {
        return $this->namespace;
    }

    /**
     * Get the value of arguments
     *
     * @return Argument[]
     */
    public function get_arguments(): array {
        return $this->arguments;
    }

    /**
     * Adds a single argument to the arguments list.
     *
     * @param Argument $argument
     * @return static
     */
    public function argument( Argument $argument ) {
        $this->arguments[ $argument->get_key() ] = $argument;
        return $this;
    }

    /**
     * If an argument exists.
     *
     * @param string $key
     * @return bool
     */
    public function has_argument( string $key ): bool {
        return \array_key_exists( $key, $this->arguments );
    }

    /**
     * Add a single callback authentication stack
     *
     * @param callable(\WP_REST_Request): bool $auth_callback
     * @return static
     */
    public function authentication( callable $auth_callback ) {
        $this->authentication[] = $auth_callback;
        return $this;
    }

    /**
     * Get the value of authentication
     *
     * @return  callable[]
     */
    public function get_authentication(): array {
        return $this->authentication;
    }
}