@@ -28,104 +28,104 @@ |
||
| 28 | 28 | class View |
| 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 LocationInterface $location Location to add. |
|
| 46 | - */ |
|
| 47 | - public static function addLocation(LocationInterface $location) |
|
| 48 | - { |
|
| 49 | - $viewBuilder = static::getViewBuilder(); |
|
| 50 | - $viewBuilder->addLocation($location); |
|
| 51 | - } |
|
| 40 | + /** |
|
| 41 | + * Add a location to the ViewBuilder. |
|
| 42 | + * |
|
| 43 | + * @since 0.1.0 |
|
| 44 | + * |
|
| 45 | + * @param LocationInterface $location Location to add. |
|
| 46 | + */ |
|
| 47 | + public static function addLocation(LocationInterface $location) |
|
| 48 | + { |
|
| 49 | + $viewBuilder = static::getViewBuilder(); |
|
| 50 | + $viewBuilder->addLocation($location); |
|
| 51 | + } |
|
| 52 | 52 | |
| 53 | - /** |
|
| 54 | - * Get the ViewBuilder instance. |
|
| 55 | - * |
|
| 56 | - * @since 0.1.0 |
|
| 57 | - * |
|
| 58 | - * @return ViewBuilder |
|
| 59 | - */ |
|
| 60 | - public static function getViewBuilder() |
|
| 61 | - { |
|
| 62 | - if (null === static::$viewBuilder) { |
|
| 63 | - static::$viewBuilder = static::instantiateViewBuilder(); |
|
| 64 | - } |
|
| 53 | + /** |
|
| 54 | + * Get the ViewBuilder instance. |
|
| 55 | + * |
|
| 56 | + * @since 0.1.0 |
|
| 57 | + * |
|
| 58 | + * @return ViewBuilder |
|
| 59 | + */ |
|
| 60 | + public static function getViewBuilder() |
|
| 61 | + { |
|
| 62 | + if (null === static::$viewBuilder) { |
|
| 63 | + static::$viewBuilder = static::instantiateViewBuilder(); |
|
| 64 | + } |
|
| 65 | 65 | |
| 66 | - return static::$viewBuilder; |
|
| 67 | - } |
|
| 66 | + return static::$viewBuilder; |
|
| 67 | + } |
|
| 68 | 68 | |
| 69 | - /** |
|
| 70 | - * Instantiate the ViewBuilder. |
|
| 71 | - * |
|
| 72 | - * @since 0.1.0 |
|
| 73 | - * |
|
| 74 | - * @param ConfigInterface|null $config Optional. Configuration to pass into the ViewBuilder. |
|
| 75 | - * |
|
| 76 | - * @return ViewBuilder Instance of the ViewBuilder. |
|
| 77 | - */ |
|
| 78 | - public static function instantiateViewBuilder(ConfigInterface $config = null) |
|
| 79 | - { |
|
| 80 | - return static::$viewBuilder = new ViewBuilder($config ?: static::getDefaultConfig()); |
|
| 81 | - } |
|
| 69 | + /** |
|
| 70 | + * Instantiate the ViewBuilder. |
|
| 71 | + * |
|
| 72 | + * @since 0.1.0 |
|
| 73 | + * |
|
| 74 | + * @param ConfigInterface|null $config Optional. Configuration to pass into the ViewBuilder. |
|
| 75 | + * |
|
| 76 | + * @return ViewBuilder Instance of the ViewBuilder. |
|
| 77 | + */ |
|
| 78 | + public static function instantiateViewBuilder(ConfigInterface $config = null) |
|
| 79 | + { |
|
| 80 | + return static::$viewBuilder = new ViewBuilder($config ?: static::getDefaultConfig()); |
|
| 81 | + } |
|
| 82 | 82 | |
| 83 | - /** |
|
| 84 | - * Get the default configuration to inject into the ViewBuilder. |
|
| 85 | - * |
|
| 86 | - * @since 0.1.0 |
|
| 87 | - * |
|
| 88 | - * @return ConfigInterface Default configuration. |
|
| 89 | - */ |
|
| 90 | - public static function getDefaultConfig() |
|
| 91 | - { |
|
| 92 | - return ConfigFactory::create(__DIR__ . '/../config/defaults.php') |
|
| 93 | - ->getSubConfig('BrightNucleus\View'); |
|
| 94 | - } |
|
| 83 | + /** |
|
| 84 | + * Get the default configuration to inject into the ViewBuilder. |
|
| 85 | + * |
|
| 86 | + * @since 0.1.0 |
|
| 87 | + * |
|
| 88 | + * @return ConfigInterface Default configuration. |
|
| 89 | + */ |
|
| 90 | + public static function getDefaultConfig() |
|
| 91 | + { |
|
| 92 | + return ConfigFactory::create(__DIR__ . '/../config/defaults.php') |
|
| 93 | + ->getSubConfig('BrightNucleus\View'); |
|
| 94 | + } |
|
| 95 | 95 | |
| 96 | - /** |
|
| 97 | - * Create a new view for a given URI. |
|
| 98 | - * |
|
| 99 | - * @since 0.1.0 |
|
| 100 | - * |
|
| 101 | - * @param string $view View identifier to create a view for. |
|
| 102 | - * @param string|null $type Type of view to create. |
|
| 103 | - * |
|
| 104 | - * @return ViewInterface Instance of the requested view. |
|
| 105 | - */ |
|
| 106 | - public static function create($view, $type = null) |
|
| 107 | - { |
|
| 108 | - $viewBuilder = static::getViewBuilder(); |
|
| 96 | + /** |
|
| 97 | + * Create a new view for a given URI. |
|
| 98 | + * |
|
| 99 | + * @since 0.1.0 |
|
| 100 | + * |
|
| 101 | + * @param string $view View identifier to create a view for. |
|
| 102 | + * @param string|null $type Type of view to create. |
|
| 103 | + * |
|
| 104 | + * @return ViewInterface Instance of the requested view. |
|
| 105 | + */ |
|
| 106 | + public static function create($view, $type = null) |
|
| 107 | + { |
|
| 108 | + $viewBuilder = static::getViewBuilder(); |
|
| 109 | 109 | |
| 110 | - return $viewBuilder->create($view, $type); |
|
| 111 | - } |
|
| 110 | + return $viewBuilder->create($view, $type); |
|
| 111 | + } |
|
| 112 | 112 | |
| 113 | - /** |
|
| 114 | - * Render a view for a given URI. |
|
| 115 | - * |
|
| 116 | - * @since 0.1.0 |
|
| 117 | - * |
|
| 118 | - * @param string $view View identifier to create a view for. |
|
| 119 | - * @param array $context Optional. The context in which to render the view. |
|
| 120 | - * @param string|null $type Type of view to create. |
|
| 121 | - * |
|
| 122 | - * @return string Rendered HTML content. |
|
| 123 | - */ |
|
| 124 | - public static function render($view, array $context = [], $type = null) |
|
| 125 | - { |
|
| 126 | - $viewBuilder = static::getViewBuilder(); |
|
| 127 | - $viewObject = $viewBuilder->create($view, $type); |
|
| 113 | + /** |
|
| 114 | + * Render a view for a given URI. |
|
| 115 | + * |
|
| 116 | + * @since 0.1.0 |
|
| 117 | + * |
|
| 118 | + * @param string $view View identifier to create a view for. |
|
| 119 | + * @param array $context Optional. The context in which to render the view. |
|
| 120 | + * @param string|null $type Type of view to create. |
|
| 121 | + * |
|
| 122 | + * @return string Rendered HTML content. |
|
| 123 | + */ |
|
| 124 | + public static function render($view, array $context = [], $type = null) |
|
| 125 | + { |
|
| 126 | + $viewBuilder = static::getViewBuilder(); |
|
| 127 | + $viewObject = $viewBuilder->create($view, $type); |
|
| 128 | 128 | |
| 129 | - return $viewObject->render($context); |
|
| 130 | - } |
|
| 129 | + return $viewObject->render($context); |
|
| 130 | + } |
|
| 131 | 131 | } |
@@ -22,23 +22,23 @@ |
||
| 22 | 22 | interface FinderInterface |
| 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 NullObject NullObject for the current Finder. |
|
| 42 | - */ |
|
| 43 | - public function getNullObject(); |
|
| 36 | + /** |
|
| 37 | + * Get the NullObject. |
|
| 38 | + * |
|
| 39 | + * @since 0.1.1 |
|
| 40 | + * |
|
| 41 | + * @return NullObject NullObject for the current Finder. |
|
| 42 | + */ |
|
| 43 | + public function getNullObject(); |
|
| 44 | 44 | } |
@@ -25,84 +25,84 @@ |
||
| 25 | 25 | class EngineFinder extends AbstractFinder |
| 26 | 26 | { |
| 27 | 27 | |
| 28 | - /** |
|
| 29 | - * Find a result based on a specific criteria. |
|
| 30 | - * |
|
| 31 | - * @since 0.1.0 |
|
| 32 | - * |
|
| 33 | - * @param array $criteria Criteria to search for. |
|
| 34 | - * |
|
| 35 | - * @return EngineInterface Result of the search. |
|
| 36 | - */ |
|
| 37 | - public function find(array $criteria) |
|
| 38 | - { |
|
| 39 | - $this->initializeEngines(); |
|
| 28 | + /** |
|
| 29 | + * Find a result based on a specific criteria. |
|
| 30 | + * |
|
| 31 | + * @since 0.1.0 |
|
| 32 | + * |
|
| 33 | + * @param array $criteria Criteria to search for. |
|
| 34 | + * |
|
| 35 | + * @return EngineInterface Result of the search. |
|
| 36 | + */ |
|
| 37 | + public function find(array $criteria) |
|
| 38 | + { |
|
| 39 | + $this->initializeEngines(); |
|
| 40 | 40 | |
| 41 | - foreach ($criteria as $entry) { |
|
| 42 | - foreach ($this->findables as $engine) { |
|
| 43 | - if ($engine->canHandle($entry)) { |
|
| 44 | - return $engine; |
|
| 45 | - } |
|
| 46 | - } |
|
| 47 | - } |
|
| 41 | + foreach ($criteria as $entry) { |
|
| 42 | + foreach ($this->findables as $engine) { |
|
| 43 | + if ($engine->canHandle($entry)) { |
|
| 44 | + return $engine; |
|
| 45 | + } |
|
| 46 | + } |
|
| 47 | + } |
|
| 48 | 48 | |
| 49 | - return $this->getNullObject(); |
|
| 50 | - } |
|
| 49 | + return $this->getNullObject(); |
|
| 50 | + } |
|
| 51 | 51 | |
| 52 | - /** |
|
| 53 | - * Initialize the engines that can be iterated. |
|
| 54 | - * |
|
| 55 | - * @since 0.1.0 |
|
| 56 | - * |
|
| 57 | - */ |
|
| 58 | - protected function initializeEngines() |
|
| 59 | - { |
|
| 60 | - foreach ($this->findables as &$engine) { |
|
| 61 | - $engine = $this->initializeEngine($engine); |
|
| 62 | - } |
|
| 63 | - } |
|
| 52 | + /** |
|
| 53 | + * Initialize the engines that can be iterated. |
|
| 54 | + * |
|
| 55 | + * @since 0.1.0 |
|
| 56 | + * |
|
| 57 | + */ |
|
| 58 | + protected function initializeEngines() |
|
| 59 | + { |
|
| 60 | + foreach ($this->findables as &$engine) { |
|
| 61 | + $engine = $this->initializeEngine($engine); |
|
| 62 | + } |
|
| 63 | + } |
|
| 64 | 64 | |
| 65 | - /** |
|
| 66 | - * Initialize a single engine by instantiating class name strings and calling closures. |
|
| 67 | - * |
|
| 68 | - * @since 0.1.0 |
|
| 69 | - * |
|
| 70 | - * @param mixed $engine Engine to instantiate. |
|
| 71 | - * |
|
| 72 | - * @return EngineInterface Instantiated engine. |
|
| 73 | - * @throws FailedToInstantiateEngineException If the engine could not be instantiated. |
|
| 74 | - */ |
|
| 75 | - protected function initializeEngine($engine) |
|
| 76 | - { |
|
| 77 | - if (is_string($engine)) { |
|
| 78 | - $engine = new $engine(); |
|
| 79 | - } |
|
| 65 | + /** |
|
| 66 | + * Initialize a single engine by instantiating class name strings and calling closures. |
|
| 67 | + * |
|
| 68 | + * @since 0.1.0 |
|
| 69 | + * |
|
| 70 | + * @param mixed $engine Engine to instantiate. |
|
| 71 | + * |
|
| 72 | + * @return EngineInterface Instantiated engine. |
|
| 73 | + * @throws FailedToInstantiateEngineException If the engine could not be instantiated. |
|
| 74 | + */ |
|
| 75 | + protected function initializeEngine($engine) |
|
| 76 | + { |
|
| 77 | + if (is_string($engine)) { |
|
| 78 | + $engine = new $engine(); |
|
| 79 | + } |
|
| 80 | 80 | |
| 81 | - if (is_callable($engine)) { |
|
| 82 | - $engine = $engine(); |
|
| 83 | - } |
|
| 81 | + if (is_callable($engine)) { |
|
| 82 | + $engine = $engine(); |
|
| 83 | + } |
|
| 84 | 84 | |
| 85 | - if (! $engine instanceof EngineInterface) { |
|
| 86 | - throw new FailedToInstantiateEngineException( |
|
| 87 | - sprintf( |
|
| 88 | - _('Could not instantiate engine "%s".'), |
|
| 89 | - serialize($engine) |
|
| 90 | - ) |
|
| 91 | - ); |
|
| 92 | - } |
|
| 85 | + if (! $engine instanceof EngineInterface) { |
|
| 86 | + throw new FailedToInstantiateEngineException( |
|
| 87 | + sprintf( |
|
| 88 | + _('Could not instantiate engine "%s".'), |
|
| 89 | + serialize($engine) |
|
| 90 | + ) |
|
| 91 | + ); |
|
| 92 | + } |
|
| 93 | 93 | |
| 94 | - return $engine; |
|
| 95 | - } |
|
| 94 | + return $engine; |
|
| 95 | + } |
|
| 96 | 96 | |
| 97 | - /** |
|
| 98 | - * Get the config key for the Findables definitions. |
|
| 99 | - * |
|
| 100 | - * @since 0.1.0 |
|
| 101 | - * |
|
| 102 | - * @return string Config key use to define the Findables. |
|
| 103 | - */ |
|
| 104 | - protected function getFindablesConfigKey() |
|
| 105 | - { |
|
| 106 | - return 'Engines'; |
|
| 107 | - } |
|
| 97 | + /** |
|
| 98 | + * Get the config key for the Findables definitions. |
|
| 99 | + * |
|
| 100 | + * @since 0.1.0 |
|
| 101 | + * |
|
| 102 | + * @return string Config key use to define the Findables. |
|
| 103 | + */ |
|
| 104 | + protected function getFindablesConfigKey() |
|
| 105 | + { |
|
| 106 | + return 'Engines'; |
|
| 107 | + } |
|
| 108 | 108 | } |
@@ -26,128 +26,128 @@ |
||
| 26 | 26 | abstract class AbstractFinder implements FinderInterface |
| 27 | 27 | { |
| 28 | 28 | |
| 29 | - use ConfigTrait; |
|
| 29 | + use ConfigTrait; |
|
| 30 | 30 | |
| 31 | - /** |
|
| 32 | - * Array of Findables that the Finder can iterate through to find a match. |
|
| 33 | - * |
|
| 34 | - * @since 0.1.0 |
|
| 35 | - * |
|
| 36 | - * @var Findable[] |
|
| 37 | - */ |
|
| 38 | - protected $findables; |
|
| 31 | + /** |
|
| 32 | + * Array of Findables that the Finder can iterate through to find a match. |
|
| 33 | + * |
|
| 34 | + * @since 0.1.0 |
|
| 35 | + * |
|
| 36 | + * @var Findable[] |
|
| 37 | + */ |
|
| 38 | + protected $findables; |
|
| 39 | 39 | |
| 40 | - /** |
|
| 41 | - * NullObject that is returned if the Finder could not find a match. |
|
| 42 | - * |
|
| 43 | - * @since 0.1.0 |
|
| 44 | - * |
|
| 45 | - * @var NullObject |
|
| 46 | - */ |
|
| 47 | - protected $nullObject; |
|
| 40 | + /** |
|
| 41 | + * NullObject that is returned if the Finder could not find a match. |
|
| 42 | + * |
|
| 43 | + * @since 0.1.0 |
|
| 44 | + * |
|
| 45 | + * @var NullObject |
|
| 46 | + */ |
|
| 47 | + protected $nullObject; |
|
| 48 | 48 | |
| 49 | - /** |
|
| 50 | - * Instantiate an AbstractFinder object. |
|
| 51 | - * |
|
| 52 | - * @since 0.1.0 |
|
| 53 | - * |
|
| 54 | - * @param ConfigInterface $config Configuration of the EngineFinder. |
|
| 55 | - * |
|
| 56 | - * @throws FailedToProcessConfigException If the config could not be processed. |
|
| 57 | - */ |
|
| 58 | - public function __construct(ConfigInterface $config) |
|
| 59 | - { |
|
| 60 | - $this->processConfig($config); |
|
| 61 | - $this->registerFindables($this->config); |
|
| 62 | - $this->registerNullObject($this->config); |
|
| 63 | - } |
|
| 49 | + /** |
|
| 50 | + * Instantiate an AbstractFinder object. |
|
| 51 | + * |
|
| 52 | + * @since 0.1.0 |
|
| 53 | + * |
|
| 54 | + * @param ConfigInterface $config Configuration of the EngineFinder. |
|
| 55 | + * |
|
| 56 | + * @throws FailedToProcessConfigException If the config could not be processed. |
|
| 57 | + */ |
|
| 58 | + public function __construct(ConfigInterface $config) |
|
| 59 | + { |
|
| 60 | + $this->processConfig($config); |
|
| 61 | + $this->registerFindables($this->config); |
|
| 62 | + $this->registerNullObject($this->config); |
|
| 63 | + } |
|
| 64 | 64 | |
| 65 | - /** |
|
| 66 | - * Register the Findables defined in the given configuration. |
|
| 67 | - * |
|
| 68 | - * @since 0.1.0 |
|
| 69 | - * |
|
| 70 | - * @param ConfigInterface $config Configuration to register the Findables from. |
|
| 71 | - */ |
|
| 72 | - public function registerFindables(ConfigInterface $config) |
|
| 73 | - { |
|
| 74 | - foreach ($config->getKey($this->getFindablesConfigKey()) as $findableKey => $findableObject) { |
|
| 75 | - $this->registerFindable($findableKey, $findableObject); |
|
| 76 | - } |
|
| 77 | - } |
|
| 65 | + /** |
|
| 66 | + * Register the Findables defined in the given configuration. |
|
| 67 | + * |
|
| 68 | + * @since 0.1.0 |
|
| 69 | + * |
|
| 70 | + * @param ConfigInterface $config Configuration to register the Findables from. |
|
| 71 | + */ |
|
| 72 | + public function registerFindables(ConfigInterface $config) |
|
| 73 | + { |
|
| 74 | + foreach ($config->getKey($this->getFindablesConfigKey()) as $findableKey => $findableObject) { |
|
| 75 | + $this->registerFindable($findableKey, $findableObject); |
|
| 76 | + } |
|
| 77 | + } |
|
| 78 | 78 | |
| 79 | - /** |
|
| 80 | - * Register the NullObject defined in the given configuration. |
|
| 81 | - * |
|
| 82 | - * @since 0.1.0 |
|
| 83 | - * |
|
| 84 | - * @param ConfigInterface $config Configuration to register the NullObject from. |
|
| 85 | - */ |
|
| 86 | - public function registerNullObject(ConfigInterface $config) |
|
| 87 | - { |
|
| 88 | - $this->nullObject = $config->getKey($this->getNullObjectConfigKey()); |
|
| 89 | - } |
|
| 79 | + /** |
|
| 80 | + * Register the NullObject defined in the given configuration. |
|
| 81 | + * |
|
| 82 | + * @since 0.1.0 |
|
| 83 | + * |
|
| 84 | + * @param ConfigInterface $config Configuration to register the NullObject from. |
|
| 85 | + */ |
|
| 86 | + public function registerNullObject(ConfigInterface $config) |
|
| 87 | + { |
|
| 88 | + $this->nullObject = $config->getKey($this->getNullObjectConfigKey()); |
|
| 89 | + } |
|
| 90 | 90 | |
| 91 | - /** |
|
| 92 | - * Get the NullObject. |
|
| 93 | - * |
|
| 94 | - * @since 0.1.1 |
|
| 95 | - * |
|
| 96 | - * @return NullObject NullObject for the current Finder. |
|
| 97 | - */ |
|
| 98 | - public function getNullObject() |
|
| 99 | - { |
|
| 100 | - $this->initializeNullObject(); |
|
| 91 | + /** |
|
| 92 | + * Get the NullObject. |
|
| 93 | + * |
|
| 94 | + * @since 0.1.1 |
|
| 95 | + * |
|
| 96 | + * @return NullObject NullObject for the current Finder. |
|
| 97 | + */ |
|
| 98 | + public function getNullObject() |
|
| 99 | + { |
|
| 100 | + $this->initializeNullObject(); |
|
| 101 | 101 | |
| 102 | - return $this->nullObject; |
|
| 103 | - } |
|
| 102 | + return $this->nullObject; |
|
| 103 | + } |
|
| 104 | 104 | |
| 105 | - /** |
|
| 106 | - * Register a single Findable. |
|
| 107 | - * |
|
| 108 | - * @since 0.1.0 |
|
| 109 | - * |
|
| 110 | - * @param string $key Key used to reference the Findable. |
|
| 111 | - * @param mixed $findable Findable as a FQCN, callable or object. |
|
| 112 | - */ |
|
| 113 | - protected function registerFindable($key, $findable) |
|
| 114 | - { |
|
| 115 | - $this->findables[$key] = $findable; |
|
| 116 | - } |
|
| 105 | + /** |
|
| 106 | + * Register a single Findable. |
|
| 107 | + * |
|
| 108 | + * @since 0.1.0 |
|
| 109 | + * |
|
| 110 | + * @param string $key Key used to reference the Findable. |
|
| 111 | + * @param mixed $findable Findable as a FQCN, callable or object. |
|
| 112 | + */ |
|
| 113 | + protected function registerFindable($key, $findable) |
|
| 114 | + { |
|
| 115 | + $this->findables[$key] = $findable; |
|
| 116 | + } |
|
| 117 | 117 | |
| 118 | - /** |
|
| 119 | - * Get the config key for the Findables definitions. |
|
| 120 | - * |
|
| 121 | - * @since 0.1.0 |
|
| 122 | - * |
|
| 123 | - * @return string Config key use to define the Findables. |
|
| 124 | - */ |
|
| 125 | - protected function getFindablesConfigKey() |
|
| 126 | - { |
|
| 127 | - return 'Findables'; |
|
| 128 | - } |
|
| 118 | + /** |
|
| 119 | + * Get the config key for the Findables definitions. |
|
| 120 | + * |
|
| 121 | + * @since 0.1.0 |
|
| 122 | + * |
|
| 123 | + * @return string Config key use to define the Findables. |
|
| 124 | + */ |
|
| 125 | + protected function getFindablesConfigKey() |
|
| 126 | + { |
|
| 127 | + return 'Findables'; |
|
| 128 | + } |
|
| 129 | 129 | |
| 130 | - /** |
|
| 131 | - * Get the config key for the NullObject definitions. |
|
| 132 | - * |
|
| 133 | - * @since 0.1.0 |
|
| 134 | - * |
|
| 135 | - * @return string Config key use to define the NullObject. |
|
| 136 | - */ |
|
| 137 | - protected function getNullObjectConfigKey() |
|
| 138 | - { |
|
| 139 | - return 'NullObject'; |
|
| 140 | - } |
|
| 130 | + /** |
|
| 131 | + * Get the config key for the NullObject definitions. |
|
| 132 | + * |
|
| 133 | + * @since 0.1.0 |
|
| 134 | + * |
|
| 135 | + * @return string Config key use to define the NullObject. |
|
| 136 | + */ |
|
| 137 | + protected function getNullObjectConfigKey() |
|
| 138 | + { |
|
| 139 | + return 'NullObject'; |
|
| 140 | + } |
|
| 141 | 141 | |
| 142 | - /** |
|
| 143 | - * Initialize the NullObject. |
|
| 144 | - * |
|
| 145 | - * @since 0.1.1 |
|
| 146 | - */ |
|
| 147 | - protected function initializeNullObject() |
|
| 148 | - { |
|
| 149 | - if (! is_object($this->nullObject)) { |
|
| 150 | - $this->nullObject = new $this->nullObject(); |
|
| 151 | - } |
|
| 152 | - } |
|
| 142 | + /** |
|
| 143 | + * Initialize the NullObject. |
|
| 144 | + * |
|
| 145 | + * @since 0.1.1 |
|
| 146 | + */ |
|
| 147 | + protected function initializeNullObject() |
|
| 148 | + { |
|
| 149 | + if (! is_object($this->nullObject)) { |
|
| 150 | + $this->nullObject = new $this->nullObject(); |
|
| 151 | + } |
|
| 152 | + } |
|
| 153 | 153 | } |
@@ -24,86 +24,86 @@ |
||
| 24 | 24 | class FilesystemLocation implements LocationInterface |
| 25 | 25 | { |
| 26 | 26 | |
| 27 | - /** |
|
| 28 | - * Path that this location points to. |
|
| 29 | - * |
|
| 30 | - * @since 0.1.0 |
|
| 31 | - * |
|
| 32 | - * @var string |
|
| 33 | - */ |
|
| 34 | - protected $path; |
|
| 27 | + /** |
|
| 28 | + * Path that this location points to. |
|
| 29 | + * |
|
| 30 | + * @since 0.1.0 |
|
| 31 | + * |
|
| 32 | + * @var string |
|
| 33 | + */ |
|
| 34 | + protected $path; |
|
| 35 | 35 | |
| 36 | - /** |
|
| 37 | - * Extensions that this location can accept. |
|
| 38 | - * |
|
| 39 | - * @since 0.1.0 |
|
| 40 | - * |
|
| 41 | - * @var array |
|
| 42 | - */ |
|
| 43 | - protected $extensions; |
|
| 36 | + /** |
|
| 37 | + * Extensions that this location can accept. |
|
| 38 | + * |
|
| 39 | + * @since 0.1.0 |
|
| 40 | + * |
|
| 41 | + * @var array |
|
| 42 | + */ |
|
| 43 | + protected $extensions; |
|
| 44 | 44 | |
| 45 | - /** |
|
| 46 | - * Instantiate a FilesystemLocation object. |
|
| 47 | - * |
|
| 48 | - * @since 0.1.0 |
|
| 49 | - * |
|
| 50 | - * @param string $path Path that this location points to. |
|
| 51 | - * @param array $extensions Array of extensions that this location can accept. |
|
| 52 | - */ |
|
| 53 | - public function __construct($path, array $extensions = []) |
|
| 54 | - { |
|
| 55 | - $this->path = $path; |
|
| 56 | - $this->extensions = array_merge($extensions, ['']); |
|
| 57 | - } |
|
| 45 | + /** |
|
| 46 | + * Instantiate a FilesystemLocation object. |
|
| 47 | + * |
|
| 48 | + * @since 0.1.0 |
|
| 49 | + * |
|
| 50 | + * @param string $path Path that this location points to. |
|
| 51 | + * @param array $extensions Array of extensions that this location can accept. |
|
| 52 | + */ |
|
| 53 | + public function __construct($path, array $extensions = []) |
|
| 54 | + { |
|
| 55 | + $this->path = $path; |
|
| 56 | + $this->extensions = array_merge($extensions, ['']); |
|
| 57 | + } |
|
| 58 | 58 | |
| 59 | - /** |
|
| 60 | - * Get an URI that matches the given criteria. |
|
| 61 | - * |
|
| 62 | - * @since 0.1.0 |
|
| 63 | - * |
|
| 64 | - * @param array $criteria Criteria to match. |
|
| 65 | - * |
|
| 66 | - * @return string|false URI that matches the criteria or false if none found. |
|
| 67 | - */ |
|
| 68 | - public function getURI(array $criteria) |
|
| 69 | - { |
|
| 70 | - foreach ($criteria as $entry) { |
|
| 71 | - if ($uri = $this->transform($entry)) { |
|
| 72 | - return $uri; |
|
| 73 | - } |
|
| 74 | - } |
|
| 59 | + /** |
|
| 60 | + * Get an URI that matches the given criteria. |
|
| 61 | + * |
|
| 62 | + * @since 0.1.0 |
|
| 63 | + * |
|
| 64 | + * @param array $criteria Criteria to match. |
|
| 65 | + * |
|
| 66 | + * @return string|false URI that matches the criteria or false if none found. |
|
| 67 | + */ |
|
| 68 | + public function getURI(array $criteria) |
|
| 69 | + { |
|
| 70 | + foreach ($criteria as $entry) { |
|
| 71 | + if ($uri = $this->transform($entry)) { |
|
| 72 | + return $uri; |
|
| 73 | + } |
|
| 74 | + } |
|
| 75 | 75 | |
| 76 | - return false; |
|
| 77 | - } |
|
| 76 | + return false; |
|
| 77 | + } |
|
| 78 | 78 | |
| 79 | - /** |
|
| 80 | - * Try to transform the entry into possible URIs. |
|
| 81 | - * |
|
| 82 | - * @since 0.1.0 |
|
| 83 | - * |
|
| 84 | - * @param string $entry Entry to transform. |
|
| 85 | - * |
|
| 86 | - * @return string|false URI of the view, or false if none found. |
|
| 87 | - */ |
|
| 88 | - protected function transform($entry) |
|
| 89 | - { |
|
| 90 | - try { |
|
| 91 | - foreach ($this->extensions as $extension) { |
|
| 79 | + /** |
|
| 80 | + * Try to transform the entry into possible URIs. |
|
| 81 | + * |
|
| 82 | + * @since 0.1.0 |
|
| 83 | + * |
|
| 84 | + * @param string $entry Entry to transform. |
|
| 85 | + * |
|
| 86 | + * @return string|false URI of the view, or false if none found. |
|
| 87 | + */ |
|
| 88 | + protected function transform($entry) |
|
| 89 | + { |
|
| 90 | + try { |
|
| 91 | + foreach ($this->extensions as $extension) { |
|
| 92 | 92 | |
| 93 | - $uri = $entry . $extension; |
|
| 94 | - if (is_readable($uri)) { |
|
| 95 | - return $uri; |
|
| 96 | - } |
|
| 93 | + $uri = $entry . $extension; |
|
| 94 | + if (is_readable($uri)) { |
|
| 95 | + return $uri; |
|
| 96 | + } |
|
| 97 | 97 | |
| 98 | - $uri = $this->path . DIRECTORY_SEPARATOR . $uri; |
|
| 99 | - if (is_readable($uri)) { |
|
| 100 | - return $uri; |
|
| 101 | - } |
|
| 102 | - } |
|
| 103 | - } catch (Exception $exception) { |
|
| 104 | - // Fail silently. |
|
| 105 | - } |
|
| 98 | + $uri = $this->path . DIRECTORY_SEPARATOR . $uri; |
|
| 99 | + if (is_readable($uri)) { |
|
| 100 | + return $uri; |
|
| 101 | + } |
|
| 102 | + } |
|
| 103 | + } catch (Exception $exception) { |
|
| 104 | + // Fail silently. |
|
| 105 | + } |
|
| 106 | 106 | |
| 107 | - return false; |
|
| 108 | - } |
|
| 107 | + return false; |
|
| 108 | + } |
|
| 109 | 109 | } |
@@ -26,91 +26,91 @@ |
||
| 26 | 26 | class ViewFinder extends AbstractFinder |
| 27 | 27 | { |
| 28 | 28 | |
| 29 | - /** |
|
| 30 | - * Find a result based on a specific criteria. |
|
| 31 | - * |
|
| 32 | - * @since 0.1.0 |
|
| 33 | - * |
|
| 34 | - * @param array $criteria Criteria to search for. |
|
| 35 | - * @param EngineInterface|null $engine Optional. Engine to use with the view. |
|
| 36 | - * |
|
| 37 | - * @return ViewInterface View that was found. |
|
| 38 | - */ |
|
| 39 | - public function find(array $criteria, EngineInterface $engine = null) |
|
| 40 | - { |
|
| 41 | - $uri = $criteria[0]; |
|
| 29 | + /** |
|
| 30 | + * Find a result based on a specific criteria. |
|
| 31 | + * |
|
| 32 | + * @since 0.1.0 |
|
| 33 | + * |
|
| 34 | + * @param array $criteria Criteria to search for. |
|
| 35 | + * @param EngineInterface|null $engine Optional. Engine to use with the view. |
|
| 36 | + * |
|
| 37 | + * @return ViewInterface View that was found. |
|
| 38 | + */ |
|
| 39 | + public function find(array $criteria, EngineInterface $engine = null) |
|
| 40 | + { |
|
| 41 | + $uri = $criteria[0]; |
|
| 42 | 42 | |
| 43 | - $this->initializeViews($uri, $engine); |
|
| 43 | + $this->initializeViews($uri, $engine); |
|
| 44 | 44 | |
| 45 | - foreach ($criteria as $entry) { |
|
| 46 | - foreach ($this->findables as $viewObject) { |
|
| 47 | - if ($viewObject->canHandle($entry)) { |
|
| 48 | - return $viewObject; |
|
| 49 | - } |
|
| 50 | - } |
|
| 51 | - } |
|
| 45 | + foreach ($criteria as $entry) { |
|
| 46 | + foreach ($this->findables as $viewObject) { |
|
| 47 | + if ($viewObject->canHandle($entry)) { |
|
| 48 | + return $viewObject; |
|
| 49 | + } |
|
| 50 | + } |
|
| 51 | + } |
|
| 52 | 52 | |
| 53 | - return $this->getNullObject(); |
|
| 54 | - } |
|
| 53 | + return $this->getNullObject(); |
|
| 54 | + } |
|
| 55 | 55 | |
| 56 | - /** |
|
| 57 | - * Initialize the views that can be iterated. |
|
| 58 | - * |
|
| 59 | - * @since 0.1.0 |
|
| 60 | - * |
|
| 61 | - * @param string $uri URI to use for the view. |
|
| 62 | - * @param EngineInterface|null $engine Optional. Engine to use with the view. |
|
| 63 | - */ |
|
| 64 | - protected function initializeViews($uri, EngineInterface $engine = null) |
|
| 65 | - { |
|
| 66 | - foreach ($this->findables as &$view) { |
|
| 67 | - $view = $this->initializeView($view, $uri, $engine); |
|
| 68 | - } |
|
| 69 | - } |
|
| 56 | + /** |
|
| 57 | + * Initialize the views that can be iterated. |
|
| 58 | + * |
|
| 59 | + * @since 0.1.0 |
|
| 60 | + * |
|
| 61 | + * @param string $uri URI to use for the view. |
|
| 62 | + * @param EngineInterface|null $engine Optional. Engine to use with the view. |
|
| 63 | + */ |
|
| 64 | + protected function initializeViews($uri, EngineInterface $engine = null) |
|
| 65 | + { |
|
| 66 | + foreach ($this->findables as &$view) { |
|
| 67 | + $view = $this->initializeView($view, $uri, $engine); |
|
| 68 | + } |
|
| 69 | + } |
|
| 70 | 70 | |
| 71 | - /** |
|
| 72 | - * Initialize a single view by instantiating class name strings and calling closures. |
|
| 73 | - * |
|
| 74 | - * @since 0.1.0 |
|
| 75 | - * |
|
| 76 | - * @param mixed $view View to instantiate. |
|
| 77 | - * @param string $uri URI to use for the view. |
|
| 78 | - * @param EngineInterface|null $engine Optional. Engine to use with the view. |
|
| 79 | - * |
|
| 80 | - * @return ViewInterface Instantiated view. |
|
| 81 | - * @throws FailedToInstantiateViewException If the view could not be instantiated. |
|
| 82 | - */ |
|
| 83 | - protected function initializeView($view, $uri, EngineInterface $engine = null) |
|
| 84 | - { |
|
| 85 | - if (is_string($view)) { |
|
| 86 | - $view = new $view($uri, $engine); |
|
| 87 | - } |
|
| 71 | + /** |
|
| 72 | + * Initialize a single view by instantiating class name strings and calling closures. |
|
| 73 | + * |
|
| 74 | + * @since 0.1.0 |
|
| 75 | + * |
|
| 76 | + * @param mixed $view View to instantiate. |
|
| 77 | + * @param string $uri URI to use for the view. |
|
| 78 | + * @param EngineInterface|null $engine Optional. Engine to use with the view. |
|
| 79 | + * |
|
| 80 | + * @return ViewInterface Instantiated view. |
|
| 81 | + * @throws FailedToInstantiateViewException If the view could not be instantiated. |
|
| 82 | + */ |
|
| 83 | + protected function initializeView($view, $uri, EngineInterface $engine = null) |
|
| 84 | + { |
|
| 85 | + if (is_string($view)) { |
|
| 86 | + $view = new $view($uri, $engine); |
|
| 87 | + } |
|
| 88 | 88 | |
| 89 | - if (is_callable($view)) { |
|
| 90 | - $view = $view($uri, $engine); |
|
| 91 | - } |
|
| 89 | + if (is_callable($view)) { |
|
| 90 | + $view = $view($uri, $engine); |
|
| 91 | + } |
|
| 92 | 92 | |
| 93 | - if (! $view instanceof ViewInterface) { |
|
| 94 | - throw new FailedToInstantiateViewException( |
|
| 95 | - sprintf( |
|
| 96 | - _('Could not instantiate view "%s".'), |
|
| 97 | - serialize($view) |
|
| 98 | - ) |
|
| 99 | - ); |
|
| 100 | - } |
|
| 93 | + if (! $view instanceof ViewInterface) { |
|
| 94 | + throw new FailedToInstantiateViewException( |
|
| 95 | + sprintf( |
|
| 96 | + _('Could not instantiate view "%s".'), |
|
| 97 | + serialize($view) |
|
| 98 | + ) |
|
| 99 | + ); |
|
| 100 | + } |
|
| 101 | 101 | |
| 102 | - return $view; |
|
| 103 | - } |
|
| 102 | + return $view; |
|
| 103 | + } |
|
| 104 | 104 | |
| 105 | - /** |
|
| 106 | - * Get the config key for the Findables definitions. |
|
| 107 | - * |
|
| 108 | - * @since 0.1.0 |
|
| 109 | - * |
|
| 110 | - * @return string Config key use to define the Findables. |
|
| 111 | - */ |
|
| 112 | - protected function getFindablesConfigKey() |
|
| 113 | - { |
|
| 114 | - return 'Views'; |
|
| 115 | - } |
|
| 105 | + /** |
|
| 106 | + * Get the config key for the Findables definitions. |
|
| 107 | + * |
|
| 108 | + * @since 0.1.0 |
|
| 109 | + * |
|
| 110 | + * @return string Config key use to define the Findables. |
|
| 111 | + */ |
|
| 112 | + protected function getFindablesConfigKey() |
|
| 113 | + { |
|
| 114 | + return 'Views'; |
|
| 115 | + } |
|
| 116 | 116 | } |
@@ -24,20 +24,20 @@ |
||
| 24 | 24 | class NullView implements ViewInterface, NullObject |
| 25 | 25 | { |
| 26 | 26 | |
| 27 | - /** |
|
| 28 | - * Render the view. |
|
| 29 | - * |
|
| 30 | - * @since 0.1.0 |
|
| 31 | - * |
|
| 32 | - * @param array $context Optional. The context in which to render the view. |
|
| 33 | - * @param bool $echo Optional. Whether to echo the output immediately. Defaults to false. |
|
| 34 | - * |
|
| 35 | - * @return string|void Rendered HTML or nothing, depending on $echo argument. |
|
| 36 | - */ |
|
| 37 | - public function render(array $context = [], $echo = false) |
|
| 38 | - { |
|
| 39 | - if (! $echo) { |
|
| 40 | - return ''; |
|
| 41 | - } |
|
| 42 | - } |
|
| 27 | + /** |
|
| 28 | + * Render the view. |
|
| 29 | + * |
|
| 30 | + * @since 0.1.0 |
|
| 31 | + * |
|
| 32 | + * @param array $context Optional. The context in which to render the view. |
|
| 33 | + * @param bool $echo Optional. Whether to echo the output immediately. Defaults to false. |
|
| 34 | + * |
|
| 35 | + * @return string|void Rendered HTML or nothing, depending on $echo argument. |
|
| 36 | + */ |
|
| 37 | + public function render(array $context = [], $echo = false) |
|
| 38 | + { |
|
| 39 | + if (! $echo) { |
|
| 40 | + return ''; |
|
| 41 | + } |
|
| 42 | + } |
|
| 43 | 43 | } |
@@ -25,15 +25,15 @@ |
||
| 25 | 25 | interface ViewFinderInterface extends FinderInterface |
| 26 | 26 | { |
| 27 | 27 | |
| 28 | - /** |
|
| 29 | - * Find a result based on a specific criteria. |
|
| 30 | - * |
|
| 31 | - * @since 0.1.0 |
|
| 32 | - * |
|
| 33 | - * @param array $criteria Criteria to search for. |
|
| 34 | - * @param EngineInterface|null $engine Optional. Engine to use with the view. |
|
| 35 | - * |
|
| 36 | - * @return ViewInterface View that was found. |
|
| 37 | - */ |
|
| 38 | - public function find(array $criteria, EngineInterface $engine = null); |
|
| 28 | + /** |
|
| 29 | + * Find a result based on a specific criteria. |
|
| 30 | + * |
|
| 31 | + * @since 0.1.0 |
|
| 32 | + * |
|
| 33 | + * @param array $criteria Criteria to search for. |
|
| 34 | + * @param EngineInterface|null $engine Optional. Engine to use with the view. |
|
| 35 | + * |
|
| 36 | + * @return ViewInterface View that was found. |
|
| 37 | + */ |
|
| 38 | + public function find(array $criteria, EngineInterface $engine = null); |
|
| 39 | 39 | } |
@@ -33,228 +33,228 @@ |
||
| 33 | 33 | class ViewBuilder |
| 34 | 34 | { |
| 35 | 35 | |
| 36 | - use ConfigTrait; |
|
| 36 | + use ConfigTrait; |
|
| 37 | 37 | |
| 38 | - const ENGINE_FINDER_KEY = 'EngineFinder'; |
|
| 39 | - const VIEW_FINDER_KEY = 'ViewFinder'; |
|
| 38 | + const ENGINE_FINDER_KEY = 'EngineFinder'; |
|
| 39 | + const VIEW_FINDER_KEY = 'ViewFinder'; |
|
| 40 | 40 | |
| 41 | - /** |
|
| 42 | - * ViewFinder instance. |
|
| 43 | - * |
|
| 44 | - * @since 0.1.0 |
|
| 45 | - * |
|
| 46 | - * @var ViewFinderInterface |
|
| 47 | - */ |
|
| 48 | - protected $viewFinder; |
|
| 41 | + /** |
|
| 42 | + * ViewFinder instance. |
|
| 43 | + * |
|
| 44 | + * @since 0.1.0 |
|
| 45 | + * |
|
| 46 | + * @var ViewFinderInterface |
|
| 47 | + */ |
|
| 48 | + protected $viewFinder; |
|
| 49 | 49 | |
| 50 | - /** |
|
| 51 | - * EngineFinder instance. |
|
| 52 | - * |
|
| 53 | - * @since 0.1.0 |
|
| 54 | - * |
|
| 55 | - * @var EngineFinderInterface |
|
| 56 | - */ |
|
| 57 | - protected $engineFinder; |
|
| 50 | + /** |
|
| 51 | + * EngineFinder instance. |
|
| 52 | + * |
|
| 53 | + * @since 0.1.0 |
|
| 54 | + * |
|
| 55 | + * @var EngineFinderInterface |
|
| 56 | + */ |
|
| 57 | + protected $engineFinder; |
|
| 58 | 58 | |
| 59 | - /** |
|
| 60 | - * Locations to scan for views. |
|
| 61 | - * |
|
| 62 | - * @since 0.1.0 |
|
| 63 | - * |
|
| 64 | - * @var LocationInterface[] |
|
| 65 | - */ |
|
| 66 | - protected $locations; |
|
| 59 | + /** |
|
| 60 | + * Locations to scan for views. |
|
| 61 | + * |
|
| 62 | + * @since 0.1.0 |
|
| 63 | + * |
|
| 64 | + * @var LocationInterface[] |
|
| 65 | + */ |
|
| 66 | + protected $locations; |
|
| 67 | 67 | |
| 68 | - /** |
|
| 69 | - * Instantiate a ViewBuilder object. |
|
| 70 | - * |
|
| 71 | - * @since 0.1.0 |
|
| 72 | - * |
|
| 73 | - * @param ConfigInterface $config Configuration settings. |
|
| 74 | - * @param ViewFinderInterface|null $viewFinder ViewFinder instance. |
|
| 75 | - * @param EngineFinderInterface|null $engineFinder EngineFinder instance. |
|
| 76 | - * |
|
| 77 | - * @throws FailedToProcessConfigException If the config could not be processed. |
|
| 78 | - */ |
|
| 79 | - public function __construct( |
|
| 80 | - ConfigInterface $config, |
|
| 81 | - ViewFinderInterface $viewFinder = null, |
|
| 82 | - EngineFinderInterface $engineFinder = null |
|
| 83 | - ) { |
|
| 84 | - $this->processConfig($config); |
|
| 85 | - $this->viewFinder = $viewFinder; |
|
| 86 | - $this->engineFinder = $engineFinder; |
|
| 87 | - } |
|
| 68 | + /** |
|
| 69 | + * Instantiate a ViewBuilder object. |
|
| 70 | + * |
|
| 71 | + * @since 0.1.0 |
|
| 72 | + * |
|
| 73 | + * @param ConfigInterface $config Configuration settings. |
|
| 74 | + * @param ViewFinderInterface|null $viewFinder ViewFinder instance. |
|
| 75 | + * @param EngineFinderInterface|null $engineFinder EngineFinder instance. |
|
| 76 | + * |
|
| 77 | + * @throws FailedToProcessConfigException If the config could not be processed. |
|
| 78 | + */ |
|
| 79 | + public function __construct( |
|
| 80 | + ConfigInterface $config, |
|
| 81 | + ViewFinderInterface $viewFinder = null, |
|
| 82 | + EngineFinderInterface $engineFinder = null |
|
| 83 | + ) { |
|
| 84 | + $this->processConfig($config); |
|
| 85 | + $this->viewFinder = $viewFinder; |
|
| 86 | + $this->engineFinder = $engineFinder; |
|
| 87 | + } |
|
| 88 | 88 | |
| 89 | - /** |
|
| 90 | - * Create a new view for a given URI. |
|
| 91 | - * |
|
| 92 | - * @since 0.1.0 |
|
| 93 | - * |
|
| 94 | - * @param string $view View identifier to create a view for. |
|
| 95 | - * @param mixed $type Type of view to create. |
|
| 96 | - * |
|
| 97 | - * @return ViewInterface Instance of the requested view. |
|
| 98 | - */ |
|
| 99 | - public function create($view, $type = null) |
|
| 100 | - { |
|
| 101 | - $uri = $this->scanLocations([$view]); |
|
| 102 | - $engine = $this->getEngine($uri); |
|
| 89 | + /** |
|
| 90 | + * Create a new view for a given URI. |
|
| 91 | + * |
|
| 92 | + * @since 0.1.0 |
|
| 93 | + * |
|
| 94 | + * @param string $view View identifier to create a view for. |
|
| 95 | + * @param mixed $type Type of view to create. |
|
| 96 | + * |
|
| 97 | + * @return ViewInterface Instance of the requested view. |
|
| 98 | + */ |
|
| 99 | + public function create($view, $type = null) |
|
| 100 | + { |
|
| 101 | + $uri = $this->scanLocations([$view]); |
|
| 102 | + $engine = $this->getEngine($uri); |
|
| 103 | 103 | |
| 104 | - return $uri |
|
| 105 | - ? $this->getView($uri, $engine, $type) |
|
| 106 | - : $this->getViewFinder()->getNullObject(); |
|
| 107 | - } |
|
| 104 | + return $uri |
|
| 105 | + ? $this->getView($uri, $engine, $type) |
|
| 106 | + : $this->getViewFinder()->getNullObject(); |
|
| 107 | + } |
|
| 108 | 108 | |
| 109 | - /** |
|
| 110 | - * Get an Engine that can deal with the given URI. |
|
| 111 | - * |
|
| 112 | - * @since 0.1.0 |
|
| 113 | - * |
|
| 114 | - * @param string|false $uri URI to get an engine for. |
|
| 115 | - * |
|
| 116 | - * @return EngineInterface Instance of an engine that can deal with the given URI. |
|
| 117 | - */ |
|
| 118 | - public function getEngine($uri) |
|
| 119 | - { |
|
| 120 | - return $this->getEngineFinder()->find([$uri]); |
|
| 121 | - } |
|
| 109 | + /** |
|
| 110 | + * Get an Engine that can deal with the given URI. |
|
| 111 | + * |
|
| 112 | + * @since 0.1.0 |
|
| 113 | + * |
|
| 114 | + * @param string|false $uri URI to get an engine for. |
|
| 115 | + * |
|
| 116 | + * @return EngineInterface Instance of an engine that can deal with the given URI. |
|
| 117 | + */ |
|
| 118 | + public function getEngine($uri) |
|
| 119 | + { |
|
| 120 | + return $this->getEngineFinder()->find([$uri]); |
|
| 121 | + } |
|
| 122 | 122 | |
| 123 | - /** |
|
| 124 | - * Get a view for a given URI, engine and type. |
|
| 125 | - * |
|
| 126 | - * @since 0.1.0 |
|
| 127 | - * |
|
| 128 | - * @param string $uri URI to get a view for. |
|
| 129 | - * @param EngineInterface $engine Engine to use for the view. |
|
| 130 | - * @param mixed $type Type of view to get. |
|
| 131 | - * |
|
| 132 | - * @return ViewInterface View that matches the given requirements. |
|
| 133 | - */ |
|
| 134 | - public function getView($uri, EngineInterface $engine, $type = null) |
|
| 135 | - { |
|
| 136 | - if (null === $type) { |
|
| 137 | - return $this->getViewFinder()->find([$uri], $engine); |
|
| 138 | - } |
|
| 123 | + /** |
|
| 124 | + * Get a view for a given URI, engine and type. |
|
| 125 | + * |
|
| 126 | + * @since 0.1.0 |
|
| 127 | + * |
|
| 128 | + * @param string $uri URI to get a view for. |
|
| 129 | + * @param EngineInterface $engine Engine to use for the view. |
|
| 130 | + * @param mixed $type Type of view to get. |
|
| 131 | + * |
|
| 132 | + * @return ViewInterface View that matches the given requirements. |
|
| 133 | + */ |
|
| 134 | + public function getView($uri, EngineInterface $engine, $type = null) |
|
| 135 | + { |
|
| 136 | + if (null === $type) { |
|
| 137 | + return $this->getViewFinder()->find([$uri], $engine); |
|
| 138 | + } |
|
| 139 | 139 | |
| 140 | - return $this->resolveType($type, $uri, $engine); |
|
| 141 | - } |
|
| 140 | + return $this->resolveType($type, $uri, $engine); |
|
| 141 | + } |
|
| 142 | 142 | |
| 143 | - /** |
|
| 144 | - * Get the ViewFinder instance. |
|
| 145 | - * |
|
| 146 | - * @since 0.1.0 |
|
| 147 | - * |
|
| 148 | - * @return ViewFinderInterface Instance of a ViewFinder. |
|
| 149 | - */ |
|
| 150 | - public function getViewFinder() |
|
| 151 | - { |
|
| 152 | - return $this->getFinder($this->viewFinder, static::VIEW_FINDER_KEY); |
|
| 153 | - } |
|
| 143 | + /** |
|
| 144 | + * Get the ViewFinder instance. |
|
| 145 | + * |
|
| 146 | + * @since 0.1.0 |
|
| 147 | + * |
|
| 148 | + * @return ViewFinderInterface Instance of a ViewFinder. |
|
| 149 | + */ |
|
| 150 | + public function getViewFinder() |
|
| 151 | + { |
|
| 152 | + return $this->getFinder($this->viewFinder, static::VIEW_FINDER_KEY); |
|
| 153 | + } |
|
| 154 | 154 | |
| 155 | - /** |
|
| 156 | - * Get the EngineFinder instance. |
|
| 157 | - * |
|
| 158 | - * @since 0.1.0 |
|
| 159 | - * |
|
| 160 | - * @return EngineFinderInterface Instance of a EngineFinder. |
|
| 161 | - */ |
|
| 162 | - public function getEngineFinder() |
|
| 163 | - { |
|
| 164 | - return $this->getFinder($this->engineFinder, static::ENGINE_FINDER_KEY); |
|
| 165 | - } |
|
| 155 | + /** |
|
| 156 | + * Get the EngineFinder instance. |
|
| 157 | + * |
|
| 158 | + * @since 0.1.0 |
|
| 159 | + * |
|
| 160 | + * @return EngineFinderInterface Instance of a EngineFinder. |
|
| 161 | + */ |
|
| 162 | + public function getEngineFinder() |
|
| 163 | + { |
|
| 164 | + return $this->getFinder($this->engineFinder, static::ENGINE_FINDER_KEY); |
|
| 165 | + } |
|
| 166 | 166 | |
| 167 | - /** |
|
| 168 | - * Add a location to scan with the ViewFinder. |
|
| 169 | - * |
|
| 170 | - * @since 0.1.0 |
|
| 171 | - * |
|
| 172 | - * @param LocationInterface $location Location to scan with the ViewFinder. |
|
| 173 | - */ |
|
| 174 | - public function addLocation(LocationInterface $location) |
|
| 175 | - { |
|
| 176 | - $this->locations[] = $location; |
|
| 177 | - } |
|
| 167 | + /** |
|
| 168 | + * Add a location to scan with the ViewFinder. |
|
| 169 | + * |
|
| 170 | + * @since 0.1.0 |
|
| 171 | + * |
|
| 172 | + * @param LocationInterface $location Location to scan with the ViewFinder. |
|
| 173 | + */ |
|
| 174 | + public function addLocation(LocationInterface $location) |
|
| 175 | + { |
|
| 176 | + $this->locations[] = $location; |
|
| 177 | + } |
|
| 178 | 178 | |
| 179 | - /** |
|
| 180 | - * Scan Locations for an URI that matches the specified criteria. |
|
| 181 | - * |
|
| 182 | - * @since 0.1.0 |
|
| 183 | - * |
|
| 184 | - * @param array $criteria Criteria to match. |
|
| 185 | - * |
|
| 186 | - * @return string|false URI of the requested view, or false if not found. |
|
| 187 | - */ |
|
| 188 | - public function scanLocations(array $criteria) |
|
| 189 | - { |
|
| 190 | - /** @var LocationInterface $location */ |
|
| 191 | - foreach ($this->locations as $location) { |
|
| 192 | - if ($uri = $location->getURI($criteria)) { |
|
| 193 | - return $uri; |
|
| 194 | - } |
|
| 195 | - } |
|
| 179 | + /** |
|
| 180 | + * Scan Locations for an URI that matches the specified criteria. |
|
| 181 | + * |
|
| 182 | + * @since 0.1.0 |
|
| 183 | + * |
|
| 184 | + * @param array $criteria Criteria to match. |
|
| 185 | + * |
|
| 186 | + * @return string|false URI of the requested view, or false if not found. |
|
| 187 | + */ |
|
| 188 | + public function scanLocations(array $criteria) |
|
| 189 | + { |
|
| 190 | + /** @var LocationInterface $location */ |
|
| 191 | + foreach ($this->locations as $location) { |
|
| 192 | + if ($uri = $location->getURI($criteria)) { |
|
| 193 | + return $uri; |
|
| 194 | + } |
|
| 195 | + } |
|
| 196 | 196 | |
| 197 | - return false; |
|
| 198 | - } |
|
| 197 | + return false; |
|
| 198 | + } |
|
| 199 | 199 | |
| 200 | - /** |
|
| 201 | - * Get a finder instance. |
|
| 202 | - * |
|
| 203 | - * @since 0.1.1 |
|
| 204 | - * |
|
| 205 | - * @param mixed $property Property to use. |
|
| 206 | - * @param string $key Configuration key to use. |
|
| 207 | - * |
|
| 208 | - * @return FinderInterface The requested finder instance. |
|
| 209 | - */ |
|
| 210 | - protected function getFinder(&$property, $key) |
|
| 211 | - { |
|
| 212 | - if (null === $property) { |
|
| 213 | - $engineFinderClass = $this->config->getKey($key, 'ClassName'); |
|
| 214 | - $property = new $engineFinderClass($this->config->getSubConfig($key)); |
|
| 215 | - } |
|
| 200 | + /** |
|
| 201 | + * Get a finder instance. |
|
| 202 | + * |
|
| 203 | + * @since 0.1.1 |
|
| 204 | + * |
|
| 205 | + * @param mixed $property Property to use. |
|
| 206 | + * @param string $key Configuration key to use. |
|
| 207 | + * |
|
| 208 | + * @return FinderInterface The requested finder instance. |
|
| 209 | + */ |
|
| 210 | + protected function getFinder(&$property, $key) |
|
| 211 | + { |
|
| 212 | + if (null === $property) { |
|
| 213 | + $engineFinderClass = $this->config->getKey($key, 'ClassName'); |
|
| 214 | + $property = new $engineFinderClass($this->config->getSubConfig($key)); |
|
| 215 | + } |
|
| 216 | 216 | |
| 217 | - return $property; |
|
| 218 | - } |
|
| 217 | + return $property; |
|
| 218 | + } |
|
| 219 | 219 | |
| 220 | - /** |
|
| 221 | - * Resolve the view type. |
|
| 222 | - * |
|
| 223 | - * @since 0.1.0 |
|
| 224 | - * |
|
| 225 | - * @param mixed $type Type of view that was requested. |
|
| 226 | - * @param string $uri URI to get a view for. |
|
| 227 | - * @param EngineInterface|null $engine Engine to use for the view. |
|
| 228 | - * |
|
| 229 | - * @return ViewInterface Resolved View object. |
|
| 230 | - * @throws FailedToInstantiateViewException If the view type could not be resolved. |
|
| 231 | - */ |
|
| 232 | - protected function resolveType($type, $uri, EngineInterface $engine = null) |
|
| 233 | - { |
|
| 234 | - $configKey = [static::VIEW_FINDER_KEY, 'Views', $type]; |
|
| 220 | + /** |
|
| 221 | + * Resolve the view type. |
|
| 222 | + * |
|
| 223 | + * @since 0.1.0 |
|
| 224 | + * |
|
| 225 | + * @param mixed $type Type of view that was requested. |
|
| 226 | + * @param string $uri URI to get a view for. |
|
| 227 | + * @param EngineInterface|null $engine Engine to use for the view. |
|
| 228 | + * |
|
| 229 | + * @return ViewInterface Resolved View object. |
|
| 230 | + * @throws FailedToInstantiateViewException If the view type could not be resolved. |
|
| 231 | + */ |
|
| 232 | + protected function resolveType($type, $uri, EngineInterface $engine = null) |
|
| 233 | + { |
|
| 234 | + $configKey = [static::VIEW_FINDER_KEY, 'Views', $type]; |
|
| 235 | 235 | |
| 236 | - if (is_string($type) && $this->config->hasKey($configKey)) { |
|
| 237 | - $className = $this->config->getKey($configKey); |
|
| 238 | - $type = new $className($uri, $engine); |
|
| 239 | - } |
|
| 236 | + if (is_string($type) && $this->config->hasKey($configKey)) { |
|
| 237 | + $className = $this->config->getKey($configKey); |
|
| 238 | + $type = new $className($uri, $engine); |
|
| 239 | + } |
|
| 240 | 240 | |
| 241 | - if (is_string($type)) { |
|
| 242 | - $type = new $type($uri, $engine); |
|
| 243 | - } |
|
| 241 | + if (is_string($type)) { |
|
| 242 | + $type = new $type($uri, $engine); |
|
| 243 | + } |
|
| 244 | 244 | |
| 245 | - if (is_callable($type)) { |
|
| 246 | - $type = $type($uri, $engine); |
|
| 247 | - } |
|
| 245 | + if (is_callable($type)) { |
|
| 246 | + $type = $type($uri, $engine); |
|
| 247 | + } |
|
| 248 | 248 | |
| 249 | - if (! $type instanceof ViewInterface) { |
|
| 250 | - throw new FailedToInstantiateViewException( |
|
| 251 | - sprintf( |
|
| 252 | - _('Could not instantiate view "%s".'), |
|
| 253 | - serialize($type) |
|
| 254 | - ) |
|
| 255 | - ); |
|
| 256 | - } |
|
| 249 | + if (! $type instanceof ViewInterface) { |
|
| 250 | + throw new FailedToInstantiateViewException( |
|
| 251 | + sprintf( |
|
| 252 | + _('Could not instantiate view "%s".'), |
|
| 253 | + serialize($type) |
|
| 254 | + ) |
|
| 255 | + ); |
|
| 256 | + } |
|
| 257 | 257 | |
| 258 | - return $type; |
|
| 259 | - } |
|
| 258 | + return $type; |
|
| 259 | + } |
|
| 260 | 260 | } |