Intraxia\Jaxion\Http\Router

Complexity

Total Complexity

22

Size/Duplication

Total Lines	208
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	5

Test Coverage

Coverage

91.53%

Importance

Changes

0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	get_endpoints()	0	3	1
A	set_vendor()	0	5	1
A	set_version()	0	5	1
A	register()	0	17	4
A	group()	0	9	2
B	__call()	0	24	7
A	set_options()	0	15	4
A	get_namespace()	0	3	1
A	action_hooks()	0	8	1

<?php
namespace Intraxia\Jaxion\Http;

use Intraxia\Jaxion\Contract\Core\HasActions;
use InvalidArgumentException;

/**
 * Class Router
 *
 * A simplified interface for registering routes with the WP-API.
 *
 * @package Intraxia\Jaxion
 * @subpackage Http
 *
 * @method Endpoint get(string $route, callable $callback, array $options = array())
 * @method Endpoint post(string $route, callable $callback, array $options = array())
 * @method Endpoint put(string $route, callable $callback, array $options = array())
 * @method Endpoint patch(string $route, callable $callback, array $options = array())
 * @method Endpoint delete(string $route, callable $callback, array $options = array())
 * @method Endpoint editable(string $route, callable $callback, array $options = array())
 * @method Endpoint all(string $route, callable $callback, array $options = array())
 */
class Router implements HasActions {
	/**
	 * Resource's vendor prefix.
	 *
	 * @var string
	 */
	protected $vendor;

	/**
	 * Resource's version.
	 *
	 * @var int
	 */
	protected $version;

	/**
	 * Valid methods and their HTTP verb(s).
	 *
	 * @var array
	 */
	private $methods = array(
		'get'      => 'GET',
		'post'     => 'POST',
		'put'      => 'PUT',
		'patch'    => 'PATCH',
		'delete'   => 'DELETE',
		'editable' => 'POST, PUT, PATCH',
		'all'      => 'GET, POST, PUT, PATCH, DELETE',
	);

	/**
	 * Endpoints registered for the resource.
	 *
	 * @var Endpoint[]
	 */
	protected $endpoints = array();

	/**
	 * Returns all the resource endpoints.
	 *
	 * @return Endpoint[]
	 */
	public function get_endpoints() {
		return $this->endpoints;
	}

	/**
	 * Sets the resource's vendor prefix.
	 *
	 * @param string $vendor
	 *
	 * @return $this
	 */
	public function set_vendor( $vendor ) {
		$this->vendor = $vendor;

		return $this;
	}

	/**
	 * Sets the resource's version.
	 *
	 * @param int $version
	 *
	 * @return $this
	 */
	public function set_version( $version ) {
		$this->version = $version;

		return $this;
	}

	/**
	 * Registers all of the routes with the WP-API.
	 *
	 * Runs on the `rest_api_init` hook. Registers all of the routes loaded
	 * on the router into the WordPress REST API.
	 *
	 * @throws VendorNotSetException
	 * @throws VersionNotSetException
	 */
	public function register() {
		if ( ! $this->vendor ) {
			throw new VendorNotSetException;
		}

		if ( ! $this->version ) {
			throw new VersionNotSetException;
		}

		foreach ( $this->endpoints as $endpoint ) {
			register_rest_route(
				$this->get_namespace(),
				$endpoint->get_route(),
				$endpoint->get_options()
			);
		}
	}

	/**
	 * Registers a set of routes with a shared set of options.
	 *
	 * Allows you to group routes together with shared set of options, including
	 * a route prefix, shared guards, and common parameter validation or sanitization.
	 *
	 * @param array    $options
	 * @param callable $callback
	 */
	public function group( array $options, $callback ) {
		$router = new static;

		call_user_func( $callback, $router );

		foreach ( $router->get_endpoints() as $endpoint ) {
			$this->endpoints[] = $this->set_options( $endpoint, $options );
		}
	}

	/**
	 * Magic __call method.
	 *
	 * All of the endpoints registration method calls pass through here. This validates whether the method
	 * is a valid endpoint type to register, and creates a new endpoint with the passed options.
	 *
	 * @param string $name
	 * @param array  $arguments
	 *
	 * @return Endpoint
	 *
	 * @throws UnknownMethodException
	 * @throws MissingArgumentException
	 * @throws InvalidArgumentException
	 */
	public function __call( $name, $arguments ) {
		if ( ! in_array( $name, array_keys( $this->methods ) ) ) {
			throw new UnknownMethodException;
		}

		// array_merge ensures we have 3 elements
		list( $route, $callback, $options ) = array_merge( $arguments, array( null, null, null ) );

		if ( ! $route || ! $callback ) {
			throw new MissingArgumentException;
		}

		if ( ! is_callable( $callback ) ) {
			throw new InvalidArgumentException;
		}

		$endpoint = new Endpoint( $route, $this->methods[ $name ], $callback );

		if ( $options && is_array( $options ) ) {
			$endpoint = $this->set_options( $endpoint, $options );
		}

		return $this->endpoints[] = $endpoint;
	}

	/**
	 * Sets the passed options on the endpoint.
	 *
	 * Only sets endpoints matching setters in the Endpoint class.
	 *
	 * @param Endpoint $endpoint
	 * @param array    $options
	 *
	 * @return Endpoint
	 * @throws MalformedRouteException
	 */
	protected function set_options( Endpoint $endpoint, array $options ) {
		if ( isset( $options['guard'] ) ) {
			$endpoint->set_guard( $options['guard'] );
		}

		if ( isset( $options['filter'] ) ) {
			$endpoint->set_filter( $options['filter'] );
		}

		if ( isset( $options['prefix'] ) ) {
			$endpoint->set_prefix( $options['prefix'] );
		}

		return $endpoint;
	}

	/**
	 * Generates the resource's namespace.
	 *
	 * @return string
	 */
	protected function get_namespace() {
		return $this->vendor . '/v' . $this->version;
	}

	/**
	 * {@inheritDoc}
	 *
	 * @return array[]
	 */
	public function action_hooks() {
		return array(
			array(
				'method' => 'register',
				'hook'   => 'rest_api_init',
			),
		);
	}
}