@@ -51,7 +51,7 @@ |
||
| 51 | 51 | * @param string $uri URI to render. |
| 52 | 52 | * @param array $context Context in which to render. |
| 53 | 53 | * |
| 54 | - * @return callable Rendering callback. |
|
| 54 | + * @return \Closure Rendering callback. |
|
| 55 | 55 | * @throws FailedToLoadView If the View URI is not accessible or readable. |
| 56 | 56 | * @throws FailedToLoadView If the View URI could not be loaded. |
| 57 | 57 | */ |
@@ -26,75 +26,75 @@ |
||
| 26 | 26 | class PHPEngine extends AbstractEngine |
| 27 | 27 | { |
| 28 | 28 | |
| 29 | - const PHP_EXTENSION = '.php'; |
|
| 29 | + const PHP_EXTENSION = '.php'; |
|
| 30 | 30 | |
| 31 | - /** |
|
| 32 | - * Check whether the Findable can handle an individual criterion. |
|
| 33 | - * |
|
| 34 | - * @since 0.1.0 |
|
| 35 | - * |
|
| 36 | - * @param mixed $criterion Criterion to check. |
|
| 37 | - * |
|
| 38 | - * @return bool Whether the Findable can handle the criterion. |
|
| 39 | - */ |
|
| 40 | - public function canHandle($criterion): bool |
|
| 41 | - { |
|
| 42 | - return URIHelper::hasExtension($criterion, static::PHP_EXTENSION) |
|
| 43 | - && is_readable($criterion); |
|
| 44 | - } |
|
| 31 | + /** |
|
| 32 | + * Check whether the Findable can handle an individual criterion. |
|
| 33 | + * |
|
| 34 | + * @since 0.1.0 |
|
| 35 | + * |
|
| 36 | + * @param mixed $criterion Criterion to check. |
|
| 37 | + * |
|
| 38 | + * @return bool Whether the Findable can handle the criterion. |
|
| 39 | + */ |
|
| 40 | + public function canHandle($criterion): bool |
|
| 41 | + { |
|
| 42 | + return URIHelper::hasExtension($criterion, static::PHP_EXTENSION) |
|
| 43 | + && is_readable($criterion); |
|
| 44 | + } |
|
| 45 | 45 | |
| 46 | - /** |
|
| 47 | - * Get the rendering callback for a given URI. |
|
| 48 | - * |
|
| 49 | - * @since 0.1.0 |
|
| 50 | - * |
|
| 51 | - * @param string $uri URI to render. |
|
| 52 | - * @param array $context Context in which to render. |
|
| 53 | - * |
|
| 54 | - * @return callable Rendering callback. |
|
| 55 | - * @throws FailedToLoadView If the View URI is not accessible or readable. |
|
| 56 | - * @throws FailedToLoadView If the View URI could not be loaded. |
|
| 57 | - */ |
|
| 58 | - public function getRenderCallback(string $uri, array $context = []): callable |
|
| 59 | - { |
|
| 60 | - if (! is_readable($uri)) { |
|
| 61 | - throw new FailedToLoadView( |
|
| 62 | - sprintf( |
|
| 63 | - _('The View URI "%1$s" is not accessible or readable.'), |
|
| 64 | - $uri |
|
| 65 | - ) |
|
| 66 | - ); |
|
| 67 | - } |
|
| 46 | + /** |
|
| 47 | + * Get the rendering callback for a given URI. |
|
| 48 | + * |
|
| 49 | + * @since 0.1.0 |
|
| 50 | + * |
|
| 51 | + * @param string $uri URI to render. |
|
| 52 | + * @param array $context Context in which to render. |
|
| 53 | + * |
|
| 54 | + * @return callable Rendering callback. |
|
| 55 | + * @throws FailedToLoadView If the View URI is not accessible or readable. |
|
| 56 | + * @throws FailedToLoadView If the View URI could not be loaded. |
|
| 57 | + */ |
|
| 58 | + public function getRenderCallback(string $uri, array $context = []): callable |
|
| 59 | + { |
|
| 60 | + if (! is_readable($uri)) { |
|
| 61 | + throw new FailedToLoadView( |
|
| 62 | + sprintf( |
|
| 63 | + _('The View URI "%1$s" is not accessible or readable.'), |
|
| 64 | + $uri |
|
| 65 | + ) |
|
| 66 | + ); |
|
| 67 | + } |
|
| 68 | 68 | |
| 69 | - $closure = function () use ($uri, $context) { |
|
| 69 | + $closure = function () use ($uri, $context) { |
|
| 70 | 70 | |
| 71 | - // Save current buffering level so we can backtrack in case of an error. |
|
| 72 | - // This is needed because the view itself might also add an unknown number of output buffering levels. |
|
| 73 | - $bufferLevel = ob_get_level(); |
|
| 74 | - ob_start(); |
|
| 71 | + // Save current buffering level so we can backtrack in case of an error. |
|
| 72 | + // This is needed because the view itself might also add an unknown number of output buffering levels. |
|
| 73 | + $bufferLevel = ob_get_level(); |
|
| 74 | + ob_start(); |
|
| 75 | 75 | |
| 76 | - try { |
|
| 77 | - include $uri; |
|
| 78 | - } catch (Exception $exception) { |
|
| 79 | - // Remove whatever levels were added up until now. |
|
| 80 | - while (ob_get_level() > $bufferLevel) { |
|
| 81 | - ob_end_clean(); |
|
| 82 | - } |
|
| 76 | + try { |
|
| 77 | + include $uri; |
|
| 78 | + } catch (Exception $exception) { |
|
| 79 | + // Remove whatever levels were added up until now. |
|
| 80 | + while (ob_get_level() > $bufferLevel) { |
|
| 81 | + ob_end_clean(); |
|
| 82 | + } |
|
| 83 | 83 | |
| 84 | - throw new FailedToLoadView( |
|
| 85 | - sprintf( |
|
| 86 | - _('Could not load the View URI "%1$s". Reason: "%2$s".'), |
|
| 87 | - $uri, |
|
| 88 | - $exception->getMessage() |
|
| 89 | - ), |
|
| 90 | - $exception->getCode(), |
|
| 91 | - $exception |
|
| 92 | - ); |
|
| 93 | - } |
|
| 84 | + throw new FailedToLoadView( |
|
| 85 | + sprintf( |
|
| 86 | + _('Could not load the View URI "%1$s". Reason: "%2$s".'), |
|
| 87 | + $uri, |
|
| 88 | + $exception->getMessage() |
|
| 89 | + ), |
|
| 90 | + $exception->getCode(), |
|
| 91 | + $exception |
|
| 92 | + ); |
|
| 93 | + } |
|
| 94 | 94 | |
| 95 | - return ob_get_clean(); |
|
| 96 | - }; |
|
| 95 | + return ob_get_clean(); |
|
| 96 | + }; |
|
| 97 | 97 | |
| 98 | - return $closure; |
|
| 99 | - } |
|
| 98 | + return $closure; |
|
| 99 | + } |
|
| 100 | 100 | } |
@@ -57,7 +57,7 @@ discard block |
||
| 57 | 57 | */ |
| 58 | 58 | public function getRenderCallback(string $uri, array $context = []): callable |
| 59 | 59 | { |
| 60 | - if (! is_readable($uri)) { |
|
| 60 | + if ( ! is_readable($uri)) { |
|
| 61 | 61 | throw new FailedToLoadView( |
| 62 | 62 | sprintf( |
| 63 | 63 | _('The View URI "%1$s" is not accessible or readable.'), |
@@ -66,7 +66,7 @@ discard block |
||
| 66 | 66 | ); |
| 67 | 67 | } |
| 68 | 68 | |
| 69 | - $closure = function () use ($uri, $context) { |
|
| 69 | + $closure = function() use ($uri, $context) { |
|
| 70 | 70 | |
| 71 | 71 | // Save current buffering level so we can backtrack in case of an error. |
| 72 | 72 | // This is needed because the view itself might also add an unknown number of output buffering levels. |
@@ -46,7 +46,7 @@ |
||
| 46 | 46 | * @param string $uri URI to render. |
| 47 | 47 | * @param array $context Context in which to render. |
| 48 | 48 | * |
| 49 | - * @return callable Rendering callback. |
|
| 49 | + * @return string Rendering callback. |
|
| 50 | 50 | */ |
| 51 | 51 | public function getRenderCallback(string $uri, array $context = []): callable |
| 52 | 52 | { |
@@ -24,32 +24,32 @@ |
||
| 24 | 24 | class NullEngine implements Engine, NullFindable |
| 25 | 25 | { |
| 26 | 26 | |
| 27 | - /** |
|
| 28 | - * Check whether the Findable can handle an individual criterion. |
|
| 29 | - * |
|
| 30 | - * @since 0.1.0 |
|
| 31 | - * |
|
| 32 | - * @param mixed $criterion Criterion to check. |
|
| 33 | - * |
|
| 34 | - * @return bool Whether the Findable can handle the criterion. |
|
| 35 | - */ |
|
| 36 | - public function canHandle($criterion): bool |
|
| 37 | - { |
|
| 38 | - return true; |
|
| 39 | - } |
|
| 27 | + /** |
|
| 28 | + * Check whether the Findable can handle an individual criterion. |
|
| 29 | + * |
|
| 30 | + * @since 0.1.0 |
|
| 31 | + * |
|
| 32 | + * @param mixed $criterion Criterion to check. |
|
| 33 | + * |
|
| 34 | + * @return bool Whether the Findable can handle the criterion. |
|
| 35 | + */ |
|
| 36 | + public function canHandle($criterion): bool |
|
| 37 | + { |
|
| 38 | + return true; |
|
| 39 | + } |
|
| 40 | 40 | |
| 41 | - /** |
|
| 42 | - * Get the rendering callback for a given URI. |
|
| 43 | - * |
|
| 44 | - * @since 0.1.0 |
|
| 45 | - * |
|
| 46 | - * @param string $uri URI to render. |
|
| 47 | - * @param array $context Context in which to render. |
|
| 48 | - * |
|
| 49 | - * @return callable Rendering callback. |
|
| 50 | - */ |
|
| 51 | - public function getRenderCallback(string $uri, array $context = []): callable |
|
| 52 | - { |
|
| 53 | - return ''; |
|
| 54 | - } |
|
| 41 | + /** |
|
| 42 | + * Get the rendering callback for a given URI. |
|
| 43 | + * |
|
| 44 | + * @since 0.1.0 |
|
| 45 | + * |
|
| 46 | + * @param string $uri URI to render. |
|
| 47 | + * @param array $context Context in which to render. |
|
| 48 | + * |
|
| 49 | + * @return callable Rendering callback. |
|
| 50 | + */ |
|
| 51 | + public function getRenderCallback(string $uri, array $context = []): callable |
|
| 52 | + { |
|
| 53 | + return ''; |
|
| 54 | + } |
|
| 55 | 55 | } |
@@ -94,7 +94,7 @@ discard block |
||
| 94 | 94 | * @since 0.1.0 |
| 95 | 95 | * |
| 96 | 96 | * @param string $view View identifier to create a view for. |
| 97 | - * @param mixed $type Type of view to create. |
|
| 97 | + * @param string|null $type Type of view to create. |
|
| 98 | 98 | * |
| 99 | 99 | * @return View Instance of the requested view. |
| 100 | 100 | * @throws FailedToInstantiateView If the view could not be instantiated. |
@@ -199,7 +199,7 @@ discard block |
||
| 199 | 199 | * |
| 200 | 200 | * @since 0.1.0 |
| 201 | 201 | * |
| 202 | - * @param array $criteria Criteria to match. |
|
| 202 | + * @param string[] $criteria Criteria to match. |
|
| 203 | 203 | * |
| 204 | 204 | * @return string|false URI of the requested view, or false if not found. |
| 205 | 205 | */ |
@@ -281,7 +281,7 @@ discard block |
||
| 281 | 281 | * |
| 282 | 282 | * @since 0.2.0 |
| 283 | 283 | * |
| 284 | - * @param ConfigInterface|array $config Config to merge with defaults. |
|
| 284 | + * @param null|ConfigInterface $config Config to merge with defaults. |
|
| 285 | 285 | * |
| 286 | 286 | * @return ConfigInterface Configuration passed in through the constructor. |
| 287 | 287 | */ |
@@ -205,10 +205,10 @@ discard block |
||
| 205 | 205 | */ |
| 206 | 206 | public function scanLocations(array $criteria) |
| 207 | 207 | { |
| 208 | - $uris = $this->locations->map(function ($location) use ($criteria) { |
|
| 208 | + $uris = $this->locations->map(function($location) use ($criteria) { |
|
| 209 | 209 | /** @var Location $location */ |
| 210 | 210 | return $location->getURI($criteria); |
| 211 | - })->filter(function ($uri) { |
|
| 211 | + })->filter(function($uri) { |
|
| 212 | 212 | return false !== $uri; |
| 213 | 213 | }); |
| 214 | 214 | |
@@ -273,7 +273,7 @@ discard block |
||
| 273 | 273 | $type = $type($uri, $engine); |
| 274 | 274 | } |
| 275 | 275 | |
| 276 | - if (! $type instanceof View) { |
|
| 276 | + if ( ! $type instanceof View) { |
|
| 277 | 277 | throw new FailedToInstantiateView( |
| 278 | 278 | sprintf( |
| 279 | 279 | _('Could not instantiate view "%s".'), |
@@ -296,7 +296,7 @@ discard block |
||
| 296 | 296 | */ |
| 297 | 297 | protected function getConfig($config = []): ConfigInterface |
| 298 | 298 | { |
| 299 | - $defaults = ConfigFactory::create(dirname(__DIR__, 2) . '/config/defaults.php', $config); |
|
| 299 | + $defaults = ConfigFactory::create(dirname(__DIR__, 2).'/config/defaults.php', $config); |
|
| 300 | 300 | $config = $config |
| 301 | 301 | ? ConfigFactory::createFromArray(array_merge_recursive($defaults->getArrayCopy(), $config->getArrayCopy())) |
| 302 | 302 | : $defaults; |
@@ -34,277 +34,277 @@ |
||
| 34 | 34 | class ViewBuilder |
| 35 | 35 | { |
| 36 | 36 | |
| 37 | - use ConfigTrait; |
|
| 37 | + use ConfigTrait; |
|
| 38 | 38 | |
| 39 | - const ENGINE_FINDER_KEY = 'EngineFinder'; |
|
| 40 | - const VIEW_FINDER_KEY = 'ViewFinder'; |
|
| 39 | + const ENGINE_FINDER_KEY = 'EngineFinder'; |
|
| 40 | + const VIEW_FINDER_KEY = 'ViewFinder'; |
|
| 41 | 41 | |
| 42 | - /** |
|
| 43 | - * BaseViewFinder instance. |
|
| 44 | - * |
|
| 45 | - * @since 0.1.0 |
|
| 46 | - * |
|
| 47 | - * @var ViewFinder |
|
| 48 | - */ |
|
| 49 | - protected $viewFinder; |
|
| 42 | + /** |
|
| 43 | + * BaseViewFinder instance. |
|
| 44 | + * |
|
| 45 | + * @since 0.1.0 |
|
| 46 | + * |
|
| 47 | + * @var ViewFinder |
|
| 48 | + */ |
|
| 49 | + protected $viewFinder; |
|
| 50 | 50 | |
| 51 | - /** |
|
| 52 | - * BaseEngineFinder instance. |
|
| 53 | - * |
|
| 54 | - * @since 0.1.0 |
|
| 55 | - * |
|
| 56 | - * @var BaseEngineFinder |
|
| 57 | - */ |
|
| 58 | - protected $engineFinder; |
|
| 51 | + /** |
|
| 52 | + * BaseEngineFinder instance. |
|
| 53 | + * |
|
| 54 | + * @since 0.1.0 |
|
| 55 | + * |
|
| 56 | + * @var BaseEngineFinder |
|
| 57 | + */ |
|
| 58 | + protected $engineFinder; |
|
| 59 | 59 | |
| 60 | - /** |
|
| 61 | - * Locations to scan for views. |
|
| 62 | - * |
|
| 63 | - * @since 0.1.0 |
|
| 64 | - * |
|
| 65 | - * @var Locations |
|
| 66 | - */ |
|
| 67 | - protected $locations; |
|
| 60 | + /** |
|
| 61 | + * Locations to scan for views. |
|
| 62 | + * |
|
| 63 | + * @since 0.1.0 |
|
| 64 | + * |
|
| 65 | + * @var Locations |
|
| 66 | + */ |
|
| 67 | + protected $locations; |
|
| 68 | 68 | |
| 69 | - /** |
|
| 70 | - * Instantiate a ViewBuilder object. |
|
| 71 | - * |
|
| 72 | - * @since 0.1.0 |
|
| 73 | - * |
|
| 74 | - * @param ConfigInterface $config Optional. Configuration settings. |
|
| 75 | - * @param ViewFinder|null $viewFinder Optional. BaseViewFinder instance. |
|
| 76 | - * @param BaseEngineFinder|null $engineFinder Optional. BaseEngineFinder instance. |
|
| 77 | - * |
|
| 78 | - * @throws FailedToProcessConfigException If the config could not be processed. |
|
| 79 | - */ |
|
| 80 | - public function __construct( |
|
| 81 | - ConfigInterface $config = null, |
|
| 82 | - ViewFinder $viewFinder = null, |
|
| 83 | - BaseEngineFinder $engineFinder = null |
|
| 84 | - ) { |
|
| 85 | - $this->processConfig($this->getConfig($config)); |
|
| 86 | - $this->viewFinder = $viewFinder; |
|
| 87 | - $this->engineFinder = $engineFinder; |
|
| 88 | - $this->locations = new Locations(); |
|
| 89 | - } |
|
| 69 | + /** |
|
| 70 | + * Instantiate a ViewBuilder object. |
|
| 71 | + * |
|
| 72 | + * @since 0.1.0 |
|
| 73 | + * |
|
| 74 | + * @param ConfigInterface $config Optional. Configuration settings. |
|
| 75 | + * @param ViewFinder|null $viewFinder Optional. BaseViewFinder instance. |
|
| 76 | + * @param BaseEngineFinder|null $engineFinder Optional. BaseEngineFinder instance. |
|
| 77 | + * |
|
| 78 | + * @throws FailedToProcessConfigException If the config could not be processed. |
|
| 79 | + */ |
|
| 80 | + public function __construct( |
|
| 81 | + ConfigInterface $config = null, |
|
| 82 | + ViewFinder $viewFinder = null, |
|
| 83 | + BaseEngineFinder $engineFinder = null |
|
| 84 | + ) { |
|
| 85 | + $this->processConfig($this->getConfig($config)); |
|
| 86 | + $this->viewFinder = $viewFinder; |
|
| 87 | + $this->engineFinder = $engineFinder; |
|
| 88 | + $this->locations = new Locations(); |
|
| 89 | + } |
|
| 90 | 90 | |
| 91 | - /** |
|
| 92 | - * Create a new view for a given URI. |
|
| 93 | - * |
|
| 94 | - * @since 0.1.0 |
|
| 95 | - * |
|
| 96 | - * @param string $view View identifier to create a view for. |
|
| 97 | - * @param mixed $type Type of view to create. |
|
| 98 | - * |
|
| 99 | - * @return View Instance of the requested view. |
|
| 100 | - * @throws FailedToInstantiateView If the view could not be instantiated. |
|
| 101 | - */ |
|
| 102 | - public function create(string $view, $type = null): View |
|
| 103 | - { |
|
| 104 | - $uri = $this->scanLocations([$view]); |
|
| 105 | - $engine = $uri |
|
| 106 | - ? $this->getEngine($uri) |
|
| 107 | - : false; |
|
| 91 | + /** |
|
| 92 | + * Create a new view for a given URI. |
|
| 93 | + * |
|
| 94 | + * @since 0.1.0 |
|
| 95 | + * |
|
| 96 | + * @param string $view View identifier to create a view for. |
|
| 97 | + * @param mixed $type Type of view to create. |
|
| 98 | + * |
|
| 99 | + * @return View Instance of the requested view. |
|
| 100 | + * @throws FailedToInstantiateView If the view could not be instantiated. |
|
| 101 | + */ |
|
| 102 | + public function create(string $view, $type = null): View |
|
| 103 | + { |
|
| 104 | + $uri = $this->scanLocations([$view]); |
|
| 105 | + $engine = $uri |
|
| 106 | + ? $this->getEngine($uri) |
|
| 107 | + : false; |
|
| 108 | 108 | |
| 109 | - return ($uri && $engine) |
|
| 110 | - ? $this->getView($uri, $engine, $type) |
|
| 111 | - : $this->getViewFinder()->getNullObject(); |
|
| 112 | - } |
|
| 109 | + return ($uri && $engine) |
|
| 110 | + ? $this->getView($uri, $engine, $type) |
|
| 111 | + : $this->getViewFinder()->getNullObject(); |
|
| 112 | + } |
|
| 113 | 113 | |
| 114 | - /** |
|
| 115 | - * Get an Engine that can deal with the given URI. |
|
| 116 | - * |
|
| 117 | - * @since 0.1.0 |
|
| 118 | - * |
|
| 119 | - * @param string $uri URI to get an engine for. |
|
| 120 | - * |
|
| 121 | - * @return Engine Instance of an engine that can deal with the given URI. |
|
| 122 | - */ |
|
| 123 | - public function getEngine(string $uri): Engine |
|
| 124 | - { |
|
| 125 | - return $this->getEngineFinder()->find([$uri]); |
|
| 126 | - } |
|
| 114 | + /** |
|
| 115 | + * Get an Engine that can deal with the given URI. |
|
| 116 | + * |
|
| 117 | + * @since 0.1.0 |
|
| 118 | + * |
|
| 119 | + * @param string $uri URI to get an engine for. |
|
| 120 | + * |
|
| 121 | + * @return Engine Instance of an engine that can deal with the given URI. |
|
| 122 | + */ |
|
| 123 | + public function getEngine(string $uri): Engine |
|
| 124 | + { |
|
| 125 | + return $this->getEngineFinder()->find([$uri]); |
|
| 126 | + } |
|
| 127 | 127 | |
| 128 | - /** |
|
| 129 | - * Get a view for a given URI, engine and type. |
|
| 130 | - * |
|
| 131 | - * @since 0.1.0 |
|
| 132 | - * |
|
| 133 | - * @param string $uri URI to get a view for. |
|
| 134 | - * @param Engine $engine Engine to use for the view. |
|
| 135 | - * @param mixed $type Type of view to get. |
|
| 136 | - * |
|
| 137 | - * @return View View that matches the given requirements. |
|
| 138 | - * @throws FailedToInstantiateView If the view could not be instantiated. |
|
| 139 | - */ |
|
| 140 | - public function getView(string $uri, Engine $engine, $type = null): View |
|
| 141 | - { |
|
| 142 | - $view = (null === $type) |
|
| 143 | - ? $this->getViewFinder()->find([$uri], $engine) |
|
| 144 | - : $this->resolveType($type, $uri, $engine); |
|
| 128 | + /** |
|
| 129 | + * Get a view for a given URI, engine and type. |
|
| 130 | + * |
|
| 131 | + * @since 0.1.0 |
|
| 132 | + * |
|
| 133 | + * @param string $uri URI to get a view for. |
|
| 134 | + * @param Engine $engine Engine to use for the view. |
|
| 135 | + * @param mixed $type Type of view to get. |
|
| 136 | + * |
|
| 137 | + * @return View View that matches the given requirements. |
|
| 138 | + * @throws FailedToInstantiateView If the view could not be instantiated. |
|
| 139 | + */ |
|
| 140 | + public function getView(string $uri, Engine $engine, $type = null): View |
|
| 141 | + { |
|
| 142 | + $view = (null === $type) |
|
| 143 | + ? $this->getViewFinder()->find([$uri], $engine) |
|
| 144 | + : $this->resolveType($type, $uri, $engine); |
|
| 145 | 145 | |
| 146 | - return $view->setBuilder($this); |
|
| 147 | - } |
|
| 146 | + return $view->setBuilder($this); |
|
| 147 | + } |
|
| 148 | 148 | |
| 149 | - /** |
|
| 150 | - * Get the ViewFinder instance. |
|
| 151 | - * |
|
| 152 | - * @since 0.1.0 |
|
| 153 | - * |
|
| 154 | - * @return ViewFinder Instance of a BaseViewFinder. |
|
| 155 | - */ |
|
| 156 | - public function getViewFinder(): ViewFinder |
|
| 157 | - { |
|
| 158 | - return $this->getFinder($viewFinder, static::VIEW_FINDER_KEY); |
|
| 159 | - } |
|
| 149 | + /** |
|
| 150 | + * Get the ViewFinder instance. |
|
| 151 | + * |
|
| 152 | + * @since 0.1.0 |
|
| 153 | + * |
|
| 154 | + * @return ViewFinder Instance of a BaseViewFinder. |
|
| 155 | + */ |
|
| 156 | + public function getViewFinder(): ViewFinder |
|
| 157 | + { |
|
| 158 | + return $this->getFinder($viewFinder, static::VIEW_FINDER_KEY); |
|
| 159 | + } |
|
| 160 | 160 | |
| 161 | - /** |
|
| 162 | - * Get the EngineFinder instance. |
|
| 163 | - * |
|
| 164 | - * @since 0.1.0 |
|
| 165 | - * |
|
| 166 | - * @return EngineFinder Instance of a BaseEngineFinder. |
|
| 167 | - */ |
|
| 168 | - public function getEngineFinder(): EngineFinder |
|
| 169 | - { |
|
| 170 | - return $this->getFinder($this->engineFinder, static::ENGINE_FINDER_KEY); |
|
| 171 | - } |
|
| 161 | + /** |
|
| 162 | + * Get the EngineFinder instance. |
|
| 163 | + * |
|
| 164 | + * @since 0.1.0 |
|
| 165 | + * |
|
| 166 | + * @return EngineFinder Instance of a BaseEngineFinder. |
|
| 167 | + */ |
|
| 168 | + public function getEngineFinder(): EngineFinder |
|
| 169 | + { |
|
| 170 | + return $this->getFinder($this->engineFinder, static::ENGINE_FINDER_KEY); |
|
| 171 | + } |
|
| 172 | 172 | |
| 173 | - /** |
|
| 174 | - * Add a location to scan with the BaseViewFinder. |
|
| 175 | - * |
|
| 176 | - * @since 0.1.0 |
|
| 177 | - * |
|
| 178 | - * @param Location $location Location to scan with the BaseViewFinder. |
|
| 179 | - * |
|
| 180 | - * @return static |
|
| 181 | - */ |
|
| 182 | - public function addLocation(Location $location) |
|
| 183 | - { |
|
| 184 | - $this->locations->add($location); |
|
| 173 | + /** |
|
| 174 | + * Add a location to scan with the BaseViewFinder. |
|
| 175 | + * |
|
| 176 | + * @since 0.1.0 |
|
| 177 | + * |
|
| 178 | + * @param Location $location Location to scan with the BaseViewFinder. |
|
| 179 | + * |
|
| 180 | + * @return static |
|
| 181 | + */ |
|
| 182 | + public function addLocation(Location $location) |
|
| 183 | + { |
|
| 184 | + $this->locations->add($location); |
|
| 185 | 185 | |
| 186 | - return $this; |
|
| 187 | - } |
|
| 186 | + return $this; |
|
| 187 | + } |
|
| 188 | 188 | |
| 189 | - /** |
|
| 190 | - * Get the collection of locations registered with this ViewBuilder. |
|
| 191 | - * |
|
| 192 | - * @since 0.1.3 |
|
| 193 | - * |
|
| 194 | - * @return Locations Collection of locations. |
|
| 195 | - */ |
|
| 196 | - public function getLocations() |
|
| 197 | - { |
|
| 198 | - return $this->locations; |
|
| 199 | - } |
|
| 189 | + /** |
|
| 190 | + * Get the collection of locations registered with this ViewBuilder. |
|
| 191 | + * |
|
| 192 | + * @since 0.1.3 |
|
| 193 | + * |
|
| 194 | + * @return Locations Collection of locations. |
|
| 195 | + */ |
|
| 196 | + public function getLocations() |
|
| 197 | + { |
|
| 198 | + return $this->locations; |
|
| 199 | + } |
|
| 200 | 200 | |
| 201 | - /** |
|
| 202 | - * Scan Locations for an URI that matches the specified criteria. |
|
| 203 | - * |
|
| 204 | - * @since 0.1.0 |
|
| 205 | - * |
|
| 206 | - * @param array $criteria Criteria to match. |
|
| 207 | - * |
|
| 208 | - * @return string|false URI of the requested view, or false if not found. |
|
| 209 | - */ |
|
| 210 | - public function scanLocations(array $criteria) |
|
| 211 | - { |
|
| 212 | - $uris = $this->locations->map(function ($location) use ($criteria) { |
|
| 213 | - /** @var Location $location */ |
|
| 214 | - return $location->getURI($criteria); |
|
| 215 | - })->filter(function ($uri) { |
|
| 216 | - return false !== $uri; |
|
| 217 | - }); |
|
| 201 | + /** |
|
| 202 | + * Scan Locations for an URI that matches the specified criteria. |
|
| 203 | + * |
|
| 204 | + * @since 0.1.0 |
|
| 205 | + * |
|
| 206 | + * @param array $criteria Criteria to match. |
|
| 207 | + * |
|
| 208 | + * @return string|false URI of the requested view, or false if not found. |
|
| 209 | + */ |
|
| 210 | + public function scanLocations(array $criteria) |
|
| 211 | + { |
|
| 212 | + $uris = $this->locations->map(function ($location) use ($criteria) { |
|
| 213 | + /** @var Location $location */ |
|
| 214 | + return $location->getURI($criteria); |
|
| 215 | + })->filter(function ($uri) { |
|
| 216 | + return false !== $uri; |
|
| 217 | + }); |
|
| 218 | 218 | |
| 219 | - // Fall back for absolute paths on current filesystem. |
|
| 220 | - if ($uris->isEmpty()) { |
|
| 221 | - foreach ($criteria as $criterion) { |
|
| 222 | - if (file_exists($criterion)) { |
|
| 223 | - return $criterion; |
|
| 224 | - } |
|
| 225 | - } |
|
| 226 | - } |
|
| 219 | + // Fall back for absolute paths on current filesystem. |
|
| 220 | + if ($uris->isEmpty()) { |
|
| 221 | + foreach ($criteria as $criterion) { |
|
| 222 | + if (file_exists($criterion)) { |
|
| 223 | + return $criterion; |
|
| 224 | + } |
|
| 225 | + } |
|
| 226 | + } |
|
| 227 | 227 | |
| 228 | - return $uris->isEmpty() ? false : $uris->first(); |
|
| 229 | - } |
|
| 228 | + return $uris->isEmpty() ? false : $uris->first(); |
|
| 229 | + } |
|
| 230 | 230 | |
| 231 | - /** |
|
| 232 | - * Get a finder instance. |
|
| 233 | - * |
|
| 234 | - * @since 0.1.1 |
|
| 235 | - * |
|
| 236 | - * @param mixed $property Property to use. |
|
| 237 | - * @param string $key Configuration key to use. |
|
| 238 | - * |
|
| 239 | - * @return ViewFinder|EngineFinder The requested finder instance. |
|
| 240 | - */ |
|
| 241 | - protected function getFinder(&$property, $key) |
|
| 242 | - { |
|
| 243 | - if (null === $property) { |
|
| 244 | - $finderClass = $this->config->getKey($key, 'ClassName'); |
|
| 245 | - $property = new $finderClass($this->config->getSubConfig($key)); |
|
| 246 | - } |
|
| 231 | + /** |
|
| 232 | + * Get a finder instance. |
|
| 233 | + * |
|
| 234 | + * @since 0.1.1 |
|
| 235 | + * |
|
| 236 | + * @param mixed $property Property to use. |
|
| 237 | + * @param string $key Configuration key to use. |
|
| 238 | + * |
|
| 239 | + * @return ViewFinder|EngineFinder The requested finder instance. |
|
| 240 | + */ |
|
| 241 | + protected function getFinder(&$property, $key) |
|
| 242 | + { |
|
| 243 | + if (null === $property) { |
|
| 244 | + $finderClass = $this->config->getKey($key, 'ClassName'); |
|
| 245 | + $property = new $finderClass($this->config->getSubConfig($key)); |
|
| 246 | + } |
|
| 247 | 247 | |
| 248 | - return $property; |
|
| 249 | - } |
|
| 248 | + return $property; |
|
| 249 | + } |
|
| 250 | 250 | |
| 251 | - /** |
|
| 252 | - * Resolve the view type. |
|
| 253 | - * |
|
| 254 | - * @since 0.1.0 |
|
| 255 | - * |
|
| 256 | - * @param mixed $type Type of view that was requested. |
|
| 257 | - * @param string $uri URI to get a view for. |
|
| 258 | - * @param Engine|null $engine Engine to use for the view. |
|
| 259 | - * |
|
| 260 | - * @return View Resolved View object. |
|
| 261 | - * @throws FailedToInstantiateView If the view type could not be resolved. |
|
| 262 | - */ |
|
| 263 | - protected function resolveType($type, string $uri, Engine $engine = null): View |
|
| 264 | - { |
|
| 265 | - $configKey = [static::VIEW_FINDER_KEY, 'Views', $type]; |
|
| 251 | + /** |
|
| 252 | + * Resolve the view type. |
|
| 253 | + * |
|
| 254 | + * @since 0.1.0 |
|
| 255 | + * |
|
| 256 | + * @param mixed $type Type of view that was requested. |
|
| 257 | + * @param string $uri URI to get a view for. |
|
| 258 | + * @param Engine|null $engine Engine to use for the view. |
|
| 259 | + * |
|
| 260 | + * @return View Resolved View object. |
|
| 261 | + * @throws FailedToInstantiateView If the view type could not be resolved. |
|
| 262 | + */ |
|
| 263 | + protected function resolveType($type, string $uri, Engine $engine = null): View |
|
| 264 | + { |
|
| 265 | + $configKey = [static::VIEW_FINDER_KEY, 'Views', $type]; |
|
| 266 | 266 | |
| 267 | - if (is_string($type) && $this->config->hasKey($configKey)) { |
|
| 268 | - $className = $this->config->getKey($configKey); |
|
| 269 | - $type = new $className($uri, $engine); |
|
| 270 | - } |
|
| 267 | + if (is_string($type) && $this->config->hasKey($configKey)) { |
|
| 268 | + $className = $this->config->getKey($configKey); |
|
| 269 | + $type = new $className($uri, $engine); |
|
| 270 | + } |
|
| 271 | 271 | |
| 272 | - if (is_string($type)) { |
|
| 273 | - $type = new $type($uri, $engine); |
|
| 274 | - } |
|
| 272 | + if (is_string($type)) { |
|
| 273 | + $type = new $type($uri, $engine); |
|
| 274 | + } |
|
| 275 | 275 | |
| 276 | - if (is_callable($type)) { |
|
| 277 | - $type = $type($uri, $engine); |
|
| 278 | - } |
|
| 276 | + if (is_callable($type)) { |
|
| 277 | + $type = $type($uri, $engine); |
|
| 278 | + } |
|
| 279 | 279 | |
| 280 | - if (! $type instanceof View) { |
|
| 281 | - throw new FailedToInstantiateView( |
|
| 282 | - sprintf( |
|
| 283 | - _('Could not instantiate view "%s".'), |
|
| 284 | - serialize($type) |
|
| 285 | - ) |
|
| 286 | - ); |
|
| 287 | - } |
|
| 280 | + if (! $type instanceof View) { |
|
| 281 | + throw new FailedToInstantiateView( |
|
| 282 | + sprintf( |
|
| 283 | + _('Could not instantiate view "%s".'), |
|
| 284 | + serialize($type) |
|
| 285 | + ) |
|
| 286 | + ); |
|
| 287 | + } |
|
| 288 | 288 | |
| 289 | - return $type; |
|
| 290 | - } |
|
| 289 | + return $type; |
|
| 290 | + } |
|
| 291 | 291 | |
| 292 | - /** |
|
| 293 | - * Get the configuration to use in the ViewBuilder. |
|
| 294 | - * |
|
| 295 | - * @since 0.2.0 |
|
| 296 | - * |
|
| 297 | - * @param ConfigInterface|array $config Config to merge with defaults. |
|
| 298 | - * |
|
| 299 | - * @return ConfigInterface Configuration passed in through the constructor. |
|
| 300 | - */ |
|
| 301 | - protected function getConfig($config = []): ConfigInterface |
|
| 302 | - { |
|
| 303 | - $defaults = ConfigFactory::create(dirname(__DIR__, 2) . '/config/defaults.php', $config); |
|
| 304 | - $config = $config |
|
| 305 | - ? ConfigFactory::createFromArray(array_merge_recursive($defaults->getArrayCopy(), $config->getArrayCopy())) |
|
| 306 | - : $defaults; |
|
| 292 | + /** |
|
| 293 | + * Get the configuration to use in the ViewBuilder. |
|
| 294 | + * |
|
| 295 | + * @since 0.2.0 |
|
| 296 | + * |
|
| 297 | + * @param ConfigInterface|array $config Config to merge with defaults. |
|
| 298 | + * |
|
| 299 | + * @return ConfigInterface Configuration passed in through the constructor. |
|
| 300 | + */ |
|
| 301 | + protected function getConfig($config = []): ConfigInterface |
|
| 302 | + { |
|
| 303 | + $defaults = ConfigFactory::create(dirname(__DIR__, 2) . '/config/defaults.php', $config); |
|
| 304 | + $config = $config |
|
| 305 | + ? ConfigFactory::createFromArray(array_merge_recursive($defaults->getArrayCopy(), $config->getArrayCopy())) |
|
| 306 | + : $defaults; |
|
| 307 | 307 | |
| 308 | - return $config->getSubConfig('BrightNucleus\View'); |
|
| 309 | - } |
|
| 308 | + return $config->getSubConfig('BrightNucleus\View'); |
|
| 309 | + } |
|
| 310 | 310 | } |
@@ -28,97 +28,97 @@ |
||
| 28 | 28 | class Views |
| 29 | 29 | { |
| 30 | 30 | |
| 31 | - /** |
|
| 32 | - * ViewBuilder Instance. |
|
| 33 | - * |
|
| 34 | - * @since 0.1.0 |
|
| 35 | - * |
|
| 36 | - * @var ViewBuilder |
|
| 37 | - */ |
|
| 38 | - protected static $viewBuilder; |
|
| 31 | + /** |
|
| 32 | + * ViewBuilder Instance. |
|
| 33 | + * |
|
| 34 | + * @since 0.1.0 |
|
| 35 | + * |
|
| 36 | + * @var ViewBuilder |
|
| 37 | + */ |
|
| 38 | + protected static $viewBuilder; |
|
| 39 | 39 | |
| 40 | - /** |
|
| 41 | - * Add a location to the ViewBuilder. |
|
| 42 | - * |
|
| 43 | - * @since 0.1.0 |
|
| 44 | - * |
|
| 45 | - * @param Location $location Location to add. |
|
| 46 | - * |
|
| 47 | - * @throws FailedToProcessConfigException If the Config could not be processed. |
|
| 48 | - */ |
|
| 49 | - public static function addLocation(Location $location) |
|
| 50 | - { |
|
| 51 | - $viewBuilder = static::getViewBuilder(); |
|
| 52 | - $viewBuilder->addLocation($location); |
|
| 53 | - } |
|
| 40 | + /** |
|
| 41 | + * Add a location to the ViewBuilder. |
|
| 42 | + * |
|
| 43 | + * @since 0.1.0 |
|
| 44 | + * |
|
| 45 | + * @param Location $location Location to add. |
|
| 46 | + * |
|
| 47 | + * @throws FailedToProcessConfigException If the Config could not be processed. |
|
| 48 | + */ |
|
| 49 | + public static function addLocation(Location $location) |
|
| 50 | + { |
|
| 51 | + $viewBuilder = static::getViewBuilder(); |
|
| 52 | + $viewBuilder->addLocation($location); |
|
| 53 | + } |
|
| 54 | 54 | |
| 55 | - /** |
|
| 56 | - * Get the ViewBuilder instance. |
|
| 57 | - * |
|
| 58 | - * @since 0.1.0 |
|
| 59 | - * |
|
| 60 | - * @return ViewBuilder |
|
| 61 | - * @throws FailedToProcessConfigException If the Config could not be processed. |
|
| 62 | - */ |
|
| 63 | - public static function getViewBuilder() |
|
| 64 | - { |
|
| 65 | - if (null === static::$viewBuilder) { |
|
| 66 | - static::$viewBuilder = static::instantiateViewBuilder(); |
|
| 67 | - } |
|
| 55 | + /** |
|
| 56 | + * Get the ViewBuilder instance. |
|
| 57 | + * |
|
| 58 | + * @since 0.1.0 |
|
| 59 | + * |
|
| 60 | + * @return ViewBuilder |
|
| 61 | + * @throws FailedToProcessConfigException If the Config could not be processed. |
|
| 62 | + */ |
|
| 63 | + public static function getViewBuilder() |
|
| 64 | + { |
|
| 65 | + if (null === static::$viewBuilder) { |
|
| 66 | + static::$viewBuilder = static::instantiateViewBuilder(); |
|
| 67 | + } |
|
| 68 | 68 | |
| 69 | - return static::$viewBuilder; |
|
| 70 | - } |
|
| 69 | + return static::$viewBuilder; |
|
| 70 | + } |
|
| 71 | 71 | |
| 72 | - /** |
|
| 73 | - * Instantiate the ViewBuilder. |
|
| 74 | - * |
|
| 75 | - * @since 0.1.0 |
|
| 76 | - * |
|
| 77 | - * @param ConfigInterface|null $config Optional. Configuration to pass into the ViewBuilder. |
|
| 78 | - * |
|
| 79 | - * @return ViewBuilder Instance of the ViewBuilder. |
|
| 80 | - * @throws FailedToProcessConfigException If the Config could not be processed. |
|
| 81 | - */ |
|
| 82 | - public static function instantiateViewBuilder(ConfigInterface $config = null) |
|
| 83 | - { |
|
| 84 | - return static::$viewBuilder = new ViewBuilder($config); |
|
| 85 | - } |
|
| 72 | + /** |
|
| 73 | + * Instantiate the ViewBuilder. |
|
| 74 | + * |
|
| 75 | + * @since 0.1.0 |
|
| 76 | + * |
|
| 77 | + * @param ConfigInterface|null $config Optional. Configuration to pass into the ViewBuilder. |
|
| 78 | + * |
|
| 79 | + * @return ViewBuilder Instance of the ViewBuilder. |
|
| 80 | + * @throws FailedToProcessConfigException If the Config could not be processed. |
|
| 81 | + */ |
|
| 82 | + public static function instantiateViewBuilder(ConfigInterface $config = null) |
|
| 83 | + { |
|
| 84 | + return static::$viewBuilder = new ViewBuilder($config); |
|
| 85 | + } |
|
| 86 | 86 | |
| 87 | - /** |
|
| 88 | - * Create a new view for a given URI. |
|
| 89 | - * |
|
| 90 | - * @since 0.1.0 |
|
| 91 | - * |
|
| 92 | - * @param string $view View identifier to create a view for. |
|
| 93 | - * @param string|null $type Type of view to create. |
|
| 94 | - * |
|
| 95 | - * @return View Instance of the requested view. |
|
| 96 | - * @throws FailedToProcessConfigException If the Config could not be processed. |
|
| 97 | - */ |
|
| 98 | - public static function create($view, $type = null) |
|
| 99 | - { |
|
| 100 | - $viewBuilder = static::getViewBuilder(); |
|
| 87 | + /** |
|
| 88 | + * Create a new view for a given URI. |
|
| 89 | + * |
|
| 90 | + * @since 0.1.0 |
|
| 91 | + * |
|
| 92 | + * @param string $view View identifier to create a view for. |
|
| 93 | + * @param string|null $type Type of view to create. |
|
| 94 | + * |
|
| 95 | + * @return View Instance of the requested view. |
|
| 96 | + * @throws FailedToProcessConfigException If the Config could not be processed. |
|
| 97 | + */ |
|
| 98 | + public static function create($view, $type = null) |
|
| 99 | + { |
|
| 100 | + $viewBuilder = static::getViewBuilder(); |
|
| 101 | 101 | |
| 102 | - return $viewBuilder->create($view, $type); |
|
| 103 | - } |
|
| 102 | + return $viewBuilder->create($view, $type); |
|
| 103 | + } |
|
| 104 | 104 | |
| 105 | - /** |
|
| 106 | - * Render a view for a given URI. |
|
| 107 | - * |
|
| 108 | - * @since 0.1.0 |
|
| 109 | - * |
|
| 110 | - * @param string $view View identifier to create a view for. |
|
| 111 | - * @param array $context Optional. The context in which to render the view. |
|
| 112 | - * @param string|null $type Type of view to create. |
|
| 113 | - * |
|
| 114 | - * @return string Rendered HTML content. |
|
| 115 | - * @throws FailedToProcessConfigException If the Config could not be processed. |
|
| 116 | - */ |
|
| 117 | - public static function render($view, array $context = [], $type = null) |
|
| 118 | - { |
|
| 119 | - $viewBuilder = static::getViewBuilder(); |
|
| 120 | - $viewObject = $viewBuilder->create($view, $type); |
|
| 105 | + /** |
|
| 106 | + * Render a view for a given URI. |
|
| 107 | + * |
|
| 108 | + * @since 0.1.0 |
|
| 109 | + * |
|
| 110 | + * @param string $view View identifier to create a view for. |
|
| 111 | + * @param array $context Optional. The context in which to render the view. |
|
| 112 | + * @param string|null $type Type of view to create. |
|
| 113 | + * |
|
| 114 | + * @return string Rendered HTML content. |
|
| 115 | + * @throws FailedToProcessConfigException If the Config could not be processed. |
|
| 116 | + */ |
|
| 117 | + public static function render($view, array $context = [], $type = null) |
|
| 118 | + { |
|
| 119 | + $viewBuilder = static::getViewBuilder(); |
|
| 120 | + $viewObject = $viewBuilder->create($view, $type); |
|
| 121 | 121 | |
| 122 | - return $viewObject->render($context); |
|
| 123 | - } |
|
| 122 | + return $viewObject->render($context); |
|
| 123 | + } |
|
| 124 | 124 | } |
@@ -25,19 +25,19 @@ |
||
| 25 | 25 | class URIs extends ArrayCollection |
| 26 | 26 | { |
| 27 | 27 | |
| 28 | - /** |
|
| 29 | - * Create a new URIs from a Symfony Finder instance. |
|
| 30 | - * |
|
| 31 | - * @since 0.1.3 |
|
| 32 | - * |
|
| 33 | - * @param Finder $finder The Finder instance to create the URI collection from. |
|
| 34 | - * |
|
| 35 | - * @return URIs New URIs instance. |
|
| 36 | - */ |
|
| 37 | - public static function fromFinder(Finder $finder): URIs |
|
| 38 | - { |
|
| 39 | - $elements = array_keys(iterator_to_array($finder)); |
|
| 28 | + /** |
|
| 29 | + * Create a new URIs from a Symfony Finder instance. |
|
| 30 | + * |
|
| 31 | + * @since 0.1.3 |
|
| 32 | + * |
|
| 33 | + * @param Finder $finder The Finder instance to create the URI collection from. |
|
| 34 | + * |
|
| 35 | + * @return URIs New URIs instance. |
|
| 36 | + */ |
|
| 37 | + public static function fromFinder(Finder $finder): URIs |
|
| 38 | + { |
|
| 39 | + $elements = array_keys(iterator_to_array($finder)); |
|
| 40 | 40 | |
| 41 | - return new static($elements); |
|
| 42 | - } |
|
| 41 | + return new static($elements); |
|
| 42 | + } |
|
| 43 | 43 | } |
@@ -22,25 +22,25 @@ |
||
| 22 | 22 | interface Location |
| 23 | 23 | { |
| 24 | 24 | |
| 25 | - /** |
|
| 26 | - * Get the first URI that matches the given criteria. |
|
| 27 | - * |
|
| 28 | - * @since 0.1.0 |
|
| 29 | - * |
|
| 30 | - * @param array $criteria Criteria to match. |
|
| 31 | - * |
|
| 32 | - * @return string|false URI that matches the criteria or false if none found. |
|
| 33 | - */ |
|
| 34 | - public function getURI(array $criteria); |
|
| 25 | + /** |
|
| 26 | + * Get the first URI that matches the given criteria. |
|
| 27 | + * |
|
| 28 | + * @since 0.1.0 |
|
| 29 | + * |
|
| 30 | + * @param array $criteria Criteria to match. |
|
| 31 | + * |
|
| 32 | + * @return string|false URI that matches the criteria or false if none found. |
|
| 33 | + */ |
|
| 34 | + public function getURI(array $criteria); |
|
| 35 | 35 | |
| 36 | - /** |
|
| 37 | - * Get all URIs that match the given criteria. |
|
| 38 | - * |
|
| 39 | - * @since 0.1.1 |
|
| 40 | - * |
|
| 41 | - * @param array $criteria Criteria to match. |
|
| 42 | - * |
|
| 43 | - * @return URIs Collection of URIs that matches the criteria or an empty collection if none found. |
|
| 44 | - */ |
|
| 45 | - public function getURIs(array $criteria): URIs; |
|
| 36 | + /** |
|
| 37 | + * Get all URIs that match the given criteria. |
|
| 38 | + * |
|
| 39 | + * @since 0.1.1 |
|
| 40 | + * |
|
| 41 | + * @param array $criteria Criteria to match. |
|
| 42 | + * |
|
| 43 | + * @return URIs Collection of URIs that matches the criteria or an empty collection if none found. |
|
| 44 | + */ |
|
| 45 | + public function getURIs(array $criteria): URIs; |
|
| 46 | 46 | } |
@@ -24,37 +24,37 @@ |
||
| 24 | 24 | class Locations extends ArrayCollection |
| 25 | 25 | { |
| 26 | 26 | |
| 27 | - /** |
|
| 28 | - * Adds a location at the end of the collection if it does not already exist. |
|
| 29 | - * |
|
| 30 | - * @param mixed $location The location to add. |
|
| 31 | - * |
|
| 32 | - * @return bool Whether the location was added or not. |
|
| 33 | - */ |
|
| 34 | - public function add($location): bool |
|
| 35 | - { |
|
| 36 | - if ($this->hasLocation($location)) { |
|
| 37 | - return false; |
|
| 38 | - } |
|
| 27 | + /** |
|
| 28 | + * Adds a location at the end of the collection if it does not already exist. |
|
| 29 | + * |
|
| 30 | + * @param mixed $location The location to add. |
|
| 31 | + * |
|
| 32 | + * @return bool Whether the location was added or not. |
|
| 33 | + */ |
|
| 34 | + public function add($location): bool |
|
| 35 | + { |
|
| 36 | + if ($this->hasLocation($location)) { |
|
| 37 | + return false; |
|
| 38 | + } |
|
| 39 | 39 | |
| 40 | - return parent::add($location); |
|
| 41 | - } |
|
| 40 | + return parent::add($location); |
|
| 41 | + } |
|
| 42 | 42 | |
| 43 | - /** |
|
| 44 | - * Check whether a given location is already registered. |
|
| 45 | - * |
|
| 46 | - * For two locations to be equal, both their path and their extensions must be the same. |
|
| 47 | - * |
|
| 48 | - * @since 0.1.1 |
|
| 49 | - * |
|
| 50 | - * @param Location $location Location to check the existence of. |
|
| 51 | - * |
|
| 52 | - * @return bool Whether the location is already registered or not. |
|
| 53 | - */ |
|
| 54 | - public function hasLocation(Location $location): bool |
|
| 55 | - { |
|
| 56 | - return $this->exists(function ($key, $element) use ($location) { |
|
| 57 | - return $location == $element; |
|
| 58 | - }); |
|
| 59 | - } |
|
| 43 | + /** |
|
| 44 | + * Check whether a given location is already registered. |
|
| 45 | + * |
|
| 46 | + * For two locations to be equal, both their path and their extensions must be the same. |
|
| 47 | + * |
|
| 48 | + * @since 0.1.1 |
|
| 49 | + * |
|
| 50 | + * @param Location $location Location to check the existence of. |
|
| 51 | + * |
|
| 52 | + * @return bool Whether the location is already registered or not. |
|
| 53 | + */ |
|
| 54 | + public function hasLocation(Location $location): bool |
|
| 55 | + { |
|
| 56 | + return $this->exists(function ($key, $element) use ($location) { |
|
| 57 | + return $location == $element; |
|
| 58 | + }); |
|
| 59 | + } |
|
| 60 | 60 | } |
@@ -53,7 +53,7 @@ |
||
| 53 | 53 | */ |
| 54 | 54 | public function hasLocation(Location $location): bool |
| 55 | 55 | { |
| 56 | - return $this->exists(function ($key, $element) use ($location) { |
|
| 56 | + return $this->exists(function($key, $element) use ($location) { |
|
| 57 | 57 | return $location == $element; |
| 58 | 58 | }); |
| 59 | 59 | } |
@@ -22,14 +22,14 @@ |
||
| 22 | 22 | interface Findable |
| 23 | 23 | { |
| 24 | 24 | |
| 25 | - /** |
|
| 26 | - * Check whether the Findable can handle an individual criterion. |
|
| 27 | - * |
|
| 28 | - * @since 0.1.0 |
|
| 29 | - * |
|
| 30 | - * @param mixed $criterion Criterion to check. |
|
| 31 | - * |
|
| 32 | - * @return bool Whether the Findable can handle the criterion. |
|
| 33 | - */ |
|
| 34 | - public function canHandle($criterion): bool; |
|
| 25 | + /** |
|
| 26 | + * Check whether the Findable can handle an individual criterion. |
|
| 27 | + * |
|
| 28 | + * @since 0.1.0 |
|
| 29 | + * |
|
| 30 | + * @param mixed $criterion Criterion to check. |
|
| 31 | + * |
|
| 32 | + * @return bool Whether the Findable can handle the criterion. |
|
| 33 | + */ |
|
| 34 | + public function canHandle($criterion): bool; |
|
| 35 | 35 | } |
@@ -22,23 +22,23 @@ |
||
| 22 | 22 | interface Finder |
| 23 | 23 | { |
| 24 | 24 | |
| 25 | - /** |
|
| 26 | - * Find a result based on a specific criteria. |
|
| 27 | - * |
|
| 28 | - * @since 0.1.0 |
|
| 29 | - * |
|
| 30 | - * @param array $criteria Criteria to search for. |
|
| 31 | - * |
|
| 32 | - * @return mixed Result of the search. |
|
| 33 | - */ |
|
| 34 | - public function find(array $criteria); |
|
| 25 | + /** |
|
| 26 | + * Find a result based on a specific criteria. |
|
| 27 | + * |
|
| 28 | + * @since 0.1.0 |
|
| 29 | + * |
|
| 30 | + * @param array $criteria Criteria to search for. |
|
| 31 | + * |
|
| 32 | + * @return mixed Result of the search. |
|
| 33 | + */ |
|
| 34 | + public function find(array $criteria); |
|
| 35 | 35 | |
| 36 | - /** |
|
| 37 | - * Get the NullObject. |
|
| 38 | - * |
|
| 39 | - * @since 0.1.1 |
|
| 40 | - * |
|
| 41 | - * @return NullFindable NullObject for the current Finder. |
|
| 42 | - */ |
|
| 43 | - public function getNullObject(): NullFindable; |
|
| 36 | + /** |
|
| 37 | + * Get the NullObject. |
|
| 38 | + * |
|
| 39 | + * @since 0.1.1 |
|
| 40 | + * |
|
| 41 | + * @return NullFindable NullObject for the current Finder. |
|
| 42 | + */ |
|
| 43 | + public function getNullObject(): NullFindable; |
|
| 44 | 44 | } |