@@ -24,24 +24,24 @@ |
||
| 24 | 24 | class Extensions extends ArrayCollection |
| 25 | 25 | { |
| 26 | 26 | |
| 27 | - /** |
|
| 28 | - * Check whether a given URI has a specific extension. |
|
| 29 | - * |
|
| 30 | - * @since 0.1.0 |
|
| 31 | - * |
|
| 32 | - * @param string $uri URI to check the extension of. |
|
| 33 | - * @param string $extension Extension to check for. |
|
| 34 | - * |
|
| 35 | - * @return bool |
|
| 36 | - */ |
|
| 37 | - public static function hasExtension($uri, $extension) |
|
| 38 | - { |
|
| 39 | - $uriLength = mb_strlen($uri); |
|
| 40 | - $extensionLength = mb_strlen($extension); |
|
| 41 | - if ($extensionLength > $uriLength) { |
|
| 42 | - return false; |
|
| 43 | - } |
|
| 27 | + /** |
|
| 28 | + * Check whether a given URI has a specific extension. |
|
| 29 | + * |
|
| 30 | + * @since 0.1.0 |
|
| 31 | + * |
|
| 32 | + * @param string $uri URI to check the extension of. |
|
| 33 | + * @param string $extension Extension to check for. |
|
| 34 | + * |
|
| 35 | + * @return bool |
|
| 36 | + */ |
|
| 37 | + public static function hasExtension($uri, $extension) |
|
| 38 | + { |
|
| 39 | + $uriLength = mb_strlen($uri); |
|
| 40 | + $extensionLength = mb_strlen($extension); |
|
| 41 | + if ($extensionLength > $uriLength) { |
|
| 42 | + return false; |
|
| 43 | + } |
|
| 44 | 44 | |
| 45 | - return substr_compare($uri, $extension, $uriLength - $extensionLength, $extensionLength) === 0; |
|
| 46 | - } |
|
| 45 | + return substr_compare($uri, $extension, $uriLength - $extensionLength, $extensionLength) === 0; |
|
| 46 | + } |
|
| 47 | 47 | } |
@@ -27,209 +27,209 @@ |
||
| 27 | 27 | abstract class AbstractFinder implements Finder |
| 28 | 28 | { |
| 29 | 29 | |
| 30 | - use ConfigTrait; |
|
| 31 | - |
|
| 32 | - /** |
|
| 33 | - * Findable collection that the Finder can iterate through to find a match. |
|
| 34 | - * |
|
| 35 | - * @since 0.1.0 |
|
| 36 | - * |
|
| 37 | - * @var Findables |
|
| 38 | - */ |
|
| 39 | - protected $findables; |
|
| 40 | - |
|
| 41 | - /** |
|
| 42 | - * NullObject that is returned if the Finder could not find a match. |
|
| 43 | - * |
|
| 44 | - * @since 0.1.0 |
|
| 45 | - * |
|
| 46 | - * @var NullFindable |
|
| 47 | - */ |
|
| 48 | - protected $nullObject; |
|
| 49 | - |
|
| 50 | - /** |
|
| 51 | - * Instantiate an AbstractFinder object. |
|
| 52 | - * |
|
| 53 | - * @since 0.1.0 |
|
| 54 | - * |
|
| 55 | - * @param ConfigInterface $config Configuration of the AbstractFinder. |
|
| 56 | - * |
|
| 57 | - * @throws FailedToProcessConfigException If the config could not be processed. |
|
| 58 | - */ |
|
| 59 | - public function __construct(ConfigInterface $config) |
|
| 60 | - { |
|
| 61 | - $this->processConfig($config); |
|
| 62 | - $this->findables = new Findables(); |
|
| 63 | - $this->registerFindables($this->config); |
|
| 64 | - $this->registerNullObject($this->config); |
|
| 65 | - } |
|
| 66 | - |
|
| 67 | - /** |
|
| 68 | - * Register the Findables defined in the given configuration. |
|
| 69 | - * |
|
| 70 | - * @since 0.1.0 |
|
| 71 | - * |
|
| 72 | - * @param ConfigInterface $config Configuration to register the Findables from. |
|
| 73 | - */ |
|
| 74 | - public function registerFindables(ConfigInterface $config) |
|
| 75 | - { |
|
| 76 | - foreach ($config->getKey($this->getFindablesConfigKey()) as $findableKey => $findableObject) { |
|
| 77 | - $this->findables->set($findableKey, $findableObject); |
|
| 78 | - } |
|
| 79 | - } |
|
| 80 | - |
|
| 81 | - /** |
|
| 82 | - * Register the NullObject defined in the given configuration. |
|
| 83 | - * |
|
| 84 | - * @since 0.1.0 |
|
| 85 | - * |
|
| 86 | - * @param ConfigInterface $config Configuration to register the NullObject from. |
|
| 87 | - */ |
|
| 88 | - public function registerNullObject(ConfigInterface $config) |
|
| 89 | - { |
|
| 90 | - $this->nullObject = $config->getKey($this->getNullObjectConfigKey()); |
|
| 91 | - } |
|
| 92 | - |
|
| 93 | - /** |
|
| 94 | - * Get the NullObject. |
|
| 95 | - * |
|
| 96 | - * @since 0.1.1 |
|
| 97 | - * |
|
| 98 | - * @return NullFindable NullObject for the current Finder. |
|
| 99 | - */ |
|
| 100 | - public function getNullObject() |
|
| 101 | - { |
|
| 102 | - $this->initializeNullObject(); |
|
| 103 | - |
|
| 104 | - return $this->nullObject; |
|
| 105 | - } |
|
| 106 | - |
|
| 107 | - /** |
|
| 108 | - * Get the config key for the Findables definitions. |
|
| 109 | - * |
|
| 110 | - * @since 0.1.0 |
|
| 111 | - * |
|
| 112 | - * @return string Config key use to define the Findables. |
|
| 113 | - */ |
|
| 114 | - protected function getFindablesConfigKey() |
|
| 115 | - { |
|
| 116 | - return 'Findables'; |
|
| 117 | - } |
|
| 118 | - |
|
| 119 | - /** |
|
| 120 | - * Get the config key for the NullObject definitions. |
|
| 121 | - * |
|
| 122 | - * @since 0.1.0 |
|
| 123 | - * |
|
| 124 | - * @return string Config key use to define the NullObject. |
|
| 125 | - */ |
|
| 126 | - protected function getNullObjectConfigKey() |
|
| 127 | - { |
|
| 128 | - return 'NullObject'; |
|
| 129 | - } |
|
| 130 | - |
|
| 131 | - /** |
|
| 132 | - * Initialize the NullObject. |
|
| 133 | - * |
|
| 134 | - * @since 0.1.1 |
|
| 135 | - * |
|
| 136 | - * @param mixed $arguments Optional. Arguments to use. |
|
| 137 | - */ |
|
| 138 | - protected function initializeNullObject($arguments = null) |
|
| 139 | - { |
|
| 140 | - $this->nullObject = $this->maybeInstantiateFindable($this->nullObject, $arguments); |
|
| 141 | - } |
|
| 142 | - |
|
| 143 | - /** |
|
| 144 | - * Initialize the Findables that can be iterated. |
|
| 145 | - * |
|
| 146 | - * @param mixed $arguments Optional. Arguments to use. |
|
| 147 | - * |
|
| 148 | - * @since 0.1.0 |
|
| 149 | - * |
|
| 150 | - */ |
|
| 151 | - protected function initializeFindables($arguments = null) |
|
| 152 | - { |
|
| 153 | - $this->findables = $this->findables->map(function ($findable) use ($arguments) { |
|
| 154 | - return $this->initializeFindable($findable, $arguments); |
|
| 155 | - }); |
|
| 156 | - } |
|
| 157 | - |
|
| 158 | - /** |
|
| 159 | - * Initialize a single findable by instantiating class name strings and calling closures. |
|
| 160 | - * |
|
| 161 | - * @since 0.1.0 |
|
| 162 | - * |
|
| 163 | - * @param mixed $findable Findable to instantiate. |
|
| 164 | - * @param mixed $arguments Optional. Arguments to use. |
|
| 165 | - * |
|
| 166 | - * @return Findable Instantiated findable. |
|
| 167 | - */ |
|
| 168 | - protected function initializeFindable($findable, $arguments = null) |
|
| 169 | - { |
|
| 170 | - return $this->maybeInstantiateFindable($findable, $arguments); |
|
| 171 | - } |
|
| 172 | - |
|
| 173 | - /** |
|
| 174 | - * Maybe instantiate a Findable if it is not yet an object. |
|
| 175 | - * |
|
| 176 | - * @since 0.1.1 |
|
| 177 | - * |
|
| 178 | - * @param mixed $findable Findable to instantiate. |
|
| 179 | - * @param mixed $arguments Optional. Arguments to use. |
|
| 180 | - * |
|
| 181 | - * @return Findable Instantiated findable. |
|
| 182 | - * @throws FailedToInstantiateFindable If the findable could not be instantiated. |
|
| 183 | - */ |
|
| 184 | - protected function maybeInstantiateFindable($findable, $arguments = null) |
|
| 185 | - { |
|
| 186 | - if (is_string($findable)) { |
|
| 187 | - $findable = $this->instantiateFindableFromString($findable, $arguments); |
|
| 188 | - } |
|
| 189 | - |
|
| 190 | - if (is_callable($findable)) { |
|
| 191 | - $findable = $this->instantiateFindableFromCallable($findable, $arguments); |
|
| 192 | - } |
|
| 193 | - |
|
| 194 | - if ( ! $findable instanceof Findable) { |
|
| 195 | - throw new FailedToInstantiateFindable( |
|
| 196 | - sprintf( |
|
| 197 | - _('Could not instantiate Findable "%s".'), |
|
| 198 | - serialize($findable) |
|
| 199 | - ) |
|
| 200 | - ); |
|
| 201 | - } |
|
| 202 | - |
|
| 203 | - return $findable; |
|
| 204 | - } |
|
| 205 | - |
|
| 206 | - /** |
|
| 207 | - * Instantiate a Findable from a string. |
|
| 208 | - * |
|
| 209 | - * @since 0.1.1 |
|
| 210 | - * |
|
| 211 | - * @param string $string String to use for instantiation. |
|
| 212 | - * @param mixed $arguments Optional. Arguments to use for instantiation. |
|
| 213 | - * |
|
| 214 | - * @return Findable Instantiated Findable. |
|
| 215 | - */ |
|
| 216 | - protected function instantiateFindableFromString($string, $arguments = []) |
|
| 217 | - { |
|
| 218 | - return new $string(...(array)$arguments); |
|
| 219 | - } |
|
| 220 | - |
|
| 221 | - /** |
|
| 222 | - * Instantiate a Findable from a callable. |
|
| 223 | - * |
|
| 224 | - * @since 0.1.1 |
|
| 225 | - * |
|
| 226 | - * @param callable $callable Callable to use for instantiation. |
|
| 227 | - * @param mixed $arguments Optional. Arguments to use for instantiation. |
|
| 228 | - * |
|
| 229 | - * @return Findable Instantiated Findable. |
|
| 230 | - */ |
|
| 231 | - protected function instantiateFindableFromCallable($callable, $arguments = []) |
|
| 232 | - { |
|
| 233 | - return $callable(...(array)$arguments); |
|
| 234 | - } |
|
| 30 | + use ConfigTrait; |
|
| 31 | + |
|
| 32 | + /** |
|
| 33 | + * Findable collection that the Finder can iterate through to find a match. |
|
| 34 | + * |
|
| 35 | + * @since 0.1.0 |
|
| 36 | + * |
|
| 37 | + * @var Findables |
|
| 38 | + */ |
|
| 39 | + protected $findables; |
|
| 40 | + |
|
| 41 | + /** |
|
| 42 | + * NullObject that is returned if the Finder could not find a match. |
|
| 43 | + * |
|
| 44 | + * @since 0.1.0 |
|
| 45 | + * |
|
| 46 | + * @var NullFindable |
|
| 47 | + */ |
|
| 48 | + protected $nullObject; |
|
| 49 | + |
|
| 50 | + /** |
|
| 51 | + * Instantiate an AbstractFinder object. |
|
| 52 | + * |
|
| 53 | + * @since 0.1.0 |
|
| 54 | + * |
|
| 55 | + * @param ConfigInterface $config Configuration of the AbstractFinder. |
|
| 56 | + * |
|
| 57 | + * @throws FailedToProcessConfigException If the config could not be processed. |
|
| 58 | + */ |
|
| 59 | + public function __construct(ConfigInterface $config) |
|
| 60 | + { |
|
| 61 | + $this->processConfig($config); |
|
| 62 | + $this->findables = new Findables(); |
|
| 63 | + $this->registerFindables($this->config); |
|
| 64 | + $this->registerNullObject($this->config); |
|
| 65 | + } |
|
| 66 | + |
|
| 67 | + /** |
|
| 68 | + * Register the Findables defined in the given configuration. |
|
| 69 | + * |
|
| 70 | + * @since 0.1.0 |
|
| 71 | + * |
|
| 72 | + * @param ConfigInterface $config Configuration to register the Findables from. |
|
| 73 | + */ |
|
| 74 | + public function registerFindables(ConfigInterface $config) |
|
| 75 | + { |
|
| 76 | + foreach ($config->getKey($this->getFindablesConfigKey()) as $findableKey => $findableObject) { |
|
| 77 | + $this->findables->set($findableKey, $findableObject); |
|
| 78 | + } |
|
| 79 | + } |
|
| 80 | + |
|
| 81 | + /** |
|
| 82 | + * Register the NullObject defined in the given configuration. |
|
| 83 | + * |
|
| 84 | + * @since 0.1.0 |
|
| 85 | + * |
|
| 86 | + * @param ConfigInterface $config Configuration to register the NullObject from. |
|
| 87 | + */ |
|
| 88 | + public function registerNullObject(ConfigInterface $config) |
|
| 89 | + { |
|
| 90 | + $this->nullObject = $config->getKey($this->getNullObjectConfigKey()); |
|
| 91 | + } |
|
| 92 | + |
|
| 93 | + /** |
|
| 94 | + * Get the NullObject. |
|
| 95 | + * |
|
| 96 | + * @since 0.1.1 |
|
| 97 | + * |
|
| 98 | + * @return NullFindable NullObject for the current Finder. |
|
| 99 | + */ |
|
| 100 | + public function getNullObject() |
|
| 101 | + { |
|
| 102 | + $this->initializeNullObject(); |
|
| 103 | + |
|
| 104 | + return $this->nullObject; |
|
| 105 | + } |
|
| 106 | + |
|
| 107 | + /** |
|
| 108 | + * Get the config key for the Findables definitions. |
|
| 109 | + * |
|
| 110 | + * @since 0.1.0 |
|
| 111 | + * |
|
| 112 | + * @return string Config key use to define the Findables. |
|
| 113 | + */ |
|
| 114 | + protected function getFindablesConfigKey() |
|
| 115 | + { |
|
| 116 | + return 'Findables'; |
|
| 117 | + } |
|
| 118 | + |
|
| 119 | + /** |
|
| 120 | + * Get the config key for the NullObject definitions. |
|
| 121 | + * |
|
| 122 | + * @since 0.1.0 |
|
| 123 | + * |
|
| 124 | + * @return string Config key use to define the NullObject. |
|
| 125 | + */ |
|
| 126 | + protected function getNullObjectConfigKey() |
|
| 127 | + { |
|
| 128 | + return 'NullObject'; |
|
| 129 | + } |
|
| 130 | + |
|
| 131 | + /** |
|
| 132 | + * Initialize the NullObject. |
|
| 133 | + * |
|
| 134 | + * @since 0.1.1 |
|
| 135 | + * |
|
| 136 | + * @param mixed $arguments Optional. Arguments to use. |
|
| 137 | + */ |
|
| 138 | + protected function initializeNullObject($arguments = null) |
|
| 139 | + { |
|
| 140 | + $this->nullObject = $this->maybeInstantiateFindable($this->nullObject, $arguments); |
|
| 141 | + } |
|
| 142 | + |
|
| 143 | + /** |
|
| 144 | + * Initialize the Findables that can be iterated. |
|
| 145 | + * |
|
| 146 | + * @param mixed $arguments Optional. Arguments to use. |
|
| 147 | + * |
|
| 148 | + * @since 0.1.0 |
|
| 149 | + * |
|
| 150 | + */ |
|
| 151 | + protected function initializeFindables($arguments = null) |
|
| 152 | + { |
|
| 153 | + $this->findables = $this->findables->map(function ($findable) use ($arguments) { |
|
| 154 | + return $this->initializeFindable($findable, $arguments); |
|
| 155 | + }); |
|
| 156 | + } |
|
| 157 | + |
|
| 158 | + /** |
|
| 159 | + * Initialize a single findable by instantiating class name strings and calling closures. |
|
| 160 | + * |
|
| 161 | + * @since 0.1.0 |
|
| 162 | + * |
|
| 163 | + * @param mixed $findable Findable to instantiate. |
|
| 164 | + * @param mixed $arguments Optional. Arguments to use. |
|
| 165 | + * |
|
| 166 | + * @return Findable Instantiated findable. |
|
| 167 | + */ |
|
| 168 | + protected function initializeFindable($findable, $arguments = null) |
|
| 169 | + { |
|
| 170 | + return $this->maybeInstantiateFindable($findable, $arguments); |
|
| 171 | + } |
|
| 172 | + |
|
| 173 | + /** |
|
| 174 | + * Maybe instantiate a Findable if it is not yet an object. |
|
| 175 | + * |
|
| 176 | + * @since 0.1.1 |
|
| 177 | + * |
|
| 178 | + * @param mixed $findable Findable to instantiate. |
|
| 179 | + * @param mixed $arguments Optional. Arguments to use. |
|
| 180 | + * |
|
| 181 | + * @return Findable Instantiated findable. |
|
| 182 | + * @throws FailedToInstantiateFindable If the findable could not be instantiated. |
|
| 183 | + */ |
|
| 184 | + protected function maybeInstantiateFindable($findable, $arguments = null) |
|
| 185 | + { |
|
| 186 | + if (is_string($findable)) { |
|
| 187 | + $findable = $this->instantiateFindableFromString($findable, $arguments); |
|
| 188 | + } |
|
| 189 | + |
|
| 190 | + if (is_callable($findable)) { |
|
| 191 | + $findable = $this->instantiateFindableFromCallable($findable, $arguments); |
|
| 192 | + } |
|
| 193 | + |
|
| 194 | + if ( ! $findable instanceof Findable) { |
|
| 195 | + throw new FailedToInstantiateFindable( |
|
| 196 | + sprintf( |
|
| 197 | + _('Could not instantiate Findable "%s".'), |
|
| 198 | + serialize($findable) |
|
| 199 | + ) |
|
| 200 | + ); |
|
| 201 | + } |
|
| 202 | + |
|
| 203 | + return $findable; |
|
| 204 | + } |
|
| 205 | + |
|
| 206 | + /** |
|
| 207 | + * Instantiate a Findable from a string. |
|
| 208 | + * |
|
| 209 | + * @since 0.1.1 |
|
| 210 | + * |
|
| 211 | + * @param string $string String to use for instantiation. |
|
| 212 | + * @param mixed $arguments Optional. Arguments to use for instantiation. |
|
| 213 | + * |
|
| 214 | + * @return Findable Instantiated Findable. |
|
| 215 | + */ |
|
| 216 | + protected function instantiateFindableFromString($string, $arguments = []) |
|
| 217 | + { |
|
| 218 | + return new $string(...(array)$arguments); |
|
| 219 | + } |
|
| 220 | + |
|
| 221 | + /** |
|
| 222 | + * Instantiate a Findable from a callable. |
|
| 223 | + * |
|
| 224 | + * @since 0.1.1 |
|
| 225 | + * |
|
| 226 | + * @param callable $callable Callable to use for instantiation. |
|
| 227 | + * @param mixed $arguments Optional. Arguments to use for instantiation. |
|
| 228 | + * |
|
| 229 | + * @return Findable Instantiated Findable. |
|
| 230 | + */ |
|
| 231 | + protected function instantiateFindableFromCallable($callable, $arguments = []) |
|
| 232 | + { |
|
| 233 | + return $callable(...(array)$arguments); |
|
| 234 | + } |
|
| 235 | 235 | } |
@@ -150,7 +150,7 @@ discard block |
||
| 150 | 150 | */ |
| 151 | 151 | protected function initializeFindables($arguments = null) |
| 152 | 152 | { |
| 153 | - $this->findables = $this->findables->map(function ($findable) use ($arguments) { |
|
| 153 | + $this->findables = $this->findables->map(function($findable) use ($arguments) { |
|
| 154 | 154 | return $this->initializeFindable($findable, $arguments); |
| 155 | 155 | }); |
| 156 | 156 | } |
@@ -215,7 +215,7 @@ discard block |
||
| 215 | 215 | */ |
| 216 | 216 | protected function instantiateFindableFromString($string, $arguments = []) |
| 217 | 217 | { |
| 218 | - return new $string(...(array)$arguments); |
|
| 218 | + return new $string(...(array) $arguments); |
|
| 219 | 219 | } |
| 220 | 220 | |
| 221 | 221 | /** |
@@ -230,6 +230,6 @@ discard block |
||
| 230 | 230 | */ |
| 231 | 231 | protected function instantiateFindableFromCallable($callable, $arguments = []) |
| 232 | 232 | { |
| 233 | - return $callable(...(array)$arguments); |
|
| 233 | + return $callable(...(array) $arguments); |
|
| 234 | 234 | } |
| 235 | 235 | } |