intraxia / jaxion

src/Contract/Core/Container.php

Indentation +66 added lines, -66 removed lines

@@ -2,75 +2,75 @@
 namespace Intraxia\Jaxion\Contract\Core;
 
 interface Container extends \ArrayAccess, \Iterator {
-	/**
-	 * Define a new service or value on the Container.
-	 *
-	 * The alias is the name that the value will be referenced by. This can be used by both
-	 * the `get` method to retrieve the value or through ArrayAccess (`$container['alias']`).
-	 * It should be a short name used to reference the defined value. The definition can be
-	 * any scalar value to assign to the alias, or it can define a service object to return.
-	 * This can be accomplished by passing in a closure, which takes the container and returns
-	 * a fully constructed object. This closure will be executed every time the class is fetched.
-	 * If an already-instantiated object is passed in, it will be returned when fetched. A
-	 * Definition object will be returned for additional manipulation. Scalar values will be
-	 * locked automatically and can't be overridden.
-	 *
-	 * @param string|array $alias
-	 * @param mixed        $definition
-	 *
-	 * @return $this
-	 */
-	public function define( $alias, $definition );
+    /**
+     * Define a new service or value on the Container.
+     *
+     * The alias is the name that the value will be referenced by. This can be used by both
+     * the `get` method to retrieve the value or through ArrayAccess (`$container['alias']`).
+     * It should be a short name used to reference the defined value. The definition can be
+     * any scalar value to assign to the alias, or it can define a service object to return.
+     * This can be accomplished by passing in a closure, which takes the container and returns
+     * a fully constructed object. This closure will be executed every time the class is fetched.
+     * If an already-instantiated object is passed in, it will be returned when fetched. A
+     * Definition object will be returned for additional manipulation. Scalar values will be
+     * locked automatically and can't be overridden.
+     *
+     * @param string|array $alias
+     * @param mixed        $definition
+     *
+     * @return $this
+     */
+    public function define( $alias, $definition );
 
-	/**
-	 * Defines a new singleton on the Container.
-	 *
-	 * Functions identically to Container::define, except closures passed in are only executed
-	 * once, and the return value is reused across multiple fetches.
-	 *
-	 * @param string|array $alias
-	 * @param mixed        $definition
-	 *
-	 * @return $this
-	 */
-	public function share( $alias, $definition );
+    /**
+     * Defines a new singleton on the Container.
+     *
+     * Functions identically to Container::define, except closures passed in are only executed
+     * once, and the return value is reused across multiple fetches.
+     *
+     * @param string|array $alias
+     * @param mixed        $definition
+     *
+     * @return $this
+     */
+    public function share( $alias, $definition );
 
-	/**
-	 * Fetches the value for the provided alias.
-	 *
-	 * @param string $alias
-	 *
-	 * @return mixed
-	 */
-	public function fetch( $alias );
+    /**
+     * Fetches the value for the provided alias.
+     *
+     * @param string $alias
+     *
+     * @return mixed
+     */
+    public function fetch( $alias );
 
-	/**
-	 * Checks whether the provided alias exists on the container.
-	 *
-	 * @param string $alias
-	 *
-	 * @return bool
-	 */
-	public function has( $alias );
+    /**
+     * Checks whether the provided alias exists on the container.
+     *
+     * @param string $alias
+     *
+     * @return bool
+     */
+    public function has( $alias );
 
-	/**
-	 * Removes the provided alias from the container.
-	 *
-	 * @param string $alias
-	 *
-	 * @return bool
-	 */
-	public function remove( $alias );
+    /**
+     * Removes the provided alias from the container.
+     *
+     * @param string $alias
+     *
+     * @return bool
+     */
+    public function remove( $alias );
 
-	/**
-	 * Registers a service provider with the container.
-	 *
-	 * A service provider is responsible for defining and generating services that will be bound
-	 * into the container. This keeps the container and Application responsible solely for maintaining
-	 * the generated services and the API for registering them and allows for a clean interface for
-	 * adding new services to the container.
-	 *
-	 * @param ServiceProvider $provider
-	 */
-	public function register( ServiceProvider $provider );
+    /**
+     * Registers a service provider with the container.
+     *
+     * A service provider is responsible for defining and generating services that will be bound
+     * into the container. This keeps the container and Application responsible solely for maintaining
+     * the generated services and the API for registering them and allows for a clean interface for
+     * adding new services to the container.
+     *
+     * @param ServiceProvider $provider
+     */
+    public function register( ServiceProvider $provider );
 }

