Loader::shouldAutoBoot() - Code Metrics - Inspection of "Add some more badges to README" - monospice/laravel-redis-sentinel-drivers - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — 2.x ( 05606d...5f461e )

by Cy

created 2019-08-17 06:50 UTC

Loader::shouldAutoBoot() A

↳ Parent: Loader

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	4
rs	10
c	0
b	0
f	0
cc	1
nc	1
nop	0

<?php

namespace Monospice\LaravelRedisSentinel\Configuration;

use Illuminate\Foundation\Application as LaravelApplication;
use Illuminate\Support\Arr;
use Laravel\Horizon\Horizon;
use Laravel\Lumen\Application as LumenApplication;
use Monospice\LaravelRedisSentinel\Configuration\HostNormalizer;
use Monospice\LaravelRedisSentinel\Manager;
use UnexpectedValueException;

/**
 * The internal configuration loader for the package. Used by the package's
 * service provider.
 *
 * This package provides developers three ways to configure it: through the
 * environment, by adding config values to the configuration for the other
 * components that the package wraps, and by creating an external package
 * configuration file that overrides the default internal configuration.
 * The package uses its configuration information to set Redis connection,
 * cache, session, and queue configuration values when these are missing.
 * This approach simplifies the code needed to configure the package for many
 * applications while still providing the flexibility needed for advanced
 * setups. This class reconciles each of the configuration methods.
 *
 * The package's configuration contains partial elements from several other
 * component configurations. By default, the package removes its configuration
 * after merging the values into each of the appropriate config locations for
 * the components it initializes. This behavior prevents the artisan CLI's
 * "config:cache" command from saving unnecessary configuration values to the
 * configuration cache file. Set the value of "redis-sentinel.clean_config" to
 * FALSE to disable this behavior.
 *
 * To support these configuration scenarios, this class follows these rules:
 *
 *   - Values in application config files ("config/database.php", etc.) have
 *     the greatest precedence. The package will use these values before any
 *     others and will not modify these values if they exist.
 *   - The package will use values in a developer-supplied package config file
 *     located in the application's "config/" directory with the filename of
 *     "redis-sentinel.php" for any values not found in the application's
 *     standard configuration files before using it's default configuration.
 *   - For any configuration values not provided by standard application
 *     config files or a developer-supplied custom config file, the package
 *     uses it's internal default configuration that reads configuration values
 *     from environment variables.
 *   - The package will copy values from it's configuration to the standard
 *     application configuration at runtime if these are missing. For example,
 *     if the application configuration doesn't contain a key for "database.
 *     redis-sentinel" (the Redis Sentinel connections), this class will copy
 *     its values from "redis-sentinel.database.redis-sentinel" to "database.
 *     redis-sentinel".
 *   - After loading its configuration, the package must only use configuration
 *     values from the standard application config locations. For example, the
 *     package will read the values from "database.redis-sentinel" to configure
 *     Redis Sentinel connections, not "redis-sentinel.database.redis-sentinel".
 *
 * @category Package
 * @package  Monospice\LaravelRedisSentinel
 * @author   Cy Rossignol <[email protected]>
 * @license  See LICENSE file
 * @link     https://github.com/monospice/laravel-redis-sentinel-drivers
 */
class Loader
{
    /**
     * The path to the package's default configuration file.
     *
     * @var string
     */
    const CONFIG_PATH = __DIR__ . '/../../config/redis-sentinel.php';

    /**
     * Flag that indicates whether the package should check that the framework
     * runs full Laravel before loading Horizon support.
     *
     * Horizon does not yet officially support Lumen applications, so the
     * package will not configure itself for Horizon in Lumen applications by
     * default. Set this value to TRUE in bootstrap/app.php to short-circuit
     * the check and attempt to load Horizon support anyway. This provides for
     * testing unofficial Lumen implementations. Use at your own risk.
     *
     * @var bool
     */
    public static $ignoreHorizonRequirements = false;

    /**
     * Indicates whether the current application runs the Lumen framework.
     *
     * @var bool
     */
    public $isLumen;

