@@ -25,98 +25,98 @@ |
||
| 25 | 25 | class LoaderFactory |
| 26 | 26 | { |
| 27 | 27 | |
| 28 | - /** |
|
| 29 | - * Array of fully qualified class names of known loaders. |
|
| 30 | - * |
|
| 31 | - * @var array<string> |
|
| 32 | - * |
|
| 33 | - * @since 0.4.0 |
|
| 34 | - */ |
|
| 35 | - protected static $loaders = [ |
|
| 36 | - 'BrightNucleus\Config\Loader\PHPLoader', |
|
| 37 | - 'BrightNucleus\Config\Loader\JSONLoader', |
|
| 38 | - ]; |
|
| 28 | + /** |
|
| 29 | + * Array of fully qualified class names of known loaders. |
|
| 30 | + * |
|
| 31 | + * @var array<string> |
|
| 32 | + * |
|
| 33 | + * @since 0.4.0 |
|
| 34 | + */ |
|
| 35 | + protected static $loaders = [ |
|
| 36 | + 'BrightNucleus\Config\Loader\PHPLoader', |
|
| 37 | + 'BrightNucleus\Config\Loader\JSONLoader', |
|
| 38 | + ]; |
|
| 39 | 39 | |
| 40 | - /** |
|
| 41 | - * Array of instantiated loaders. |
|
| 42 | - * |
|
| 43 | - * These are lazily instantiated and added as needed. |
|
| 44 | - * |
|
| 45 | - * @var LoaderInterface[] |
|
| 46 | - * |
|
| 47 | - * @since 0.4.0 |
|
| 48 | - */ |
|
| 49 | - protected static $loaderInstances = []; |
|
| 40 | + /** |
|
| 41 | + * Array of instantiated loaders. |
|
| 42 | + * |
|
| 43 | + * These are lazily instantiated and added as needed. |
|
| 44 | + * |
|
| 45 | + * @var LoaderInterface[] |
|
| 46 | + * |
|
| 47 | + * @since 0.4.0 |
|
| 48 | + */ |
|
| 49 | + protected static $loaderInstances = []; |
|
| 50 | 50 | |
| 51 | - /** |
|
| 52 | - * Create a new Loader from an URI. |
|
| 53 | - * |
|
| 54 | - * @since 0.4.0 |
|
| 55 | - * |
|
| 56 | - * @param string $uri URI of the resource to create a loader for. |
|
| 57 | - * |
|
| 58 | - * @return LoaderInterface Loader that is able to load the given URI. |
|
| 59 | - * @throws FailedToLoadConfigException If no suitable loader was found. |
|
| 60 | - */ |
|
| 61 | - public static function createFromUri($uri) |
|
| 62 | - { |
|
| 63 | - foreach (static::$loaders as $loader) { |
|
| 64 | - if ($loader::canLoad($uri)) { |
|
| 65 | - return static::getLoader($loader); |
|
| 66 | - } |
|
| 67 | - } |
|
| 51 | + /** |
|
| 52 | + * Create a new Loader from an URI. |
|
| 53 | + * |
|
| 54 | + * @since 0.4.0 |
|
| 55 | + * |
|
| 56 | + * @param string $uri URI of the resource to create a loader for. |
|
| 57 | + * |
|
| 58 | + * @return LoaderInterface Loader that is able to load the given URI. |
|
| 59 | + * @throws FailedToLoadConfigException If no suitable loader was found. |
|
| 60 | + */ |
|
| 61 | + public static function createFromUri($uri) |
|
| 62 | + { |
|
| 63 | + foreach (static::$loaders as $loader) { |
|
| 64 | + if ($loader::canLoad($uri)) { |
|
| 65 | + return static::getLoader($loader); |
|
| 66 | + } |
|
| 67 | + } |
|
| 68 | 68 | |
| 69 | - throw new FailedToLoadConfigException( |
|
| 70 | - sprintf( |
|
| 71 | - _('Could not find a suitable loader for URI "%1$s".'), |
|
| 72 | - $uri |
|
| 73 | - ) |
|
| 74 | - ); |
|
| 75 | - } |
|
| 69 | + throw new FailedToLoadConfigException( |
|
| 70 | + sprintf( |
|
| 71 | + _('Could not find a suitable loader for URI "%1$s".'), |
|
| 72 | + $uri |
|
| 73 | + ) |
|
| 74 | + ); |
|
| 75 | + } |
|
| 76 | 76 | |
| 77 | - /** |
|
| 78 | - * Get an instance of a specific loader. |
|
| 79 | - * |
|
| 80 | - * The loader is lazily instantiated if needed. |
|
| 81 | - * |
|
| 82 | - * @since 0.4.0 |
|
| 83 | - * |
|
| 84 | - * @param string $loaderClass Fully qualified class name of the loader to get. |
|
| 85 | - * |
|
| 86 | - * @return LoaderInterface Instance of the requested loader. |
|
| 87 | - * @throws FailedToLoadConfigException If the loader class could not be instantiated. |
|
| 88 | - */ |
|
| 89 | - public static function getLoader($loaderClass) |
|
| 90 | - { |
|
| 91 | - try { |
|
| 92 | - if (! array_key_exists($loaderClass, static::$loaderInstances)) { |
|
| 93 | - static::$loaderInstances[$loaderClass] = new $loaderClass; |
|
| 94 | - } |
|
| 77 | + /** |
|
| 78 | + * Get an instance of a specific loader. |
|
| 79 | + * |
|
| 80 | + * The loader is lazily instantiated if needed. |
|
| 81 | + * |
|
| 82 | + * @since 0.4.0 |
|
| 83 | + * |
|
| 84 | + * @param string $loaderClass Fully qualified class name of the loader to get. |
|
| 85 | + * |
|
| 86 | + * @return LoaderInterface Instance of the requested loader. |
|
| 87 | + * @throws FailedToLoadConfigException If the loader class could not be instantiated. |
|
| 88 | + */ |
|
| 89 | + public static function getLoader($loaderClass) |
|
| 90 | + { |
|
| 91 | + try { |
|
| 92 | + if (! array_key_exists($loaderClass, static::$loaderInstances)) { |
|
| 93 | + static::$loaderInstances[$loaderClass] = new $loaderClass; |
|
| 94 | + } |
|
| 95 | 95 | |
| 96 | - return static::$loaderInstances[$loaderClass]; |
|
| 97 | - } catch (Exception $exception) { |
|
| 98 | - throw new FailedToLoadConfigException( |
|
| 99 | - sprintf( |
|
| 100 | - _('Could not instantiate the requested loader class "%1$s".'), |
|
| 101 | - $loaderClass |
|
| 102 | - ) |
|
| 103 | - ); |
|
| 104 | - } |
|
| 105 | - } |
|
| 96 | + return static::$loaderInstances[$loaderClass]; |
|
| 97 | + } catch (Exception $exception) { |
|
| 98 | + throw new FailedToLoadConfigException( |
|
| 99 | + sprintf( |
|
| 100 | + _('Could not instantiate the requested loader class "%1$s".'), |
|
| 101 | + $loaderClass |
|
| 102 | + ) |
|
| 103 | + ); |
|
| 104 | + } |
|
| 105 | + } |
|
| 106 | 106 | |
| 107 | - /** |
|
| 108 | - * Register a new loader. |
|
| 109 | - * |
|
| 110 | - * @since 0.4.0 |
|
| 111 | - * |
|
| 112 | - * @param string $loader Fully qualified class name of a loader implementing LoaderInterface. |
|
| 113 | - */ |
|
| 114 | - public static function registerLoader($loader) |
|
| 115 | - { |
|
| 116 | - if (in_array($loader, static::$loaders, true)) { |
|
| 117 | - return; |
|
| 118 | - } |
|
| 107 | + /** |
|
| 108 | + * Register a new loader. |
|
| 109 | + * |
|
| 110 | + * @since 0.4.0 |
|
| 111 | + * |
|
| 112 | + * @param string $loader Fully qualified class name of a loader implementing LoaderInterface. |
|
| 113 | + */ |
|
| 114 | + public static function registerLoader($loader) |
|
| 115 | + { |
|
| 116 | + if (in_array($loader, static::$loaders, true)) { |
|
| 117 | + return; |
|
| 118 | + } |
|
| 119 | 119 | |
| 120 | - static::$loaders [] = $loader; |
|
| 121 | - } |
|
| 120 | + static::$loaders [] = $loader; |
|
| 121 | + } |
|
| 122 | 122 | } |
@@ -25,74 +25,74 @@ |
||
| 25 | 25 | class JSONLoader extends AbstractLoader |
| 26 | 26 | { |
| 27 | 27 | |
| 28 | - /** |
|
| 29 | - * Check whether the loader is able to load a given URI. |
|
| 30 | - * |
|
| 31 | - * @since 0.4.0 |
|
| 32 | - * |
|
| 33 | - * @param string $uri URI to check. |
|
| 34 | - * |
|
| 35 | - * @return bool Whether the loader can load the given URI. |
|
| 36 | - */ |
|
| 37 | - public static function canLoad($uri) |
|
| 38 | - { |
|
| 39 | - $path = pathinfo($uri); |
|
| 28 | + /** |
|
| 29 | + * Check whether the loader is able to load a given URI. |
|
| 30 | + * |
|
| 31 | + * @since 0.4.0 |
|
| 32 | + * |
|
| 33 | + * @param string $uri URI to check. |
|
| 34 | + * |
|
| 35 | + * @return bool Whether the loader can load the given URI. |
|
| 36 | + */ |
|
| 37 | + public static function canLoad($uri) |
|
| 38 | + { |
|
| 39 | + $path = pathinfo($uri); |
|
| 40 | 40 | |
| 41 | - return 'json' === mb_strtolower($path['extension']); |
|
| 42 | - } |
|
| 41 | + return 'json' === mb_strtolower($path['extension']); |
|
| 42 | + } |
|
| 43 | 43 | |
| 44 | - /** |
|
| 45 | - * Load the contents of an resource identified by an URI. |
|
| 46 | - * |
|
| 47 | - * @since 0.4.0 |
|
| 48 | - * |
|
| 49 | - * @param string $uri URI of the resource. |
|
| 50 | - * |
|
| 51 | - * @return array|null Raw data loaded from the resource. Null if no data found. |
|
| 52 | - * @throws FailedToLoadConfigException If the resource could not be loaded. |
|
| 53 | - */ |
|
| 54 | - protected function loadUri($uri) |
|
| 55 | - { |
|
| 56 | - try { |
|
| 57 | - ob_start(); |
|
| 58 | - $data = json_decode(file_get_contents($uri), true); |
|
| 59 | - ob_end_clean(); |
|
| 44 | + /** |
|
| 45 | + * Load the contents of an resource identified by an URI. |
|
| 46 | + * |
|
| 47 | + * @since 0.4.0 |
|
| 48 | + * |
|
| 49 | + * @param string $uri URI of the resource. |
|
| 50 | + * |
|
| 51 | + * @return array|null Raw data loaded from the resource. Null if no data found. |
|
| 52 | + * @throws FailedToLoadConfigException If the resource could not be loaded. |
|
| 53 | + */ |
|
| 54 | + protected function loadUri($uri) |
|
| 55 | + { |
|
| 56 | + try { |
|
| 57 | + ob_start(); |
|
| 58 | + $data = json_decode(file_get_contents($uri), true); |
|
| 59 | + ob_end_clean(); |
|
| 60 | 60 | |
| 61 | - return (array)$data; |
|
| 62 | - } catch (Exception $exception) { |
|
| 63 | - throw new FailedToLoadConfigException( |
|
| 64 | - sprintf( |
|
| 65 | - _('Could not include JSON config file "%1$s". Reason: "%2$s".'), |
|
| 66 | - $uri, |
|
| 67 | - $exception->getMessage() |
|
| 68 | - ), |
|
| 69 | - $exception->getCode(), |
|
| 70 | - $exception |
|
| 71 | - ); |
|
| 72 | - } |
|
| 73 | - } |
|
| 61 | + return (array)$data; |
|
| 62 | + } catch (Exception $exception) { |
|
| 63 | + throw new FailedToLoadConfigException( |
|
| 64 | + sprintf( |
|
| 65 | + _('Could not include JSON config file "%1$s". Reason: "%2$s".'), |
|
| 66 | + $uri, |
|
| 67 | + $exception->getMessage() |
|
| 68 | + ), |
|
| 69 | + $exception->getCode(), |
|
| 70 | + $exception |
|
| 71 | + ); |
|
| 72 | + } |
|
| 73 | + } |
|
| 74 | 74 | |
| 75 | - /** |
|
| 76 | - * Validate and return the URI. |
|
| 77 | - * |
|
| 78 | - * @since 0.4.0 |
|
| 79 | - * |
|
| 80 | - * @param string $uri URI of the resource to load. |
|
| 81 | - * |
|
| 82 | - * @return string Validated URI. |
|
| 83 | - * @throws FailedToLoadConfigException If the URI does not exist or is not readable. |
|
| 84 | - */ |
|
| 85 | - protected function validateUri($uri) |
|
| 86 | - { |
|
| 87 | - if (! is_readable($uri)) { |
|
| 88 | - throw new FailedToLoadConfigException( |
|
| 89 | - sprintf( |
|
| 90 | - _('The requested JSON config file "%1$s" does not exist or is not readable.'), |
|
| 91 | - $uri |
|
| 92 | - ) |
|
| 93 | - ); |
|
| 94 | - } |
|
| 75 | + /** |
|
| 76 | + * Validate and return the URI. |
|
| 77 | + * |
|
| 78 | + * @since 0.4.0 |
|
| 79 | + * |
|
| 80 | + * @param string $uri URI of the resource to load. |
|
| 81 | + * |
|
| 82 | + * @return string Validated URI. |
|
| 83 | + * @throws FailedToLoadConfigException If the URI does not exist or is not readable. |
|
| 84 | + */ |
|
| 85 | + protected function validateUri($uri) |
|
| 86 | + { |
|
| 87 | + if (! is_readable($uri)) { |
|
| 88 | + throw new FailedToLoadConfigException( |
|
| 89 | + sprintf( |
|
| 90 | + _('The requested JSON config file "%1$s" does not exist or is not readable.'), |
|
| 91 | + $uri |
|
| 92 | + ) |
|
| 93 | + ); |
|
| 94 | + } |
|
| 95 | 95 | |
| 96 | - return $uri; |
|
| 97 | - } |
|
| 96 | + return $uri; |
|
| 97 | + } |
|
| 98 | 98 | } |
@@ -22,26 +22,26 @@ |
||
| 22 | 22 | interface LoaderInterface |
| 23 | 23 | { |
| 24 | 24 | |
| 25 | - /** |
|
| 26 | - * Check whether the loader is able to load a given URI. |
|
| 27 | - * |
|
| 28 | - * @since 0.4.0 |
|
| 29 | - * |
|
| 30 | - * @param string $uri URI to check. |
|
| 31 | - * |
|
| 32 | - * @return bool Whether the loader can load the given URI. |
|
| 33 | - */ |
|
| 34 | - public static function canLoad($uri); |
|
| 25 | + /** |
|
| 26 | + * Check whether the loader is able to load a given URI. |
|
| 27 | + * |
|
| 28 | + * @since 0.4.0 |
|
| 29 | + * |
|
| 30 | + * @param string $uri URI to check. |
|
| 31 | + * |
|
| 32 | + * @return bool Whether the loader can load the given URI. |
|
| 33 | + */ |
|
| 34 | + public static function canLoad($uri); |
|
| 35 | 35 | |
| 36 | - /** |
|
| 37 | - * Load the configuration from an URI. |
|
| 38 | - * |
|
| 39 | - * @since 0.4.0 |
|
| 40 | - * |
|
| 41 | - * @param string $uri URI of the resource to load. |
|
| 42 | - * |
|
| 43 | - * @return array|null Data contained within the resource. Null if no data could be loaded/parsed. |
|
| 44 | - * @throws FailedToLoadConfigException If the configuration could not be loaded. |
|
| 45 | - */ |
|
| 46 | - public function load($uri); |
|
| 36 | + /** |
|
| 37 | + * Load the configuration from an URI. |
|
| 38 | + * |
|
| 39 | + * @since 0.4.0 |
|
| 40 | + * |
|
| 41 | + * @param string $uri URI of the resource to load. |
|
| 42 | + * |
|
| 43 | + * @return array|null Data contained within the resource. Null if no data could be loaded/parsed. |
|
| 44 | + * @throws FailedToLoadConfigException If the configuration could not be loaded. |
|
| 45 | + */ |
|
| 46 | + public function load($uri); |
|
| 47 | 47 | } |
@@ -25,76 +25,76 @@ |
||
| 25 | 25 | class PHPLoader extends AbstractLoader |
| 26 | 26 | { |
| 27 | 27 | |
| 28 | - /** |
|
| 29 | - * Check whether the loader is able to load a given URI. |
|
| 30 | - * |
|
| 31 | - * @since 0.4.0 |
|
| 32 | - * |
|
| 33 | - * @param string $uri URI to check. |
|
| 34 | - * |
|
| 35 | - * @return bool Whether the loader can load the given URI. |
|
| 36 | - */ |
|
| 37 | - public static function canLoad($uri) |
|
| 38 | - { |
|
| 39 | - $path = pathinfo($uri); |
|
| 28 | + /** |
|
| 29 | + * Check whether the loader is able to load a given URI. |
|
| 30 | + * |
|
| 31 | + * @since 0.4.0 |
|
| 32 | + * |
|
| 33 | + * @param string $uri URI to check. |
|
| 34 | + * |
|
| 35 | + * @return bool Whether the loader can load the given URI. |
|
| 36 | + */ |
|
| 37 | + public static function canLoad($uri) |
|
| 38 | + { |
|
| 39 | + $path = pathinfo($uri); |
|
| 40 | 40 | |
| 41 | - return 'php' === mb_strtolower($path['extension']); |
|
| 42 | - } |
|
| 41 | + return 'php' === mb_strtolower($path['extension']); |
|
| 42 | + } |
|
| 43 | 43 | |
| 44 | - /** |
|
| 45 | - * Load the contents of an resource identified by an URI. |
|
| 46 | - * |
|
| 47 | - * @since 0.4.0 |
|
| 48 | - * |
|
| 49 | - * @param string $uri URI of the resource. |
|
| 50 | - * |
|
| 51 | - * @return array|null Raw data loaded from the resource. Null if no data found. |
|
| 52 | - * @throws FailedToLoadConfigException If the resource could not be loaded. |
|
| 53 | - */ |
|
| 54 | - protected function loadUri($uri) |
|
| 55 | - { |
|
| 56 | - try { |
|
| 57 | - // Try to load the file through PHP's include(). |
|
| 58 | - // Make sure we don't accidentally create output. |
|
| 59 | - ob_start(); |
|
| 60 | - $data = include($uri); |
|
| 61 | - ob_end_clean(); |
|
| 44 | + /** |
|
| 45 | + * Load the contents of an resource identified by an URI. |
|
| 46 | + * |
|
| 47 | + * @since 0.4.0 |
|
| 48 | + * |
|
| 49 | + * @param string $uri URI of the resource. |
|
| 50 | + * |
|
| 51 | + * @return array|null Raw data loaded from the resource. Null if no data found. |
|
| 52 | + * @throws FailedToLoadConfigException If the resource could not be loaded. |
|
| 53 | + */ |
|
| 54 | + protected function loadUri($uri) |
|
| 55 | + { |
|
| 56 | + try { |
|
| 57 | + // Try to load the file through PHP's include(). |
|
| 58 | + // Make sure we don't accidentally create output. |
|
| 59 | + ob_start(); |
|
| 60 | + $data = include($uri); |
|
| 61 | + ob_end_clean(); |
|
| 62 | 62 | |
| 63 | - return $data; |
|
| 64 | - } catch (Exception $exception) { |
|
| 65 | - throw new FailedToLoadConfigException( |
|
| 66 | - sprintf( |
|
| 67 | - _('Could not include PHP config file "%1$s". Reason: "%2$s".'), |
|
| 68 | - $uri, |
|
| 69 | - $exception->getMessage() |
|
| 70 | - ), |
|
| 71 | - $exception->getCode(), |
|
| 72 | - $exception |
|
| 73 | - ); |
|
| 74 | - } |
|
| 75 | - } |
|
| 63 | + return $data; |
|
| 64 | + } catch (Exception $exception) { |
|
| 65 | + throw new FailedToLoadConfigException( |
|
| 66 | + sprintf( |
|
| 67 | + _('Could not include PHP config file "%1$s". Reason: "%2$s".'), |
|
| 68 | + $uri, |
|
| 69 | + $exception->getMessage() |
|
| 70 | + ), |
|
| 71 | + $exception->getCode(), |
|
| 72 | + $exception |
|
| 73 | + ); |
|
| 74 | + } |
|
| 75 | + } |
|
| 76 | 76 | |
| 77 | - /** |
|
| 78 | - * Validate and return the URI. |
|
| 79 | - * |
|
| 80 | - * @since 0.4.0 |
|
| 81 | - * |
|
| 82 | - * @param string $uri URI of the resource to load. |
|
| 83 | - * |
|
| 84 | - * @return string Validated URI. |
|
| 85 | - * @throws FailedToLoadConfigException If the URI does not exist or is not readable. |
|
| 86 | - */ |
|
| 87 | - protected function validateUri($uri) |
|
| 88 | - { |
|
| 89 | - if (! is_readable($uri)) { |
|
| 90 | - throw new FailedToLoadConfigException( |
|
| 91 | - sprintf( |
|
| 92 | - _('The requested PHP config file "%1$s" does not exist or is not readable.'), |
|
| 93 | - $uri |
|
| 94 | - ) |
|
| 95 | - ); |
|
| 96 | - } |
|
| 77 | + /** |
|
| 78 | + * Validate and return the URI. |
|
| 79 | + * |
|
| 80 | + * @since 0.4.0 |
|
| 81 | + * |
|
| 82 | + * @param string $uri URI of the resource to load. |
|
| 83 | + * |
|
| 84 | + * @return string Validated URI. |
|
| 85 | + * @throws FailedToLoadConfigException If the URI does not exist or is not readable. |
|
| 86 | + */ |
|
| 87 | + protected function validateUri($uri) |
|
| 88 | + { |
|
| 89 | + if (! is_readable($uri)) { |
|
| 90 | + throw new FailedToLoadConfigException( |
|
| 91 | + sprintf( |
|
| 92 | + _('The requested PHP config file "%1$s" does not exist or is not readable.'), |
|
| 93 | + $uri |
|
| 94 | + ) |
|
| 95 | + ); |
|
| 96 | + } |
|
| 97 | 97 | |
| 98 | - return $uri; |
|
| 99 | - } |
|
| 98 | + return $uri; |
|
| 99 | + } |
|
| 100 | 100 | } |
@@ -24,230 +24,230 @@ |
||
| 24 | 24 | class ConfigFactory |
| 25 | 25 | { |
| 26 | 26 | |
| 27 | - /** |
|
| 28 | - * Cached contents of the config files. |
|
| 29 | - * |
|
| 30 | - * @since 0.4.3 |
|
| 31 | - * |
|
| 32 | - * @var array |
|
| 33 | - */ |
|
| 34 | - protected static $configFilesCache = []; |
|
| 35 | - |
|
| 36 | - /** |
|
| 37 | - * Create a new ConfigInterface object from a file. |
|
| 38 | - * |
|
| 39 | - * If a comma-separated list of files is provided, they are checked in sequence until the first one could be loaded |
|
| 40 | - * successfully. |
|
| 41 | - * |
|
| 42 | - * @since 0.3.0 |
|
| 43 | - * |
|
| 44 | - * @param string|array $_ List of files. |
|
| 45 | - * |
|
| 46 | - * @return ConfigInterface Instance of a ConfigInterface implementation. |
|
| 47 | - */ |
|
| 48 | - public static function createFromFile($_) |
|
| 49 | - { |
|
| 50 | - $files = array_reverse(func_get_args()); |
|
| 51 | - |
|
| 52 | - if (is_array($files[0])) { |
|
| 53 | - $files = $files[0]; |
|
| 54 | - } |
|
| 55 | - |
|
| 56 | - while (count($files) > 0) { |
|
| 57 | - try { |
|
| 58 | - $file = array_pop($files); |
|
| 59 | - |
|
| 60 | - if (! is_string($file)) { |
|
| 61 | - continue; |
|
| 62 | - } |
|
| 27 | + /** |
|
| 28 | + * Cached contents of the config files. |
|
| 29 | + * |
|
| 30 | + * @since 0.4.3 |
|
| 31 | + * |
|
| 32 | + * @var array |
|
| 33 | + */ |
|
| 34 | + protected static $configFilesCache = []; |
|
| 35 | + |
|
| 36 | + /** |
|
| 37 | + * Create a new ConfigInterface object from a file. |
|
| 38 | + * |
|
| 39 | + * If a comma-separated list of files is provided, they are checked in sequence until the first one could be loaded |
|
| 40 | + * successfully. |
|
| 41 | + * |
|
| 42 | + * @since 0.3.0 |
|
| 43 | + * |
|
| 44 | + * @param string|array $_ List of files. |
|
| 45 | + * |
|
| 46 | + * @return ConfigInterface Instance of a ConfigInterface implementation. |
|
| 47 | + */ |
|
| 48 | + public static function createFromFile($_) |
|
| 49 | + { |
|
| 50 | + $files = array_reverse(func_get_args()); |
|
| 51 | + |
|
| 52 | + if (is_array($files[0])) { |
|
| 53 | + $files = $files[0]; |
|
| 54 | + } |
|
| 55 | + |
|
| 56 | + while (count($files) > 0) { |
|
| 57 | + try { |
|
| 58 | + $file = array_pop($files); |
|
| 59 | + |
|
| 60 | + if (! is_string($file)) { |
|
| 61 | + continue; |
|
| 62 | + } |
|
| 63 | 63 | |
| 64 | - if (! is_readable($file)) { |
|
| 65 | - continue; |
|
| 66 | - } |
|
| 67 | - |
|
| 68 | - $config = static::createFromArray( |
|
| 69 | - static::getFromCache($file, function ($file) { |
|
| 70 | - return Loader::load($file); |
|
| 71 | - }) |
|
| 72 | - ); |
|
| 73 | - |
|
| 74 | - if (null === $config) { |
|
| 75 | - continue; |
|
| 76 | - } |
|
| 77 | - |
|
| 78 | - return $config; |
|
| 79 | - } catch (Exception $exception) { |
|
| 80 | - // Fail silently and try next file. |
|
| 81 | - } |
|
| 82 | - } |
|
| 83 | - |
|
| 84 | - return static::createFromArray([]); |
|
| 85 | - } |
|
| 86 | - |
|
| 87 | - /** |
|
| 88 | - * Create a new ConfigInterface object from an array. |
|
| 89 | - * |
|
| 90 | - * @since 0.3.0 |
|
| 91 | - * |
|
| 92 | - * @param array $array Array with configuration values. |
|
| 93 | - * |
|
| 94 | - * @return ConfigInterface Instance of a ConfigInterface implementation. |
|
| 95 | - */ |
|
| 96 | - public static function createFromArray(array $array) |
|
| 97 | - { |
|
| 98 | - try { |
|
| 99 | - return new Config($array); |
|
| 100 | - } catch (Exception $exception) { |
|
| 101 | - // Fail silently and try next file. |
|
| 102 | - } |
|
| 103 | - |
|
| 104 | - return null; |
|
| 105 | - } |
|
| 106 | - |
|
| 107 | - /** |
|
| 108 | - * Create a new ConfigInterface object. |
|
| 109 | - * |
|
| 110 | - * Tries to deduce the correct creation method by inspecting the provided arguments. |
|
| 111 | - * |
|
| 112 | - * @since 0.3.0 |
|
| 113 | - * |
|
| 114 | - * @param mixed $_ Array with configuration values. |
|
| 115 | - * |
|
| 116 | - * @return ConfigInterface Instance of a ConfigInterface implementation. |
|
| 117 | - */ |
|
| 118 | - public static function create($_) |
|
| 119 | - { |
|
| 120 | - if (func_num_args() < 1) { |
|
| 121 | - return static::createFromArray([]); |
|
| 122 | - } |
|
| 123 | - |
|
| 124 | - $arguments = func_get_args(); |
|
| 125 | - |
|
| 126 | - if (is_array($arguments[0]) && func_num_args() === 1) { |
|
| 127 | - return static::createFromArray($arguments[0]); |
|
| 128 | - } |
|
| 129 | - |
|
| 130 | - return static::createFromFile($arguments); |
|
| 131 | - } |
|
| 132 | - |
|
| 133 | - /** |
|
| 134 | - * Create a new ConfigInterface object, by merging several files together. |
|
| 135 | - * |
|
| 136 | - * Duplicate keys in later files will override those in earlier files. |
|
| 137 | - * |
|
| 138 | - * @since 0.4.6 |
|
| 139 | - * |
|
| 140 | - * @param mixed $_ Array with configuration values. |
|
| 141 | - * |
|
| 142 | - * @return ConfigInterface Instance of a ConfigInterface implementation. |
|
| 143 | - */ |
|
| 144 | - public static function merge($_) |
|
| 145 | - { |
|
| 146 | - if (func_num_args() < 1) { |
|
| 147 | - return static::createFromArray([]); |
|
| 148 | - } |
|
| 149 | - |
|
| 150 | - $arguments = func_get_args(); |
|
| 151 | - |
|
| 152 | - if (is_array($arguments[0]) && func_num_args() === 1) { |
|
| 153 | - return static::createFromArray($arguments[0]); |
|
| 154 | - } |
|
| 155 | - |
|
| 156 | - return static::mergeFromFiles($arguments); |
|
| 157 | - } |
|
| 158 | - |
|
| 159 | - /** |
|
| 160 | - * Create a new ConfigInterface object by merging data from several files. |
|
| 161 | - * |
|
| 162 | - * If a comma-separated list of files is provided, they are loaded in sequence and later files override settings in |
|
| 163 | - * earlier files. |
|
| 164 | - * |
|
| 165 | - * @since 0.4.6 |
|
| 166 | - * |
|
| 167 | - * @param string|array $_ List of files. |
|
| 168 | - * |
|
| 169 | - * @return ConfigInterface Instance of a ConfigInterface implementation. |
|
| 170 | - */ |
|
| 171 | - public static function mergeFromFiles($_) |
|
| 172 | - { |
|
| 173 | - $files = array_reverse(func_get_args()); |
|
| 174 | - $data = []; |
|
| 175 | - |
|
| 176 | - if (is_array($files[0])) { |
|
| 177 | - $files = array_reverse($files[0]); |
|
| 178 | - } |
|
| 179 | - |
|
| 180 | - while (count($files) > 0) { |
|
| 181 | - try { |
|
| 182 | - $file = array_pop($files); |
|
| 183 | - |
|
| 184 | - if (! is_readable($file)) { |
|
| 185 | - continue; |
|
| 186 | - } |
|
| 187 | - |
|
| 188 | - $new_data = static::getFromCache($file, function ($file) { |
|
| 189 | - return Loader::load($file); |
|
| 190 | - }); |
|
| 191 | - |
|
| 192 | - if (null === $data) { |
|
| 193 | - continue; |
|
| 194 | - } |
|
| 195 | - |
|
| 196 | - $data = array_replace_recursive($data, $new_data); |
|
| 197 | - } catch (Exception $exception) { |
|
| 198 | - // Fail silently and try next file. |
|
| 199 | - } |
|
| 200 | - } |
|
| 201 | - |
|
| 202 | - return static::createFromArray($data); |
|
| 203 | - } |
|
| 204 | - |
|
| 205 | - /** |
|
| 206 | - * Create a new ConfigInterface object from a file and return a sub-portion of it. |
|
| 207 | - * |
|
| 208 | - * The first argument needs to be the file name to load, and the subsequent arguments will be passed on to |
|
| 209 | - * `Config::getSubConfig()`. |
|
| 210 | - * |
|
| 211 | - * @since 0.4.5 |
|
| 212 | - * |
|
| 213 | - * @param mixed $_ File name of the config to load as a string, followed by an array of keys to pass to |
|
| 214 | - * `Config::getSubConfig()`. |
|
| 215 | - * |
|
| 216 | - * @return ConfigInterface Instance of a ConfigInterface implementation. |
|
| 217 | - */ |
|
| 218 | - public static function createSubConfig($_) |
|
| 219 | - { |
|
| 220 | - if (func_num_args() < 2) { |
|
| 221 | - return static::createFromArray([]); |
|
| 222 | - } |
|
| 223 | - |
|
| 224 | - $arguments = func_get_args(); |
|
| 225 | - $file = array_shift($arguments); |
|
| 226 | - |
|
| 227 | - $config = static::createFromFile($file); |
|
| 228 | - |
|
| 229 | - return $config->getSubConfig($arguments); |
|
| 230 | - } |
|
| 231 | - |
|
| 232 | - /** |
|
| 233 | - * Get a config file from the config file cache. |
|
| 234 | - * |
|
| 235 | - * @since 0.4.4 |
|
| 236 | - * |
|
| 237 | - * @param string $identifier Identifier to look for in the cache. |
|
| 238 | - * @param mixed $fallback Fallback to use to fill the cache. If $fallback is a callable, it will be executed |
|
| 239 | - * with $identifier as an argument. |
|
| 240 | - * |
|
| 241 | - * @return mixed The latest content of the cache for the given identifier. |
|
| 242 | - */ |
|
| 243 | - protected static function getFromCache($identifier, $fallback) |
|
| 244 | - { |
|
| 245 | - if (! array_key_exists($identifier, static::$configFilesCache)) { |
|
| 246 | - static::$configFilesCache[$identifier] = is_callable($fallback) |
|
| 247 | - ? $fallback($identifier) |
|
| 248 | - : $fallback; |
|
| 249 | - } |
|
| 250 | - |
|
| 251 | - return static::$configFilesCache[$identifier]; |
|
| 252 | - } |
|
| 64 | + if (! is_readable($file)) { |
|
| 65 | + continue; |
|
| 66 | + } |
|
| 67 | + |
|
| 68 | + $config = static::createFromArray( |
|
| 69 | + static::getFromCache($file, function ($file) { |
|
| 70 | + return Loader::load($file); |
|
| 71 | + }) |
|
| 72 | + ); |
|
| 73 | + |
|
| 74 | + if (null === $config) { |
|
| 75 | + continue; |
|
| 76 | + } |
|
| 77 | + |
|
| 78 | + return $config; |
|
| 79 | + } catch (Exception $exception) { |
|
| 80 | + // Fail silently and try next file. |
|
| 81 | + } |
|
| 82 | + } |
|
| 83 | + |
|
| 84 | + return static::createFromArray([]); |
|
| 85 | + } |
|
| 86 | + |
|
| 87 | + /** |
|
| 88 | + * Create a new ConfigInterface object from an array. |
|
| 89 | + * |
|
| 90 | + * @since 0.3.0 |
|
| 91 | + * |
|
| 92 | + * @param array $array Array with configuration values. |
|
| 93 | + * |
|
| 94 | + * @return ConfigInterface Instance of a ConfigInterface implementation. |
|
| 95 | + */ |
|
| 96 | + public static function createFromArray(array $array) |
|
| 97 | + { |
|
| 98 | + try { |
|
| 99 | + return new Config($array); |
|
| 100 | + } catch (Exception $exception) { |
|
| 101 | + // Fail silently and try next file. |
|
| 102 | + } |
|
| 103 | + |
|
| 104 | + return null; |
|
| 105 | + } |
|
| 106 | + |
|
| 107 | + /** |
|
| 108 | + * Create a new ConfigInterface object. |
|
| 109 | + * |
|
| 110 | + * Tries to deduce the correct creation method by inspecting the provided arguments. |
|
| 111 | + * |
|
| 112 | + * @since 0.3.0 |
|
| 113 | + * |
|
| 114 | + * @param mixed $_ Array with configuration values. |
|
| 115 | + * |
|
| 116 | + * @return ConfigInterface Instance of a ConfigInterface implementation. |
|
| 117 | + */ |
|
| 118 | + public static function create($_) |
|
| 119 | + { |
|
| 120 | + if (func_num_args() < 1) { |
|
| 121 | + return static::createFromArray([]); |
|
| 122 | + } |
|
| 123 | + |
|
| 124 | + $arguments = func_get_args(); |
|
| 125 | + |
|
| 126 | + if (is_array($arguments[0]) && func_num_args() === 1) { |
|
| 127 | + return static::createFromArray($arguments[0]); |
|
| 128 | + } |
|
| 129 | + |
|
| 130 | + return static::createFromFile($arguments); |
|
| 131 | + } |
|
| 132 | + |
|
| 133 | + /** |
|
| 134 | + * Create a new ConfigInterface object, by merging several files together. |
|
| 135 | + * |
|
| 136 | + * Duplicate keys in later files will override those in earlier files. |
|
| 137 | + * |
|
| 138 | + * @since 0.4.6 |
|
| 139 | + * |
|
| 140 | + * @param mixed $_ Array with configuration values. |
|
| 141 | + * |
|
| 142 | + * @return ConfigInterface Instance of a ConfigInterface implementation. |
|
| 143 | + */ |
|
| 144 | + public static function merge($_) |
|
| 145 | + { |
|
| 146 | + if (func_num_args() < 1) { |
|
| 147 | + return static::createFromArray([]); |
|
| 148 | + } |
|
| 149 | + |
|
| 150 | + $arguments = func_get_args(); |
|
| 151 | + |
|
| 152 | + if (is_array($arguments[0]) && func_num_args() === 1) { |
|
| 153 | + return static::createFromArray($arguments[0]); |
|
| 154 | + } |
|
| 155 | + |
|
| 156 | + return static::mergeFromFiles($arguments); |
|
| 157 | + } |
|
| 158 | + |
|
| 159 | + /** |
|
| 160 | + * Create a new ConfigInterface object by merging data from several files. |
|
| 161 | + * |
|
| 162 | + * If a comma-separated list of files is provided, they are loaded in sequence and later files override settings in |
|
| 163 | + * earlier files. |
|
| 164 | + * |
|
| 165 | + * @since 0.4.6 |
|
| 166 | + * |
|
| 167 | + * @param string|array $_ List of files. |
|
| 168 | + * |
|
| 169 | + * @return ConfigInterface Instance of a ConfigInterface implementation. |
|
| 170 | + */ |
|
| 171 | + public static function mergeFromFiles($_) |
|
| 172 | + { |
|
| 173 | + $files = array_reverse(func_get_args()); |
|
| 174 | + $data = []; |
|
| 175 | + |
|
| 176 | + if (is_array($files[0])) { |
|
| 177 | + $files = array_reverse($files[0]); |
|
| 178 | + } |
|
| 179 | + |
|
| 180 | + while (count($files) > 0) { |
|
| 181 | + try { |
|
| 182 | + $file = array_pop($files); |
|
| 183 | + |
|
| 184 | + if (! is_readable($file)) { |
|
| 185 | + continue; |
|
| 186 | + } |
|
| 187 | + |
|
| 188 | + $new_data = static::getFromCache($file, function ($file) { |
|
| 189 | + return Loader::load($file); |
|
| 190 | + }); |
|
| 191 | + |
|
| 192 | + if (null === $data) { |
|
| 193 | + continue; |
|
| 194 | + } |
|
| 195 | + |
|
| 196 | + $data = array_replace_recursive($data, $new_data); |
|
| 197 | + } catch (Exception $exception) { |
|
| 198 | + // Fail silently and try next file. |
|
| 199 | + } |
|
| 200 | + } |
|
| 201 | + |
|
| 202 | + return static::createFromArray($data); |
|
| 203 | + } |
|
| 204 | + |
|
| 205 | + /** |
|
| 206 | + * Create a new ConfigInterface object from a file and return a sub-portion of it. |
|
| 207 | + * |
|
| 208 | + * The first argument needs to be the file name to load, and the subsequent arguments will be passed on to |
|
| 209 | + * `Config::getSubConfig()`. |
|
| 210 | + * |
|
| 211 | + * @since 0.4.5 |
|
| 212 | + * |
|
| 213 | + * @param mixed $_ File name of the config to load as a string, followed by an array of keys to pass to |
|
| 214 | + * `Config::getSubConfig()`. |
|
| 215 | + * |
|
| 216 | + * @return ConfigInterface Instance of a ConfigInterface implementation. |
|
| 217 | + */ |
|
| 218 | + public static function createSubConfig($_) |
|
| 219 | + { |
|
| 220 | + if (func_num_args() < 2) { |
|
| 221 | + return static::createFromArray([]); |
|
| 222 | + } |
|
| 223 | + |
|
| 224 | + $arguments = func_get_args(); |
|
| 225 | + $file = array_shift($arguments); |
|
| 226 | + |
|
| 227 | + $config = static::createFromFile($file); |
|
| 228 | + |
|
| 229 | + return $config->getSubConfig($arguments); |
|
| 230 | + } |
|
| 231 | + |
|
| 232 | + /** |
|
| 233 | + * Get a config file from the config file cache. |
|
| 234 | + * |
|
| 235 | + * @since 0.4.4 |
|
| 236 | + * |
|
| 237 | + * @param string $identifier Identifier to look for in the cache. |
|
| 238 | + * @param mixed $fallback Fallback to use to fill the cache. If $fallback is a callable, it will be executed |
|
| 239 | + * with $identifier as an argument. |
|
| 240 | + * |
|
| 241 | + * @return mixed The latest content of the cache for the given identifier. |
|
| 242 | + */ |
|
| 243 | + protected static function getFromCache($identifier, $fallback) |
|
| 244 | + { |
|
| 245 | + if (! array_key_exists($identifier, static::$configFilesCache)) { |
|
| 246 | + static::$configFilesCache[$identifier] = is_callable($fallback) |
|
| 247 | + ? $fallback($identifier) |
|
| 248 | + : $fallback; |
|
| 249 | + } |
|
| 250 | + |
|
| 251 | + return static::$configFilesCache[$identifier]; |
|
| 252 | + } |
|
| 253 | 253 | } |