src/Contract/Http/Filter.php

Indentation +9 added lines, -9 removed lines

@@ -10,13 +10,13 @@
  * @subpackage Contract\Http
  */
 interface Filter {
-	/**
-	 * Generates argument rules.
-	 *
-	 * Returns an array matching the WP-API format for argument rules,
-	 * including sanitization, validation, required, or defaults.
-	 *
-	 * @return array
-	 */
-	public function rules();
+    /**
+     * Generates argument rules.
+     *
+     * Returns an array matching the WP-API format for argument rules,
+     * including sanitization, validation, required, or defaults.
+     *
+     * @return array
+     */
+    public function rules();
 }

src/Contract/Http/Guard.php

Indentation +9 added lines, -9 removed lines

@@ -10,13 +10,13 @@
  * @subpackage Contract\Http
  */
 interface Guard {
-	/**
-	 * Validates when the user is authorized for the route.
-	 *
-	 * Returns a boolean based on whether the current user is authorized
-	 * to interact with the given route.
-	 *
-	 * @return bool
-	 */
-	public function authorized();
+    /**
+     * Validates when the user is authorized for the route.
+     *
+     * Returns a boolean based on whether the current user is authorized
+     * to interact with the given route.
+     *
+     * @return bool
+     */
+    public function authorized();
 }

src/Http/Endpoint.php

Indentation +137 added lines, -137 removed lines