    /**
     * Indicates whether the current application supports sessions.
     *
     * @var bool
     */
    public $supportsSessions;

    /**
     * Indicates whether the package should override Laravel's standard Redis
     * API ("Redis" facade and "redis" service binding).
     *
     * @var bool
     */
    public $shouldOverrideLaravelRedisApi;

    /**
     * Indicates whether Laravel Horizon is installed. Currently FALSE in Lumen.
     *
     * @var bool
     */
    public $horizonAvailable;

    /**
     * Indicates whether the package should integrate with Laravel Horizon
     * based on availability and the value of the "horizon.driver" directive.
     *
     * @var bool
     */
    public $shouldIntegrateHorizon;

    /**
     * The current Laravel or Lumen application instance that provides context
     * and services used to load the appropriate configuration.
     *
     * @var LaravelApplication|LumenApplication
     */
    private $app;

    /**
     * Used to fetch and set application configuration values.
     *
     * @var \Illuminate\Contracts\Config\Repository
     */
    private $config;

    /**
     * Contains the set of configuration values used to configure the package
     * as loaded from "config/redis-sentinel.php". Empty when the application's
     * standard config files provide all the values needed to configure the
     * package (such as when a developer provides a custom config).
     *
     * @var array
     */
    private $packageConfig;

    /**
     * Initialize the configuration loader. Any actual loading occurs when
     * calling the 'loadConfiguration()' method.
     *
     * @param LaravelApplication|LumenApplication $app The current application
     * instance that provides context and services needed to load the
     * appropriate configuration.
     */
    public function __construct($app)
    {
        $this->app = $app;
        $this->config = $app->make('config');

        $lumenApplicationClass = 'Laravel\Lumen\Application';

        $this->isLumen = $app instanceof $lumenApplicationClass;
        $this->supportsSessions = $app->bound('session');
        $this->horizonAvailable = static::$ignoreHorizonRequirements
            || ! $this->isLumen && class_exists(Horizon::class);
    }

    /**
     * Create an instance of the loader and load the configuration in one step.
     *
     * @param LaravelApplication|LumenApplication $app The current application
     * instance that provides context and services needed to load the
     * appropriate configuration.
     *
     * @return self An initialized instance of this class
     */
    public static function load($app)
    {
        $loader = new self($app);
        $loader->loadConfiguration();

        return $loader;
    }

    /**
     * Load the package configuration.
     *
     * @return void
     */
    public function loadConfiguration()
    {
        if ($this->shouldLoadConfiguration()) {
            $this->loadPackageConfiguration();
        }

        // Previous versions of the package looked for the value 'sentinel':
        $redisDriver = $this->config->get('database.redis.driver');
        $this->shouldOverrideLaravelRedisApi = $redisDriver === 'redis-sentinel'
            || $redisDriver === 'sentinel';

        $this->shouldIntegrateHorizon = $this->horizonAvailable
            && $this->config->get('horizon.driver') === 'redis-sentinel';
    }

    /**
     * Sets the Horizon Redis Sentinel connection configuration.
     *
     * @return void
     */
    public function loadHorizonConfiguration()
    {
        // We set the config value "redis-sentinel.load_horizon" to FALSE after
        // configuring Horizon connections to skip this step after caching the
        // application configuration via "artisan config:cache":
        if ($this->config->get('redis-sentinel.load_horizon', true) !== true) {
            return;
        }

        $horizonConfig = $this->getSelectedHorizonConnectionConfiguration();
        $options = Arr::get($horizonConfig, 'options', [ ]);
        $options['prefix'] = $this->config->get('horizon.prefix', 'horizon:');

        $horizonConfig['options'] = $options;

        $this->config->set('database.redis-sentinel.horizon', $horizonConfig);
        $this->config->set('redis-sentinel.load_horizon', false);
    }

