@@ -5,26 +5,26 @@ |
||
| 5 | 5 | use Intraxia\Jaxion\Contract\Core\ServiceProvider; |
| 6 | 6 | |
| 7 | 7 | class RouterServiceProvider implements ServiceProvider { |
| 8 | - /** |
|
| 9 | - * {@inheritDoc} |
|
| 10 | - */ |
|
| 11 | - public function register( Container $container ) { |
|
| 12 | - $container->define( array( 'router' => 'Intraxia\Jaxion\Http\Router' ), $router = new Router ); |
|
| 8 | + /** |
|
| 9 | + * {@inheritDoc} |
|
| 10 | + */ |
|
| 11 | + public function register( Container $container ) { |
|
| 12 | + $container->define( array( 'router' => 'Intraxia\Jaxion\Http\Router' ), $router = new Router ); |
|
| 13 | 13 | |
| 14 | - $this->add_routes( $router ); |
|
| 15 | - } |
|
| 14 | + $this->add_routes( $router ); |
|
| 15 | + } |
|
| 16 | 16 | |
| 17 | - /** |
|
| 18 | - * Registers the routes on the generated Router. |
|
| 19 | - * |
|
| 20 | - * This is a no-op by default by can be overwritten by the implementing developer |
|
| 21 | - * to provide a single, clean location to register their routes. |
|
| 22 | - * |
|
| 23 | - * @param Router $router |
|
| 24 | - * |
|
| 25 | - * @codeCoverageIgnore |
|
| 26 | - */ |
|
| 27 | - protected function add_routes( Router $router ) { |
|
| 28 | - // no-op |
|
| 29 | - } |
|
| 17 | + /** |
|
| 18 | + * Registers the routes on the generated Router. |
|
| 19 | + * |
|
| 20 | + * This is a no-op by default by can be overwritten by the implementing developer |
|
| 21 | + * to provide a single, clean location to register their routes. |
|
| 22 | + * |
|
| 23 | + * @param Router $router |
|
| 24 | + * |
|
| 25 | + * @codeCoverageIgnore |
|
| 26 | + */ |
|
| 27 | + protected function add_routes( Router $router ) { |
|
| 28 | + // no-op |
|
| 29 | + } |
|
| 30 | 30 | } |
| 31 | 31 | \ No newline at end of file |
@@ -8,10 +8,10 @@ discard block |
||
| 8 | 8 | /** |
| 9 | 9 | * {@inheritDoc} |
| 10 | 10 | */ |
| 11 | - public function register( Container $container ) { |
|
| 12 | - $container->define( array( 'router' => 'Intraxia\Jaxion\Http\Router' ), $router = new Router ); |
|
| 11 | + public function register(Container $container) { |
|
| 12 | + $container->define(array('router' => 'Intraxia\Jaxion\Http\Router'), $router = new Router); |
|
| 13 | 13 | |
| 14 | - $this->add_routes( $router ); |
|
| 14 | + $this->add_routes($router); |
|
| 15 | 15 | } |
| 16 | 16 | |
| 17 | 17 | /** |
@@ -24,7 +24,7 @@ discard block |
||
| 24 | 24 | * |
| 25 | 25 | * @codeCoverageIgnore |
| 26 | 26 | */ |
| 27 | - protected function add_routes( Router $router ) { |
|
| 27 | + protected function add_routes(Router $router) { |
|
| 28 | 28 | // no-op |
| 29 | 29 | } |
| 30 | 30 | } |
| 31 | 31 | \ No newline at end of file |
@@ -14,141 +14,141 @@ |
||
| 14 | 14 | * @subpackage Http |
| 15 | 15 | */ |
| 16 | 16 | class Endpoint { |
| 17 | - /** |
|
| 18 | - * Endpoint's route. |
|
| 19 | - * |
|
| 20 | - * @var string |
|
| 21 | - */ |
|
| 22 | - protected $route; |
|
| 23 | - |
|
| 24 | - /** |
|
| 25 | - * Endpoint's HTTP verb(s). |
|
| 26 | - * |
|
| 27 | - * @var string |
|
| 28 | - */ |
|
| 29 | - protected $method; |
|
| 30 | - |
|
| 31 | - /** |
|
| 32 | - * Endpoint's callback. |
|
| 33 | - * |
|
| 34 | - * @var callable |
|
| 35 | - */ |
|
| 36 | - protected $callback; |
|
| 37 | - |
|
| 38 | - /** |
|
| 39 | - * Endpoint's permission guard. |
|
| 40 | - * |
|
| 41 | - * @var GuardContract |
|
| 42 | - */ |
|
| 43 | - protected $guard; |
|
| 44 | - |
|
| 45 | - /** |
|
| 46 | - * Endpoint's arguments filter. |
|
| 47 | - * |
|
| 48 | - * @var FilterContract |
|
| 49 | - */ |
|
| 50 | - protected $filter; |
|
| 51 | - |
|
| 52 | - /** |
|
| 53 | - * Endpoint's route prefix. |
|
| 54 | - * |
|
| 55 | - * @var string |
|
| 56 | - */ |
|
| 57 | - protected $prefix; |
|
| 58 | - |
|
| 59 | - /** |
|
| 60 | - * Instantiate a new endpoint with a provided route, method, and callback. |
|
| 61 | - * |
|
| 62 | - * @param string $route |
|
| 63 | - * @param string $method |
|
| 64 | - * @param callable $callback |
|
| 65 | - * |
|
| 66 | - * @throws MalformedRouteException |
|
| 67 | - */ |
|
| 68 | - public function __construct( $route, $method, $callback ) { |
|
| 69 | - if ( ! Str::starts_with( $route, '/' ) || Str::ends_with( $route, '/' ) ) { |
|
| 70 | - throw new MalformedRouteException; |
|
| 71 | - } |
|
| 72 | - |
|
| 73 | - $this->route = $route; |
|
| 74 | - $this->method = $method; |
|
| 75 | - $this->callback = $callback; |
|
| 76 | - } |
|
| 77 | - |
|
| 78 | - /** |
|
| 79 | - * Generates the endpoint's route. |
|
| 80 | - * |
|
| 81 | - * Combines the prefix with the route to generate the full route string. |
|
| 82 | - * |
|
| 83 | - * @return string |
|
| 84 | - */ |
|
| 85 | - public function get_route() { |
|
| 86 | - return ( $this->prefix ?: '' ) . $this->route; |
|
| 87 | - } |
|
| 88 | - |
|
| 89 | - /** |
|
| 90 | - * Generates the endpoint's WP-API options array. |
|
| 91 | - * |
|
| 92 | - * @return array |
|
| 93 | - */ |
|
| 94 | - public function get_options() { |
|
| 95 | - $options = array( |
|
| 96 | - 'methods' => $this->method, |
|
| 97 | - 'callback' => $this->callback, |
|
| 98 | - ); |
|
| 99 | - |
|
| 100 | - if ( $this->guard ) { |
|
| 101 | - $options['permission_callback'] = array( $this->guard, 'authorized' ); |
|
| 102 | - } |
|
| 103 | - |
|
| 104 | - if ( $this->filter ) { |
|
| 105 | - $options['args'] = $this->filter->rules(); |
|
| 106 | - } |
|
| 107 | - |
|
| 108 | - return $options; |
|
| 109 | - } |
|
| 110 | - |
|
| 111 | - /** |
|
| 112 | - * Sets the endpoint's permission guard. |
|
| 113 | - * |
|
| 114 | - * @param GuardContract $guard |
|
| 115 | - * |
|
| 116 | - * @return $this |
|
| 117 | - */ |
|
| 118 | - public function set_guard( GuardContract $guard ) { |
|
| 119 | - $this->guard = $guard; |
|
| 120 | - |
|
| 121 | - return $this; |
|
| 122 | - } |
|
| 123 | - |
|
| 124 | - /** |
|
| 125 | - * Sets the endpoint's arguments filter. |
|
| 126 | - * |
|
| 127 | - * @param FilterContract $filter |
|
| 128 | - * |
|
| 129 | - * @return $this |
|
| 130 | - */ |
|
| 131 | - public function set_filter( FilterContract $filter ) { |
|
| 132 | - $this->filter = $filter; |
|
| 133 | - |
|
| 134 | - return $this; |
|
| 135 | - } |
|
| 136 | - |
|
| 137 | - /** |
|
| 138 | - * Sets the endpoint's prefix. |
|
| 139 | - * |
|
| 140 | - * @param string $prefix |
|
| 141 | - * |
|
| 142 | - * @return $this |
|
| 143 | - * @throws MalformedRouteException |
|
| 144 | - */ |
|
| 145 | - public function set_prefix( $prefix ) { |
|
| 146 | - if ( ! Str::starts_with( $prefix, '/' ) || Str::ends_with( $prefix, '/' ) ) { |
|
| 147 | - throw new MalformedRouteException; |
|
| 148 | - } |
|
| 149 | - |
|
| 150 | - $this->prefix = $prefix; |
|
| 151 | - |
|
| 152 | - return $this; |
|
| 153 | - } |
|
| 17 | + /** |
|
| 18 | + * Endpoint's route. |
|
| 19 | + * |
|
| 20 | + * @var string |
|
| 21 | + */ |
|
| 22 | + protected $route; |
|
| 23 | + |
|
| 24 | + /** |
|
| 25 | + * Endpoint's HTTP verb(s). |
|
| 26 | + * |
|
| 27 | + * @var string |
|
| 28 | + */ |
|
| 29 | + protected $method; |
|
| 30 | + |
|
| 31 | + /** |
|
| 32 | + * Endpoint's callback. |
|
| 33 | + * |
|
| 34 | + * @var callable |
|
| 35 | + */ |
|
| 36 | + protected $callback; |
|
| 37 | + |
|
| 38 | + /** |
|
| 39 | + * Endpoint's permission guard. |
|
| 40 | + * |
|
| 41 | + * @var GuardContract |
|
| 42 | + */ |
|
| 43 | + protected $guard; |
|
| 44 | + |
|
| 45 | + /** |
|
| 46 | + * Endpoint's arguments filter. |
|
| 47 | + * |
|
| 48 | + * @var FilterContract |
|
| 49 | + */ |
|
| 50 | + protected $filter; |
|
| 51 | + |
|
| 52 | + /** |
|
| 53 | + * Endpoint's route prefix. |
|
| 54 | + * |
|
| 55 | + * @var string |
|
| 56 | + */ |
|
| 57 | + protected $prefix; |
|
| 58 | + |
|
| 59 | + /** |
|
| 60 | + * Instantiate a new endpoint with a provided route, method, and callback. |
|
| 61 | + * |
|
| 62 | + * @param string $route |
|
| 63 | + * @param string $method |
|
| 64 | + * @param callable $callback |
|
| 65 | + * |
|
| 66 | + * @throws MalformedRouteException |
|
| 67 | + */ |
|
| 68 | + public function __construct( $route, $method, $callback ) { |
|
| 69 | + if ( ! Str::starts_with( $route, '/' ) || Str::ends_with( $route, '/' ) ) { |
|
| 70 | + throw new MalformedRouteException; |
|
| 71 | + } |
|
| 72 | + |
|
| 73 | + $this->route = $route; |
|
| 74 | + $this->method = $method; |
|
| 75 | + $this->callback = $callback; |
|
| 76 | + } |
|
| 77 | + |
|
| 78 | + /** |
|
| 79 | + * Generates the endpoint's route. |
|
| 80 | + * |
|
| 81 | + * Combines the prefix with the route to generate the full route string. |
|
| 82 | + * |
|
| 83 | + * @return string |
|
| 84 | + */ |
|
| 85 | + public function get_route() { |
|
| 86 | + return ( $this->prefix ?: '' ) . $this->route; |
|
| 87 | + } |
|
| 88 | + |
|
| 89 | + /** |
|
| 90 | + * Generates the endpoint's WP-API options array. |
|
| 91 | + * |
|
| 92 | + * @return array |
|
| 93 | + */ |
|
| 94 | + public function get_options() { |
|
| 95 | + $options = array( |
|
| 96 | + 'methods' => $this->method, |
|
| 97 | + 'callback' => $this->callback, |
|
| 98 | + ); |
|
| 99 | + |
|
| 100 | + if ( $this->guard ) { |
|
| 101 | + $options['permission_callback'] = array( $this->guard, 'authorized' ); |
|
| 102 | + } |
|
| 103 | + |
|
| 104 | + if ( $this->filter ) { |
|
| 105 | + $options['args'] = $this->filter->rules(); |
|
| 106 | + } |
|
| 107 | + |
|
| 108 | + return $options; |
|
| 109 | + } |
|
| 110 | + |
|
| 111 | + /** |
|
| 112 | + * Sets the endpoint's permission guard. |
|
| 113 | + * |
|
| 114 | + * @param GuardContract $guard |
|
| 115 | + * |
|
| 116 | + * @return $this |
|
| 117 | + */ |
|
| 118 | + public function set_guard( GuardContract $guard ) { |
|
| 119 | + $this->guard = $guard; |
|
| 120 | + |
|
| 121 | + return $this; |
|
| 122 | + } |
|
| 123 | + |
|
| 124 | + /** |
|
| 125 | + * Sets the endpoint's arguments filter. |
|
| 126 | + * |
|
| 127 | + * @param FilterContract $filter |
|
| 128 | + * |
|
| 129 | + * @return $this |
|
| 130 | + */ |
|
| 131 | + public function set_filter( FilterContract $filter ) { |
|
| 132 | + $this->filter = $filter; |
|
| 133 | + |
|
| 134 | + return $this; |
|
| 135 | + } |
|
| 136 | + |
|
| 137 | + /** |
|
| 138 | + * Sets the endpoint's prefix. |
|
| 139 | + * |
|
| 140 | + * @param string $prefix |
|
| 141 | + * |
|
| 142 | + * @return $this |
|
| 143 | + * @throws MalformedRouteException |
|
| 144 | + */ |
|
| 145 | + public function set_prefix( $prefix ) { |
|
| 146 | + if ( ! Str::starts_with( $prefix, '/' ) || Str::ends_with( $prefix, '/' ) ) { |
|
| 147 | + throw new MalformedRouteException; |
|
| 148 | + } |
|
| 149 | + |
|
| 150 | + $this->prefix = $prefix; |
|
| 151 | + |
|
| 152 | + return $this; |
|
| 153 | + } |
|
| 154 | 154 | } |
@@ -65,8 +65,8 @@ discard block |
||
| 65 | 65 | * |
| 66 | 66 | * @throws MalformedRouteException |
| 67 | 67 | */ |
| 68 | - public function __construct( $route, $method, $callback ) { |
|
| 69 | - if ( ! Str::starts_with( $route, '/' ) || Str::ends_with( $route, '/' ) ) { |
|
| 68 | + public function __construct($route, $method, $callback) { |
|
| 69 | + if (!Str::starts_with($route, '/') || Str::ends_with($route, '/')) { |
|
| 70 | 70 | throw new MalformedRouteException; |
| 71 | 71 | } |
| 72 | 72 | |
@@ -83,7 +83,7 @@ discard block |
||
| 83 | 83 | * @return string |
| 84 | 84 | */ |
| 85 | 85 | public function get_route() { |
| 86 | - return ( $this->prefix ?: '' ) . $this->route; |
|
| 86 | + return ($this->prefix ?: '') . $this->route; |
|
| 87 | 87 | } |
| 88 | 88 | |
| 89 | 89 | /** |
@@ -97,11 +97,11 @@ discard block |
||
| 97 | 97 | 'callback' => $this->callback, |
| 98 | 98 | ); |
| 99 | 99 | |
| 100 | - if ( $this->guard ) { |
|
| 101 | - $options['permission_callback'] = array( $this->guard, 'authorized' ); |
|
| 100 | + if ($this->guard) { |
|
| 101 | + $options['permission_callback'] = array($this->guard, 'authorized'); |
|
| 102 | 102 | } |
| 103 | 103 | |
| 104 | - if ( $this->filter ) { |
|
| 104 | + if ($this->filter) { |
|
| 105 | 105 | $options['args'] = $this->filter->rules(); |
| 106 | 106 | } |
| 107 | 107 | |
@@ -115,7 +115,7 @@ discard block |
||
| 115 | 115 | * |
| 116 | 116 | * @return $this |
| 117 | 117 | */ |
| 118 | - public function set_guard( GuardContract $guard ) { |
|
| 118 | + public function set_guard(GuardContract $guard) { |
|
| 119 | 119 | $this->guard = $guard; |
| 120 | 120 | |
| 121 | 121 | return $this; |
@@ -128,7 +128,7 @@ discard block |
||
| 128 | 128 | * |
| 129 | 129 | * @return $this |
| 130 | 130 | */ |
| 131 | - public function set_filter( FilterContract $filter ) { |
|
| 131 | + public function set_filter(FilterContract $filter) { |
|
| 132 | 132 | $this->filter = $filter; |
| 133 | 133 | |
| 134 | 134 | return $this; |
@@ -142,8 +142,8 @@ discard block |
||
| 142 | 142 | * @return $this |
| 143 | 143 | * @throws MalformedRouteException |
| 144 | 144 | */ |
| 145 | - public function set_prefix( $prefix ) { |
|
| 146 | - if ( ! Str::starts_with( $prefix, '/' ) || Str::ends_with( $prefix, '/' ) ) { |
|
| 145 | + public function set_prefix($prefix) { |
|
| 146 | + if (!Str::starts_with($prefix, '/') || Str::ends_with($prefix, '/')) { |
|
| 147 | 147 | throw new MalformedRouteException; |
| 148 | 148 | } |
| 149 | 149 | |