@@ -14,141 +14,141 @@
  * @subpackage Http
  */
 class Endpoint {
-	/**
-	 * Endpoint's route.
-	 *
-	 * @var string
-	 */
-	protected $route;
-
-	/**
-	 * Endpoint's HTTP verb(s).
-	 *
-	 * @var string
-	 */
-	protected $method;
-
-	/**
-	 * Endpoint's callback.
-	 *
-	 * @var callable
-	 */
-	protected $callback;
-
-	/**
-	 * Endpoint's permission guard.
-	 *
-	 * @var GuardContract
-	 */
-	protected $guard;
-
-	/**
-	 * Endpoint's arguments filter.
-	 *
-	 * @var FilterContract
-	 */
-	protected $filter;
-
-	/**
-	 * Endpoint's route prefix.
-	 *
-	 * @var string
-	 */
-	protected $prefix;
-
-	/**
-	 * Instantiate a new endpoint with a provided route, method, and callback.
-	 *
-	 * @param string   $route
-	 * @param string   $method
-	 * @param callable $callback
-	 *
-	 * @throws MalformedRouteException
-	 */
-	public function __construct( $route, $method, $callback ) {
-		if ( ! Str::starts_with( $route, '/' ) || Str::ends_with( $route, '/' ) ) {
-			throw new MalformedRouteException;
-		}
-
-		$this->route    = $route;
-		$this->method   = $method;
-		$this->callback = $callback;
-	}
-
-	/**
-	 * Generates the endpoint's route.
-	 *
-	 * Combines the prefix with the route to generate the full route string.
-	 *
-	 * @return string
-	 */
-	public function get_route() {
-		return ( $this->prefix ?: '' ) . $this->route;
-	}
-
-	/**
-	 * Generates the endpoint's WP-API options array.
-	 *
-	 * @return array
-	 */
-	public function get_options() {
-		$options = array(
-			'methods'  => $this->method,
-			'callback' => $this->callback,
-		);
-
-		if ( $this->guard ) {
-			$options['permission_callback'] = array( $this->guard, 'authorized' );
-		}
-
-		if ( $this->filter ) {
-			$options['args'] = $this->filter->rules();
-		}
-
-		return $options;
-	}
-
-	/**
-	 * Sets the endpoint's permission guard.
-	 *
-	 * @param GuardContract $guard
-	 *
-	 * @return $this
-	 */
-	public function set_guard( GuardContract $guard ) {
-		$this->guard = $guard;
-
-		return $this;
-	}
-
-	/**
-	 * Sets the endpoint's arguments filter.
-	 *
-	 * @param FilterContract $filter
-	 *
-	 * @return $this
-	 */
-	public function set_filter( FilterContract $filter ) {
-		$this->filter = $filter;
-
-		return $this;
-	}
-
-	/**
-	 * Sets the endpoint's prefix.
-	 *
-	 * @param string $prefix
-	 *
-	 * @return $this
-	 * @throws MalformedRouteException
-	 */
-	public function set_prefix( $prefix ) {
-		if ( ! Str::starts_with( $prefix, '/' ) || Str::ends_with( $prefix, '/' ) ) {
-			throw new MalformedRouteException;
-		}
-
-		$this->prefix = $prefix;
-
-		return $this;
-	}
+    /**
+     * Endpoint's route.
+     *
+     * @var string
+     */
+    protected $route;
+
+    /**
+     * Endpoint's HTTP verb(s).
+     *
+     * @var string
+     */
+    protected $method;
+
+    /**
+     * Endpoint's callback.
+     *
+     * @var callable
+     */
+    protected $callback;
+
+    /**
+     * Endpoint's permission guard.
+     *
+     * @var GuardContract
+     */
+    protected $guard;
+
+    /**
+     * Endpoint's arguments filter.
+     *
+     * @var FilterContract
+     */
+    protected $filter;
+
+    /**
+     * Endpoint's route prefix.
+     *
+     * @var string
+     */
+    protected $prefix;
+
+    /**
+     * Instantiate a new endpoint with a provided route, method, and callback.
+     *
+     * @param string   $route
+     * @param string   $method
+     * @param callable $callback
+     *
+     * @throws MalformedRouteException
+     */
+    public function __construct( $route, $method, $callback ) {
+        if ( ! Str::starts_with( $route, '/' ) || Str::ends_with( $route, '/' ) ) {
+            throw new MalformedRouteException;
+        }
+
+        $this->route    = $route;
+        $this->method   = $method;
+        $this->callback = $callback;
+    }
+
+    /**
+     * Generates the endpoint's route.
+     *
+     * Combines the prefix with the route to generate the full route string.
+     *
+     * @return string
+     */
+    public function get_route() {
+        return ( $this->prefix ?: '' ) . $this->route;
+    }
+
+    /**
+     * Generates the endpoint's WP-API options array.
+     *
+     * @return array
+     */
+    public function get_options() {
+        $options = array(
+            'methods'  => $this->method,
+            'callback' => $this->callback,
+        );
+
+        if ( $this->guard ) {
+            $options['permission_callback'] = array( $this->guard, 'authorized' );
+        }
+
+        if ( $this->filter ) {
+            $options['args'] = $this->filter->rules();
+        }
+
+        return $options;
+    }
+
+    /**
+     * Sets the endpoint's permission guard.
+     *
+     * @param GuardContract $guard
+     *
+     * @return $this
+     */
+    public function set_guard( GuardContract $guard ) {
+        $this->guard = $guard;
+
+        return $this;
+    }
+
+    /**
+     * Sets the endpoint's arguments filter.
+     *
+     * @param FilterContract $filter
+     *
+     * @return $this
+     */
+    public function set_filter( FilterContract $filter ) {
+        $this->filter = $filter;
+
+        return $this;
+    }
+
+    /**
+     * Sets the endpoint's prefix.
+     *
+     * @param string $prefix
+     *
+     * @return $this
+     * @throws MalformedRouteException
+     */
+    public function set_prefix( $prefix ) {
+        if ( ! Str::starts_with( $prefix, '/' ) || Str::ends_with( $prefix, '/' ) ) {
+            throw new MalformedRouteException;
+        }
+
+        $this->prefix = $prefix;
+
+        return $this;
+    }
 }

src/Http/Filter.php

Indentation +130 added lines, -130 removed lines