    /**
     * Get the version number of the current Laravel or Lumen application.
     *
     * @return string The version as declared by the framework.
     */
    public function getApplicationVersion()
    {
        if ($this->isLumen) {
            return substr($this->app->version(), 7, 3); // ex. "5.4"
        }

        return \Illuminate\Foundation\Application::VERSION;
    }

    /**
     * Fetch the specified application configuration value.
     *
     * This helper method enables the package's service providers to get config
     * values without having to resolve the config service from the container.
     *
     * @param string|array $key     The key(s) for the value(s) to fetch.
     * @param mixed        $default Returned if the key does not exist.
     *
     * @return mixed The requested configuration value or the provided default
     * if the key does not exist.
     */
    public function get($key, $default = null)
    {
        return $this->config->get($key, $default);
    }

    /**
     * Set the specified application configuration value.
     *
     * This helper method enables the package's service providers to set config
     * values without having to resolve the config service from the container.
     *
     * @param string|array $key   The key of the value or a tree of values as
     * an associative array.
     * @param mixed        $value The value to set for the specified key.
     *
     * @return void
     */
    public function set($key, $value = null)
    {
        $this->config->set($key, $value);
    }

    /**
     * Determine whether the package service provider should immediately boot
     * the package services following the registration phase.
     *
     * Some third-party packages contain service providers that don't follow
     * Laravel's boostrapping convention. These may reference this package's
     * Sentinel drivers (cache, session, etc.) during the registration phase
     * before this service provider finishes binding those in the boot phase
     * afterward. An application can overcome the issue by setting the value
     * of "redis-sentinel.auto_boot" to TRUE so that this provider boots the
     * package's drivers during the registration phase.
     *
     * @return bool TRUE if the package is explicitly configured to auto-boot.
     */
    public function shouldAutoBoot()
    {
        return $this->config->get('redis-sentinel.auto_boot', false);
    }

    /**
     * Determine if the package should automatically configure itself.
     *
     * Developers may set the value of "redis-sentinel.load_config" to FALSE to
     * disable the package's automatic configuration. This class also sets this
     * value to FALSE after loading the package configuration to skip the auto-
     * configuration when the application cached its configuration values (via
     * "artisan config:cache", for example).
     *
     * @return bool TRUE if the package should load its configuration
     */
    protected function shouldLoadConfiguration()
    {
        if ($this->isLumen) {
            $this->app->configure('redis-sentinel');
        }

        return $this->config->get('redis-sentinel.load_config', true) === true;
    }

    /**
     * Configure the Lumen components that this package depends on.
     *
     * Lumen lazily loads many of its components. We must instruct Lumen to
     * load the configuration for components that this class configures so
     * that the values are accessible and so that the framework does not
     * revert the configuration settings that this class changes when one of
     * the components initializes later.
     *
     * @return void
     */
    protected function configureLumenComponents()
    {
        $this->app->configure('database');
        $this->app->configure('broadcasting');
        $this->app->configure('cache');
        $this->app->configure('queue');
    }

    /**
     * Copy the Redis Sentinel connection configuration to use for Horizon
     * connections from the connection specified by "horizon.use".
     *
     * @return array The configuration matching the connection name specified
     * by the "horizon.use" config directive.
     *
     * @throws UnexpectedValueException If no Redis Sentinel connection matches
     * the name declared by "horizon.use".
     */
    protected function getSelectedHorizonConnectionConfiguration()
    {
        $use = $this->config->get('horizon.use', 'default');
        $connectionConfig = $this->config->get("database.redis-sentinel.$use");

        if ($connectionConfig === null) {
            throw new UnexpectedValueException(
                "The Horizon Redis Sentinel connection [$use] is not defined."
            );
        }

        return $connectionConfig;
    }

    /**
     * Reconcile the package configuration and use it to set the appropriate
     * configuration values for other application components.
     *
     * @return void
     */
    protected function loadPackageConfiguration()
    {
        if ($this->isLumen) {
            $this->configureLumenComponents();
        }

        $this->setConfigurationFor('database.redis-sentinel');
        $this->setConfigurationFor('database.redis.driver');
        $this->setConfigurationFor('broadcasting.connections.redis-sentinel');
        $this->setConfigurationFor('cache.stores.redis-sentinel');
        $this->setConfigurationFor('queue.connections.redis-sentinel');
        $this->setSessionConfiguration();

        $this->normalizeHosts();

        $this->cleanPackageConfiguration();
    }