@@ -12,134 +12,134 @@
  * @subpackage Http
  */
 class Filter implements FilterContract {
-	/**
-	 * Filter rules.
-	 *
-	 * @var array
-	 */
-	protected $rules;
-
-	/**
-	 * Instantiates a new filter with the provided rules array.
-	 *
-	 * @param array $rules
-	 */
-	public function __construct( $rules = array() ) {
-		$this->rules = $rules;
-	}
-
-	/**
-	 * Generates argument rules.
-	 *
-	 * Returns an array matching the WP-API format for argument rules,
-	 * including sanitization, validation, required, or defaults.
-	 *
-	 * @return array
-	 */
-	public function rules() {
-		$args = array();
-
-		foreach ( $this->rules as $arg => $validation ) {
-			if ( ! $validation || ! is_string( $validation ) ) {
-				continue;
-			}
-
-			$args[ $arg ] = $this->parse_validation( $validation );
-		}
-
-		return $args;
-	}
-
-	/**
-	 * Parses a validation string into a WP-API compatible rule.
-	 *
-	 * @param string $validation
-	 *
-	 * @return array
-	 *
-	 * @todo The next rule added needs to refactor this process.
-	 */
-	protected function parse_validation( $validation ) {
-		$validation = explode( '|', $validation );
-
-		$rules = array();
-
-		foreach ( $validation as $rule ) {
-			if ( 0 === strpos( $rule, 'default' ) ) {
-				$rule_arr = explode( ':', $rule );
-
-				$rules['default'] = count( $rule_arr ) === 2 ? array_pop( $rule_arr ) : '';
-			}
-
-			if ( 0 === strpos( $rule, 'oneof' ) ) {
-				list( $rule, $values ) = explode( ':', $rule );
-
-				$values   = explode( ',', $values );
-				$callback = function ( $value ) use ( $values ) {
-					if ( in_array( $value, $values, true ) ) {
-						return true;
-					}
-
-					return false;
-				};
-
-				$rules['validate_callback'] = isset( $rules['validate_callback'] ) ? $this->add_callback( $rules['validate_callback'], $callback ) : $callback;
-			}
-
-			switch ( $rule ) {
-				case 'required':
-					$rules['required'] = true;
-					break;
-				case 'integer':
-					$callback                   = array( $this, 'validate_integer' );
-					$rules['validate_callback'] = isset( $rules['validate_callback'] ) ? $this->add_callback( $rules['validate_callback'], $callback ) : $callback;
-
-					$callback                   = array( $this, 'make_integer' );
-					$rules['sanitize_callback'] = isset( $rules['sanitize_callback'] ) ? $this->add_callback( $rules['sanitize_callback'], $callback ) : $callback;
-					break;
-			}
-		}
-
-		return $rules;
-	}
-
-	/**
-	 * Validate that provided value is an integer.
-	 *
-	 * @param mixed $value
-	 *
-	 * @return bool
-	 */
-	public function validate_integer( $value ) {
-		return filter_var( $value, FILTER_VALIDATE_INT ) !== false;
-	}
-
-	/**
-	 * Casts a provided value to an integer.
-	 *
-	 * @param mixed $value
-	 *
-	 * @return int
-	 */
-	public function make_integer( $value ) {
-		return (int) $value;
-	}
-
-	/**
-	 * Creates a new callback that connects the previous and next callback.
-	 *
-	 * @param callable $previous
-	 * @param callable $next
-	 *
-	 * @return \Closure;
-	 */
-	private function add_callback( $previous, $next ) {
-		return function ( $value ) use ( $previous, $next ) {
-			if ( call_user_func( $previous, $value ) ) {
-				return call_user_func( $next, $value );
-			}
-
-			return false;
-		};
-	}
+    /**
+     * Filter rules.
+     *
+     * @var array
+     */
+    protected $rules;
+
+    /**
+     * Instantiates a new filter with the provided rules array.
+     *
+     * @param array $rules
+     */
+    public function __construct( $rules = array() ) {
+        $this->rules = $rules;
+    }
+
+    /**
+     * Generates argument rules.
+     *
+     * Returns an array matching the WP-API format for argument rules,
+     * including sanitization, validation, required, or defaults.
+     *
+     * @return array
+     */
+    public function rules() {
+        $args = array();
+
+        foreach ( $this->rules as $arg => $validation ) {
+            if ( ! $validation || ! is_string( $validation ) ) {
+                continue;
+            }
+
+            $args[ $arg ] = $this->parse_validation( $validation );
+        }
+
+        return $args;
+    }
+
+    /**
+     * Parses a validation string into a WP-API compatible rule.
+     *
+     * @param string $validation
+     *
+     * @return array
+     *
+     * @todo The next rule added needs to refactor this process.
+     */
+    protected function parse_validation( $validation ) {
+        $validation = explode( '|', $validation );
+
+        $rules = array();
+
+        foreach ( $validation as $rule ) {
+            if ( 0 === strpos( $rule, 'default' ) ) {
+                $rule_arr = explode( ':', $rule );
+
+                $rules['default'] = count( $rule_arr ) === 2 ? array_pop( $rule_arr ) : '';
+            }
+
+            if ( 0 === strpos( $rule, 'oneof' ) ) {
+                list( $rule, $values ) = explode( ':', $rule );
+
+                $values   = explode( ',', $values );
+                $callback = function ( $value ) use ( $values ) {
+                    if ( in_array( $value, $values, true ) ) {
+                        return true;
+                    }
+
+                    return false;
+                };
+
+                $rules['validate_callback'] = isset( $rules['validate_callback'] ) ? $this->add_callback( $rules['validate_callback'], $callback ) : $callback;
+            }
+
+            switch ( $rule ) {
+                case 'required':
+                    $rules['required'] = true;
+                    break;
+                case 'integer':
+                    $callback                   = array( $this, 'validate_integer' );
+                    $rules['validate_callback'] = isset( $rules['validate_callback'] ) ? $this->add_callback( $rules['validate_callback'], $callback ) : $callback;
+
+                    $callback                   = array( $this, 'make_integer' );
+                    $rules['sanitize_callback'] = isset( $rules['sanitize_callback'] ) ? $this->add_callback( $rules['sanitize_callback'], $callback ) : $callback;
+                    break;
+            }
+        }
+
+        return $rules;
+    }
+
+    /**
+     * Validate that provided value is an integer.
+     *
+     * @param mixed $value
+     *
+     * @return bool
+     */
+    public function validate_integer( $value ) {
+        return filter_var( $value, FILTER_VALIDATE_INT ) !== false;
+    }
+
+    /**
+     * Casts a provided value to an integer.
+     *
+     * @param mixed $value
+     *
+     * @return int
+     */
+    public function make_integer( $value ) {
+        return (int) $value;
+    }
+
+    /**
+     * Creates a new callback that connects the previous and next callback.
+     *
+     * @param callable $previous
+     * @param callable $next
+     *
+     * @return \Closure;
+     */
+    private function add_callback( $previous, $next ) {
+        return function ( $value ) use ( $previous, $next ) {
+            if ( call_user_func( $previous, $value ) ) {
+                return call_user_func( $next, $value );
+            }
+
+            return false;
+        };
+    }
 }

src/Http/Router.php

Indentation +206 added lines, -206 removed lines

@@ -21,210 +21,210 @@
  * @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',
-			),
-		);
-	}
+    /**
+     * 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',
+            ),
+        );
+    }
 }

src/Http/Guard.php

Indentation +73 added lines, -73 removed lines

@@ -15,86 +15,86 @@
  * @subpackage Http
  */
 class Guard implements GuardContract {
-	/**
-	 * Default options.
-	 *
-	 * @var array
-	 */
-	protected $defaults = array(
-		'rule'     => 'public',
-		'callback' => false,
-	);
+    /**
+     * Default options.
+     *
+     * @var array
+     */
+    protected $defaults = array(
+        'rule'     => 'public',
+        'callback' => false,
+    );
 
-	/**
-	 * Guard options.
-	 *
-	 * @var array
-	 */
-	protected $options;
+    /**
+     * Guard options.
+     *
+     * @var array
+     */
+    protected $options;
 
-	/**
-	 * Instantiate a new Guard with provided options.
-	 *
-	 * @param array $options
-	 */
-	public function __construct( array $options = array() ) {
-		$this->options = $this->set_defaults( $options );
-	}
+    /**
+     * Instantiate a new Guard with provided options.
+     *
+     * @param array $options
+     */
+    public function __construct( array $options = array() ) {
+        $this->options = $this->set_defaults( $options );
+    }
 
-	/**
-	 * Validates whether the current user is authorized.
-	 *
-	 * @return true|WP_Error
-	 */
-	public function authorized() {
-		// if the rule is public, always authorized
-		if ( 'public' === $this->options['rule'] ) {
-			return true;
-		}
+    /**
+     * Validates whether the current user is authorized.
+     *
+     * @return true|WP_Error
+     */
+    public function authorized() {
+        // if the rule is public, always authorized
+        if ( 'public' === $this->options['rule'] ) {
+            return true;
+        }
 
-		// enable passing in callback
-		if ( 'callback' === $this->options['rule'] && is_callable( $this->options['callback'] ) ) {
-			return call_user_func( $this->options['callback'] );
-		}
+        // enable passing in callback
+        if ( 'callback' === $this->options['rule'] && is_callable( $this->options['callback'] ) ) {
+            return call_user_func( $this->options['callback'] );
+        }
 
-		// map rule to method
-		if ( method_exists( $this, $method = $this->options['rule'] ) ) {
-			return $this->{$method}();
-		}
+        // map rule to method
+        if ( method_exists( $this, $method = $this->options['rule'] ) ) {
+            return $this->{$method}();
+        }
 
-		// disable in rule is misconfigused
-		// @todo set up internal translations
-		// @todo also, this error message kinda sucks
-		return new WP_Error( '500', __( 'Guard failure', 'jaxion' ) );
-	}
+        // disable in rule is misconfigused
+        // @todo set up internal translations
+        // @todo also, this error message kinda sucks
+        return new WP_Error( '500', __( 'Guard failure', 'jaxion' ) );
+    }
 
-	/**
-	 * Checks whether the current user can edit other's posts.
-	 *
-	 * @return bool|WP_Error
-	 */
-	protected function can_edit_others_posts() {
-		return current_user_can( 'edit_others_posts' ) ?: new WP_Error( 'unauthorized', __( 'Unauthorized user', 'jaxion' ), array( 'status' => 401 ) );
-	}
+    /**
+     * Checks whether the current user can edit other's posts.
+     *
+     * @return bool|WP_Error
+     */
+    protected function can_edit_others_posts() {
+        return current_user_can( 'edit_others_posts' ) ?: new WP_Error( 'unauthorized', __( 'Unauthorized user', 'jaxion' ), array( 'status' => 401 ) );
+    }
 
-	/**
-	 * Checks whether the user is currently logged in.
-	 *
-	 * @return bool|WP_Error
-	 */
-	protected function user_logged_in() {
-		return is_user_logged_in() ?: new WP_Error( 'unauthorized', __( 'Unauthorized user', 'jaxion' ), array( 'status' => 401 ) );
-	}
+    /**
+     * Checks whether the user is currently logged in.
+     *
+     * @return bool|WP_Error
+     */
+    protected function user_logged_in() {
+        return is_user_logged_in() ?: new WP_Error( 'unauthorized', __( 'Unauthorized user', 'jaxion' ), array( 'status' => 401 ) );
+    }
 
-	/**
-	 * Sets the default params for the Guard options.
-	 *
-	 * @param array $options
-	 *
-	 * @return array
-	 */
-	protected function set_defaults( $options ) {
-		// these are the valid options
-		return wp_parse_args( $options, $this->defaults );
-	}
+    /**
+     * Sets the default params for the Guard options.
+     *
+     * @param array $options
+     *
+     * @return array
+     */
+    protected function set_defaults( $options ) {
+        // these are the valid options
+        return wp_parse_args( $options, $this->defaults );
+    }
 }