    /**
     * Set the application configuration value for the specified key with the
     * value from the package configuration.
     *
     * @param string $configKey   The key of the config value to set. Should
     * correspond to a key in the package's configuration.
     * @param bool   $checkExists If TRUE, don't set the value if the key
     * already exists in the application configuration.
     *
     * @return void
     */
    protected function setConfigurationFor($configKey, $checkExists = true)
    {
        if ($checkExists && $this->config->has($configKey)) {
            return;
        }

        $config = $this->getPackageConfigurationFor($configKey);

        $this->config->set($configKey, $config);
    }

    /**
     * Set the application session configuration as specified by the package's
     * configuration if the app supports sessions.
     *
     * @return void
     */
    protected function setSessionConfiguration()
    {
        if (! $this->supportsSessions
            || $this->config->get('session.driver') !== 'redis-sentinel'
            || $this->config->get('session.connection') !== null
        ) {
            return;
        }

        $this->setConfigurationFor('session.connection', false);
    }

    /**
     * Get the package configuration for the specified key.
     *
     * @param string $configKey The key of the configuration value to get
     *
     * @return mixed The value of the configuration with the specified key
     */
    protected function getPackageConfigurationFor($configKey)
    {
        if ($this->packageConfig === null) {
            $this->mergePackageConfiguration();
        }

        return Arr::get($this->packageConfig, $configKey);
    }

    /**
     * Merge the package's default configuration with the override config file
     * supplied by the developer, if any.
     *
     * @return void
     */
    protected function mergePackageConfiguration()
    {
        $defaultConfig = require self::CONFIG_PATH;
        $currentConfig = $this->config->get('redis-sentinel', [ ]);

        $this->packageConfig = array_merge($defaultConfig, $currentConfig);
    }

    /**
     * Parse Redis Sentinel connection host definitions to create single host
     * entries for host definitions that specify multiple hosts.
     *
     * @return void
     */
    protected function normalizeHosts()
    {
        $connections = $this->config->get('database.redis-sentinel');

        if (! is_array($connections)) {
            return;
        }

        $this->config->set(
            'database.redis-sentinel',
            HostNormalizer::normalizeConnections($connections)
        );
    }

    /**
     * Remove the package's configuration from the application configuration
     * repository.
     *
     * This package's configuration contains partial elements from several
     * other component configurations. By default, the package removes its
     * configuration after merging the values into each of the appropriate
     * config locations for the components it initializes. This behavior
     * prevents the artisan "config:cache" command from saving unnecessary
     * configuration values to the cache file.
     *
     * @return void
     */
    protected function cleanPackageConfiguration()
    {
        // When we're finished with the internal package configuration, break
        // the reference so that it can be garbage-collected:
        $this->packageConfig = null;

        if ($this->config->get('redis-sentinel.clean_config', true) === true) {
            $this->config->set('redis-sentinel', [
                'auto_boot' => $this->shouldAutoBoot(),
                'Config merged. Set redis-sentinel.clean_config=false to keep.',
            ]);
        }

        // Skip loading package config when cached:
        $this->config->set('redis-sentinel.load_config', false);
    }
}