src/Http/ServiceProvider.php

Indentation +29 added lines, -29 removed lines

@@ -11,37 +11,37 @@
  * @subpackage Http
  */
 class ServiceProvider implements ServiceProviderContract {
-	/**
-	 * Container to register on.
-	 *
-	 * @var Container
-	 */
-	protected $container;
+    /**
+     * Container to register on.
+     *
+     * @var Container
+     */
+    protected $container;
 
-	/**
-	 * {@inheritDoc}
-	 *
-	 * @param Container $container
-	 */
-	public function register( Container $container ) {
-		$this->container = $container;
+    /**
+     * {@inheritDoc}
+     *
+     * @param Container $container
+     */
+    public function register( Container $container ) {
+        $this->container = $container;
 
-		$this->container->define( array( 'router' => 'Intraxia\Jaxion\Http\Router' ), $router = new Router );
+        $this->container->define( array( 'router' => 'Intraxia\Jaxion\Http\Router' ), $router = new Router );
 
-		$this->add_routes( $router );
-	}
+        $this->add_routes( $router );
+    }
 
-	/**
-	 * Registers the routes on the generated Router.
-	 *
-	 * This is a no-op by default by can be overwritten by the implementing developer
-	 * to provide a single, clean location to register their routes.
-	 *
-	 * @param Router $router
-	 *
-	 * @codeCoverageIgnore
-	 */
-	protected function add_routes( Router $router ) {
-		// no-op
-	}
+    /**
+     * Registers the routes on the generated Router.
+     *
+     * This is a no-op by default by can be overwritten by the implementing developer
+     * to provide a single, clean location to register their routes.
+     *
+     * @param Router $router
+     *
+     * @codeCoverageIgnore
+     */
+    protected function add_routes( Router $router ) {
+        // no-op
+    }
 }

src/Contract/Core/HasActions.php

Indentation +9 added lines, -9 removed lines

@@ -2,13 +2,13 @@
 namespace Intraxia\Jaxion\Contract\Core;
 
 interface HasActions {
-	/**
-	 * Provides the array of actions the class wants to register with WordPress.
-	 *
-	 * These actions are retrieved by the Loader class and used to register the
-	 * correct service methods with WordPress.
-	 *
-	 * @return array[]
-	 */
-	public function action_hooks();
+    /**
+     * Provides the array of actions the class wants to register with WordPress.
+     *
+     * These actions are retrieved by the Loader class and used to register the
+     * correct service methods with WordPress.
+     *
+     * @return array[]
+     */
+    public function action_hooks();
 }