1			<?php
2
3			namespace Monospice\LaravelRedisSentinel\Configuration;
4
5			use Illuminate\Foundation\Application as LaravelApplication;
6			use Illuminate\Support\Arr;
7			use Laravel\Horizon\Horizon;
8			use Laravel\Lumen\Application as LumenApplication;
9			use Monospice\LaravelRedisSentinel\Configuration\HostNormalizer;
10			use Monospice\LaravelRedisSentinel\Manager;
11			use UnexpectedValueException;
12
13			/**
14			* The internal configuration loader for the package. Used by the package's
15			* service provider.
16			*
17			* This package provides developers three ways to configure it: through the
18			* environment, by adding config values to the configuration for the other
19			* components that the package wraps, and by creating an external package
20			* configuration file that overrides the default internal configuration.
21			* The package uses its configuration information to set Redis connection,
22			* cache, session, and queue configuration values when these are missing.
23			* This approach simplifies the code needed to configure the package for many
24			* applications while still providing the flexibility needed for advanced
25			* setups. This class reconciles each of the configuration methods.
26			*
27			* The package's configuration contains partial elements from several other
28			* component configurations. By default, the package removes its configuration
29			* after merging the values into each of the appropriate config locations for
30			* the components it initializes. This behavior prevents the artisan CLI's
31			* "config:cache" command from saving unnecessary configuration values to the
32			* configuration cache file. Set the value of "redis-sentinel.clean_config" to
33			* FALSE to disable this behavior.
34			*
35			* To support these configuration scenarios, this class follows these rules:
36			*
37			* - Values in application config files ("config/database.php", etc.) have
38			* the greatest precedence. The package will use these values before any
39			* others and will not modify these values if they exist.
40			* - The package will use values in a developer-supplied package config file
41			* located in the application's "config/" directory with the filename of
42			* "redis-sentinel.php" for any values not found in the application's
43			* standard configuration files before using it's default configuration.
44			* - For any configuration values not provided by standard application
45			* config files or a developer-supplied custom config file, the package
46			* uses it's internal default configuration that reads configuration values
47			* from environment variables.
48			* - The package will copy values from it's configuration to the standard
49			* application configuration at runtime if these are missing. For example,
50			* if the application configuration doesn't contain a key for "database.
51			* redis-sentinel" (the Redis Sentinel connections), this class will copy
52			* its values from "redis-sentinel.database.redis-sentinel" to "database.
53			* redis-sentinel".
54			* - After loading its configuration, the package must only use configuration
55			* values from the standard application config locations. For example, the
56			* package will read the values from "database.redis-sentinel" to configure
57			* Redis Sentinel connections, not "redis-sentinel.database.redis-sentinel".
58			*
59			* @category Package
60			* @package Monospice\LaravelRedisSentinel
61			* @author Cy Rossignol <[email protected]>
62			* @license See LICENSE file
63			* @link https://github.com/monospice/laravel-redis-sentinel-drivers
64			*/
65			class Loader
66			{
67			/**
68			* The path to the package's default configuration file.
69			*
70			* @var string
71			*/
72			const CONFIG_PATH = __DIR__ . '/../../config/redis-sentinel.php';
73
74			/**
75			* Flag that indicates whether the package should check that the framework
76			* runs full Laravel before loading Horizon support.
77			*
78			* Horizon does not yet officially support Lumen applications, so the
79			* package will not configure itself for Horizon in Lumen applications by
80			* default. Set this value to TRUE in bootstrap/app.php to short-circuit
81			* the check and attempt to load Horizon support anyway. This provides for
82			* testing unofficial Lumen implementations. Use at your own risk.
83			*
84			* @var bool
85			*/
86			public static $ignoreHorizonRequirements = false;
87
88			/**
89			* Indicates whether the current application runs the Lumen framework.
90			*
91			* @var bool
92			*/
93			public $isLumen;
94
95			/**
96			* Indicates whether the current application supports sessions.
97			*
98			* @var bool
99			*/
100			public $supportsSessions;
101
102			/**
103			* Indicates whether the package should override Laravel's standard Redis
104			* API ("Redis" facade and "redis" service binding).
105			*
106			* @var bool
107			*/
108			public $shouldOverrideLaravelRedisApi;
109
110			/**
111			* Indicates whether Laravel Horizon is installed. Currently FALSE in Lumen.
112			*
113			* @var bool
114			*/
115			public $horizonAvailable;
116
117			/**
118			* Indicates whether the package should integrate with Laravel Horizon
119			* based on availability and the value of the "horizon.driver" directive.
120			*
121			* @var bool
122			*/
123			public $shouldIntegrateHorizon;
124
125			/**
126			* The current Laravel or Lumen application instance that provides context
127			* and services used to load the appropriate configuration.
128			*
129			* @var LaravelApplication\|LumenApplication
130			*/
131			private $app;
132
133			/**
134			* Used to fetch and set application configuration values.
135			*
136			* @var \Illuminate\Contracts\Config\Repository
137			*/
138			private $config;
139
140			/**
141			* Contains the set of configuration values used to configure the package
142			* as loaded from "config/redis-sentinel.php". Empty when the application's
143			* standard config files provide all the values needed to configure the
144			* package (such as when a developer provides a custom config).
145			*
146			* @var array
147			*/
148			private $packageConfig;
149
150			/**
151			* Initialize the configuration loader. Any actual loading occurs when
152			* calling the 'loadConfiguration()' method.
153			*
154			* @param LaravelApplication\|LumenApplication $app The current application
155			* instance that provides context and services needed to load the
156			* appropriate configuration.
157			*/
158			public function __construct($app)
159			{
160			$this->app = $app;
161			$this->config = $app->make('config');
162
163			$lumenApplicationClass = 'Laravel\Lumen\Application';
164
165			$this->isLumen = $app instanceof $lumenApplicationClass;
166			$this->supportsSessions = $app->bound('session');
167			$this->horizonAvailable = static::$ignoreHorizonRequirements
168			\|\| ! $this->isLumen && class_exists(Horizon::class);
169			}
170
171			/**
172			* Create an instance of the loader and load the configuration in one step.
173			*
174			* @param LaravelApplication\|LumenApplication $app The current application
175			* instance that provides context and services needed to load the
176			* appropriate configuration.
177			*
178			* @return self An initialized instance of this class
179			*/
180			public static function load($app)
181			{
182			$loader = new self($app);
183			$loader->loadConfiguration();
184
185			return $loader;
186			}
187
188			/**
189			* Load the package configuration.
190			*
191			* @return void
192			*/
193			public function loadConfiguration()
194			{
195			if ($this->shouldLoadConfiguration()) {
196			$this->loadPackageConfiguration();
197			}
198
199			// Previous versions of the package looked for the value 'sentinel':
200			$redisDriver = $this->config->get('database.redis.driver');
201			$this->shouldOverrideLaravelRedisApi = $redisDriver === 'redis-sentinel'
202			\|\| $redisDriver === 'sentinel';
203
204			$this->shouldIntegrateHorizon = $this->horizonAvailable
205			&& $this->config->get('horizon.driver') === 'redis-sentinel';
206			}
207
208			/**
209			* Sets the Horizon Redis Sentinel connection configuration.
210			*
211			* @return void
212			*/
213			public function loadHorizonConfiguration()
214			{
215			// We set the config value "redis-sentinel.load_horizon" to FALSE after
216			// configuring Horizon connections to skip this step after caching the
217			// application configuration via "artisan config:cache":
218			if ($this->config->get('redis-sentinel.load_horizon', true) !== true) {
219			return;
220			}
221
222			$horizonConfig = $this->getSelectedHorizonConnectionConfiguration();
223			$options = Arr::get($horizonConfig, 'options', [ ]);
224			$options['prefix'] = $this->config->get('horizon.prefix', 'horizon:');
225
226			$horizonConfig['options'] = $options;
227
228			$this->config->set('database.redis-sentinel.horizon', $horizonConfig);
229			$this->config->set('redis-sentinel.load_horizon', false);
230			}
231
232			/**
233			* Get the version number of the current Laravel or Lumen application.
234			*
235			* @return string The version as declared by the framework.
236			*/
237			public function getApplicationVersion()
238			{
239			if ($this->isLumen) {
240			return substr($this->app->version(), 7, 3); // ex. "5.4"
241			}
242
243			return \Illuminate\Foundation\Application::VERSION;
244			}
245
246			/**
247			* Fetch the specified application configuration value.
248			*
249			* This helper method enables the package's service providers to get config
250			* values without having to resolve the config service from the container.
251			*
252			* @param string\|array $key The key(s) for the value(s) to fetch.
253			* @param mixed $default Returned if the key does not exist.
254			*
255			* @return mixed The requested configuration value or the provided default
256			* if the key does not exist.
257			*/
258			public function get($key, $default = null)
259			{
260			return $this->config->get($key, $default);
261			}
262
263			/**
264			* Set the specified application configuration value.
265			*
266			* This helper method enables the package's service providers to set config
267			* values without having to resolve the config service from the container.
268			*
269			* @param string\|array $key The key of the value or a tree of values as
270			* an associative array.
271			* @param mixed $value The value to set for the specified key.
272			*
273			* @return void
274			*/
275			public function set($key, $value = null)
276			{
277			$this->config->set($key, $value);
278			}
279
280			/**
281			* Determine whether the package service provider should immediately boot
282			* the package services following the registration phase.
283			*
284			* Some third-party packages contain service providers that don't follow
285			* Laravel's boostrapping convention. These may reference this package's
286			* Sentinel drivers (cache, session, etc.) during the registration phase
287			* before this service provider finishes binding those in the boot phase
288			* afterward. An application can overcome the issue by setting the value
289			* of "redis-sentinel.auto_boot" to TRUE so that this provider boots the
290			* package's drivers during the registration phase.
291			*
292			* @return bool TRUE if the package is explicitly configured to auto-boot.
293			*/
294			public function shouldAutoBoot()
295			{
296			return $this->config->get('redis-sentinel.auto_boot', false);
297			}
298
299			/**
300			* Determine if the package should automatically configure itself.
301			*
302			* Developers may set the value of "redis-sentinel.load_config" to FALSE to
303			* disable the package's automatic configuration. This class also sets this
304			* value to FALSE after loading the package configuration to skip the auto-
305			* configuration when the application cached its configuration values (via
306			* "artisan config:cache", for example).
307			*
308			* @return bool TRUE if the package should load its configuration
309			*/
310			protected function shouldLoadConfiguration()
311			{
312			if ($this->isLumen) {
313			$this->app->configure('redis-sentinel');
314			}
315
316			return $this->config->get('redis-sentinel.load_config', true) === true;
317			}
318
319			/**
320			* Configure the Lumen components that this package depends on.
321			*
322			* Lumen lazily loads many of its components. We must instruct Lumen to
323			* load the configuration for components that this class configures so
324			* that the values are accessible and so that the framework does not
325			* revert the configuration settings that this class changes when one of
326			* the components initializes later.
327			*
328			* @return void
329			*/
330			protected function configureLumenComponents()
331			{
332			$this->app->configure('database');
333			$this->app->configure('broadcasting');
334			$this->app->configure('cache');
335			$this->app->configure('queue');
336			}
337
338			/**
339			* Copy the Redis Sentinel connection configuration to use for Horizon
340			* connections from the connection specified by "horizon.use".
341			*
342			* @return array The configuration matching the connection name specified
343			* by the "horizon.use" config directive.
344			*
345			* @throws UnexpectedValueException If no Redis Sentinel connection matches
346			* the name declared by "horizon.use".
347			*/
348			protected function getSelectedHorizonConnectionConfiguration()
349			{
350			$use = $this->config->get('horizon.use', 'default');
351			$connectionConfig = $this->config->get("database.redis-sentinel.$use");
352
353			if ($connectionConfig === null) {
354			throw new UnexpectedValueException(
355			"The Horizon Redis Sentinel connection [$use] is not defined."
356			);
357			}
358
359			return $connectionConfig;
360			}
361
362			/**
363			* Reconcile the package configuration and use it to set the appropriate
364			* configuration values for other application components.
365			*
366			* @return void
367			*/
368			protected function loadPackageConfiguration()
369			{
370			if ($this->isLumen) {
371			$this->configureLumenComponents();
372			}
373
374			$this->setConfigurationFor('database.redis-sentinel');
375			$this->setConfigurationFor('database.redis.driver');
376			$this->setConfigurationFor('broadcasting.connections.redis-sentinel');
377			$this->setConfigurationFor('cache.stores.redis-sentinel');
378			$this->setConfigurationFor('queue.connections.redis-sentinel');
379			$this->setSessionConfiguration();
380
381			$this->normalizeHosts();
382
383			$this->cleanPackageConfiguration();
384			}
385
386			/**
387			* Set the application configuration value for the specified key with the
388			* value from the package configuration.
389			*
390			* @param string $configKey The key of the config value to set. Should
391			* correspond to a key in the package's configuration.
392			* @param bool $checkExists If TRUE, don't set the value if the key
393			* already exists in the application configuration.
394			*
395			* @return void
396			*/
397			protected function setConfigurationFor($configKey, $checkExists = true)
398			{
399			if ($checkExists && $this->config->has($configKey)) {
400			return;
401			}
402
403			$config = $this->getPackageConfigurationFor($configKey);
404
405			$this->config->set($configKey, $config);
406			}
407
408			/**
409			* Set the application session configuration as specified by the package's
410			* configuration if the app supports sessions.
411			*
412			* @return void
413			*/
414			protected function setSessionConfiguration()
415			{
416			if (! $this->supportsSessions
417			\|\| $this->config->get('session.driver') !== 'redis-sentinel'
418			\|\| $this->config->get('session.connection') !== null
419			) {
420			return;
421			}
422
423			$this->setConfigurationFor('session.connection', false);
424			}
425
426			/**
427			* Get the package configuration for the specified key.
428			*
429			* @param string $configKey The key of the configuration value to get
430			*
431			* @return mixed The value of the configuration with the specified key
432			*/
433			protected function getPackageConfigurationFor($configKey)
434			{
435			if ($this->packageConfig === null) {
436			$this->mergePackageConfiguration();
437			}
438
439			return Arr::get($this->packageConfig, $configKey);
440			}
441
442			/**
443			* Merge the package's default configuration with the override config file
444			* supplied by the developer, if any.
445			*
446			* @return void
447			*/
448			protected function mergePackageConfiguration()
449			{
450			$defaultConfig = require self::CONFIG_PATH;
451			$currentConfig = $this->config->get('redis-sentinel', [ ]);
452
453			$this->packageConfig = array_merge($defaultConfig, $currentConfig);
454			}
455
456			/**
457			* Parse Redis Sentinel connection host definitions to create single host
458			* entries for host definitions that specify multiple hosts.
459			*
460			* @return void
461			*/
462			protected function normalizeHosts()
463			{
464			$connections = $this->config->get('database.redis-sentinel');
465
466			if (! is_array($connections)) {
467			return;
468			}
469
470			$this->config->set(
471			'database.redis-sentinel',
472			HostNormalizer::normalizeConnections($connections)
473			);
474			}
475
476			/**
477			* Remove the package's configuration from the application configuration
478			* repository.
479			*
480			* This package's configuration contains partial elements from several
481			* other component configurations. By default, the package removes its
482			* configuration after merging the values into each of the appropriate
483			* config locations for the components it initializes. This behavior
484			* prevents the artisan "config:cache" command from saving unnecessary
485			* configuration values to the cache file.
486			*
487			* @return void
488			*/
489			protected function cleanPackageConfiguration()
490			{
491			// When we're finished with the internal package configuration, break
492			// the reference so that it can be garbage-collected:
493			$this->packageConfig = null;
494
495			if ($this->config->get('redis-sentinel.clean_config', true) === true) {
496			$this->config->set('redis-sentinel', [
497			'auto_boot' => $this->shouldAutoBoot(),
498			'Config merged. Set redis-sentinel.clean_config=false to keep.',
499			]);
500			}
501
502			// Skip loading package config when cached:
503			$this->config->set('redis-sentinel.load_config', false);
504			}
505			}
506

monospice / laravel-redis-sentinel-drivers

Push — 2.x ( 05606d...5f461e )

Loader::shouldAutoBoot() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like