Config::getSubscriberPaths() - Code Metrics - Inspection of "Add firing of events when migration and rollback h..." - cakephp/phinx - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#1382)

unknown

created 2018-06-19 13:38 UTC

Config::getSubscriberPaths() A

↳ Parent: Config

Complexity

Conditions	2
Paths	2

Size

Total Lines	8
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	3
CRAP Score	2

Importance

Changes

Metric	Value
dl	0
loc	8
ccs	3
cts	3
cp	1
rs	9.4285
c	0
b	0
f	0
cc	2
eloc	4
nc	2
nop	0
crap	2

<?php
/**
 * Phinx
 *
 * (The MIT license)
 * Copyright (c) 2015 Rob Morgan
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated * documentation files (the "Software"), to
 * deal in the Software without restriction, including without limitation the
 * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
 * sell copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
 * IN THE SOFTWARE.
 *
 * @package    Phinx
 * @subpackage Phinx\Config
 */
namespace Phinx\Config;

use Symfony\Component\Yaml\Yaml;

/**
 * Phinx configuration class.
 *
 * @package Phinx
 * @author Rob Morgan
 */
class Config implements ConfigInterface, NamespaceAwareInterface
{
    use NamespaceAwareTrait;

    /**
     * The value that identifies a version order by creation time.
     */
    const VERSION_ORDER_CREATION_TIME = 'creation';

    /**
     * The value that identifies a version order by execution time.
     */
    const VERSION_ORDER_EXECUTION_TIME = 'execution';

    /**
     * @var array
     */
    private $values = [];

    /**
     * @var string
     */
    protected $configFilePath;

    /**
     * {@inheritdoc}
     */
    public function __construct(array $configArray, $configFilePath = null)
    {
        $this->configFilePath = $configFilePath;
        $this->values = $this->replaceTokens($configArray);
    }

    /**
     * Create a new instance of the config class using a Yaml file path.
     *
     * @param  string $configFilePath Path to the Yaml File
     * @throws \RuntimeException
     * @return \Phinx\Config\Config
     */
    public static function fromYaml($configFilePath)

    {
        $configFile = file_get_contents($configFilePath);
        $configArray = Yaml::parse($configFile);

        if (!is_array($configArray)) {
            throw new \RuntimeException(sprintf(
                'File \'%s\' must be valid YAML',
                $configFilePath
            ));
        }

        return new static($configArray, $configFilePath);
    }

    /**
     * Create a new instance of the config class using a JSON file path.
     *
     * @param  string $configFilePath Path to the JSON File
     * @throws \RuntimeException
     * @return \Phinx\Config\Config
     */
    public static function fromJson($configFilePath)

    {
        $configArray = json_decode(file_get_contents($configFilePath), true);
        if (!is_array($configArray)) {
            throw new \RuntimeException(sprintf(
                'File \'%s\' must be valid JSON',
                $configFilePath
            ));
        }

        return new static($configArray, $configFilePath);
    }

    /**
     * Create a new instance of the config class using a PHP file path.
     *
     * @param  string $configFilePath Path to the PHP File
     * @throws \RuntimeException
     * @return \Phinx\Config\Config
     */
    public static function fromPhp($configFilePath)

    {
        ob_start();
        /** @noinspection PhpIncludeInspection */
        $configArray = include($configFilePath);

        // Hide console output
        ob_end_clean();

        if (!is_array($configArray)) {
            throw new \RuntimeException(sprintf(
                'PHP file \'%s\' must return an array',
                $configFilePath
            ));
        }

        return new static($configArray, $configFilePath);
    }

    /**
     * {@inheritdoc}
     */
    public function getEnvironments()
    {
        if (isset($this->values) && isset($this->values['environments'])) {
            $environments = [];
            foreach ($this->values['environments'] as $key => $value) {
                if (is_array($value)) {
                    $environments[$key] = $value;
                }
            }

            return $environments;
        }

        return null;
    }

    /**
     * {@inheritdoc}
     */
    public function getEnvironment($name)
    {
        $environments = $this->getEnvironments();

        if (isset($environments[$name])) {
            if (isset($this->values['environments']['default_migration_table'])) {
                $environments[$name]['default_migration_table'] =
                    $this->values['environments']['default_migration_table'];
            }

            return $environments[$name];
        }

        return null;
    }

    /**
     * {@inheritdoc}
     */
    public function hasEnvironment($name)
    {
        return ($this->getEnvironment($name) !== null);
    }

    /**
     * {@inheritdoc}
     */
    public function getDefaultEnvironment()
    {
        // The $PHINX_ENVIRONMENT variable overrides all other default settings
        $env = getenv('PHINX_ENVIRONMENT');
        if (!empty($env)) {
            if ($this->hasEnvironment($env)) {
                return $env;
            }

            throw new \RuntimeException(sprintf(
                'The environment configuration (read from $PHINX_ENVIRONMENT) for \'%s\' is missing',
                $env
            ));
        }

        // if the user has configured a default database then use it,
        // providing it actually exists!
        if (isset($this->values['environments']['default_database'])) {
            if ($this->getEnvironment($this->values['environments']['default_database'])) {
                return $this->values['environments']['default_database'];
            }

            throw new \RuntimeException(sprintf(
                'The environment configuration for \'%s\' is missing',
                $this->values['environments']['default_database']
            ));
        }

        // else default to the first available one
        if (is_array($this->getEnvironments()) && count($this->getEnvironments()) > 0) {
            $names = array_keys($this->getEnvironments());

            return $names[0];
        }

        throw new \RuntimeException('Could not find a default environment');
    }

    /**
     * {@inheritdoc}
     */
    public function getAlias($alias)
    {
        return !empty($this->values['aliases'][$alias]) ? $this->values['aliases'][$alias] : null;
    }

    /**
     * {@inheritdoc}
     */
    public function getConfigFilePath()
    {
        return $this->configFilePath;
    }

    /**
     * {@inheritdoc}
     */
    public function getMigrationPaths()

    {
        if (!isset($this->values['paths']['migrations'])) {
            throw new \UnexpectedValueException('Migrations path missing from config file');
        }

        if (is_string($this->values['paths']['migrations'])) {
            $this->values['paths']['migrations'] = [$this->values['paths']['migrations']];
        }

        return $this->values['paths']['migrations'];
    }

    /**
     * {@inheritdoc}
     */
    public function getSubscriberPaths()
    {
        if(!isset($this->values['paths']['subscribers'])){
            return [];
        }

        return (array)$this->values['paths']['subscribers'];
    }

    /**
     * Gets the base class name for migrations.
     *
     * @param bool $dropNamespace Return the base migration class name without the namespace.
     * @return string
     */
    public function getMigrationBaseClassName($dropNamespace = true)
    {
        $className = !isset($this->values['migration_base_class']) ? 'Phinx\Migration\AbstractMigration' : $this->values['migration_base_class'];

        return $dropNamespace ? substr(strrchr($className, '\\'), 1) ?: $className : $className;
    }

    /**
     * {@inheritdoc}
     */
    public function getSeedPaths()

    {
        if (!isset($this->values['paths']['seeds'])) {
            throw new \UnexpectedValueException('Seeds path missing from config file');
        }

        if (is_string($this->values['paths']['seeds'])) {
            $this->values['paths']['seeds'] = [$this->values['paths']['seeds']];
        }

        return $this->values['paths']['seeds'];
    }

    /**
     * Get the template file name.
     *
     * @return string|false
     */
    public function getTemplateFile()

    {
        if (!isset($this->values['templates']['file'])) {
            return false;
        }

        return $this->values['templates']['file'];
    }

    /**
     * Get the template class name.
     *
     * @return string|false
     */
    public function getTemplateClass()

    {
        if (!isset($this->values['templates']['class'])) {
            return false;
        }

        return $this->values['templates']['class'];
    }

    /**
     * Get the version order.
     *
     * @return string
     */
    public function getVersionOrder()
    {
        if (!isset($this->values['version_order'])) {
            return self::VERSION_ORDER_CREATION_TIME;
        }

        return $this->values['version_order'];
    }

    /**
     * Is version order creation time?
     *
     * @return bool
     */
    public function isVersionOrderCreationTime()
    {
        $versionOrder = $this->getVersionOrder();

        return $versionOrder == self::VERSION_ORDER_CREATION_TIME;
    }

    /**
     * Replace tokens in the specified array.
     *
     * @param array $arr Array to replace
     * @return array
     */
    protected function replaceTokens(array $arr)
// Bad
class Router
{
    public function generate($path)
    {
        return $_SERVER['HOST'].$path;
    }
}

// Better
class Router
{
    private $host;

    public function __construct($host)
    {
        $this->host = $host;
    }

    public function generate($path)
    {
        return $this->host.$path;
    }
}

class Controller
{
    public function myAction(Request $request)
    {
        // Instead of
        $page = isset($_GET['page']) ? intval($_GET['page']) : 1;

        // Better (assuming you use the Symfony2 request)
        $page = $request->query->get('page', 1);
    }
}
    {
        // Get environment variables
        // $_ENV is empty because variables_order does not include it normally
        $tokens = [];
        foreach ($_SERVER as $varname => $varvalue) {
            if (0 === strpos($varname, 'PHINX_')) {
                $tokens['%%' . $varname . '%%'] = $varvalue;
            }
        }

        // Phinx defined tokens (override env tokens)
        $tokens['%%PHINX_CONFIG_PATH%%'] = $this->getConfigFilePath();
        $tokens['%%PHINX_CONFIG_DIR%%'] = dirname($this->getConfigFilePath());

        // Recurse the array and replace tokens
        return $this->recurseArrayForTokens($arr, $tokens);
    }

    /**
     * Recurse an array for the specified tokens and replace them.
     *
     * @param array $arr Array to recurse
     * @param array $tokens Array of tokens to search for
     * @return array
     */
    protected function recurseArrayForTokens($arr, $tokens)
    {
        $out = [];
        foreach ($arr as $name => $value) {
            if (is_array($value)) {
                $out[$name] = $this->recurseArrayForTokens($value, $tokens);
                continue;
            }
            if (is_string($value)) {
                foreach ($tokens as $token => $tval) {
                    $value = str_replace($token, $tval, $value);
                }
                $out[$name] = $value;
                continue;
            }
            $out[$name] = $value;
        }

        return $out;
    }

    /**
     * {@inheritdoc}
     */
    public function offsetSet($id, $value)
    {
        $this->values[$id] = $value;
    }

    /**
     * {@inheritdoc}
     */
    public function offsetGet($id)
    {
        if (!array_key_exists($id, $this->values)) {
            throw new \InvalidArgumentException(sprintf('Identifier "%s" is not defined.', $id));
        }

        return $this->values[$id] instanceof \Closure ? $this->values[$id]($this) : $this->values[$id];
    }

    /**
     * {@inheritdoc}
     */
    public function offsetExists($id)
    {
        return isset($this->values[$id]);
    }

    /**
     * {@inheritdoc}
     */
    public function offsetUnset($id)
    {
        unset($this->values[$id]);
    }
}


1			<?php
2			/**
3			* Phinx
4			*
5			* (The MIT license)
6			* Copyright (c) 2015 Rob Morgan
7			*
8			* Permission is hereby granted, free of charge, to any person obtaining a copy
9			* of this software and associated * documentation files (the "Software"), to
10			* deal in the Software without restriction, including without limitation the
11			* rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
12			* sell copies of the Software, and to permit persons to whom the Software is
13			* furnished to do so, subject to the following conditions:
14			*
15			* The above copyright notice and this permission notice shall be included in
16			* all copies or substantial portions of the Software.
17			*
18			* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19			* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20			* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
21			* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
22			* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
23			* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
24			* IN THE SOFTWARE.
25			*
26			* @package Phinx
27			* @subpackage Phinx\Config
28			*/
29			namespace Phinx\Config;
30
31			use Symfony\Component\Yaml\Yaml;
32
33			/**
34			* Phinx configuration class.
35			*
36			* @package Phinx
37			* @author Rob Morgan
38			*/
39			class Config implements ConfigInterface, NamespaceAwareInterface
40			{
41			use NamespaceAwareTrait;
42
43			/**
44			* The value that identifies a version order by creation time.
45			*/
46			const VERSION_ORDER_CREATION_TIME = 'creation';
47
48			/**
49			* The value that identifies a version order by execution time.
50			*/
51			const VERSION_ORDER_EXECUTION_TIME = 'execution';
52
53			/**
54			* @var array
55			*/
56			private $values = [];
57
58			/**
59			* @var string
60			*/
61			protected $configFilePath;
62
63			/**
64			* {@inheritdoc}
65			*/
66	448		public function __construct(array $configArray, $configFilePath = null)
67			{
68	448		$this->configFilePath = $configFilePath;
69	448		$this->values = $this->replaceTokens($configArray);
70	448		}
71
72			/**
73			* Create a new instance of the config class using a Yaml file path.
74			*
75			* @param string $configFilePath Path to the Yaml File
76			* @throws \RuntimeException
77			* @return \Phinx\Config\Config
78			*/
79	2	View Code Duplication	public static function fromYaml($configFilePath)
			0 ignored issues – show Duplication introduced 2017-09-15 20:49 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
80			{
81	2		$configFile = file_get_contents($configFilePath);
82	2		$configArray = Yaml::parse($configFile);
83
84	2		if (!is_array($configArray)) {
85	1		throw new \RuntimeException(sprintf(
86	1		'File \'%s\' must be valid YAML',
87			$configFilePath
88	1		));
89			}
90	1
91			return new static($configArray, $configFilePath);
92			}
93
94			/**
95			* Create a new instance of the config class using a JSON file path.
96			*
97			* @param string $configFilePath Path to the JSON File
98			* @throws \RuntimeException
99			* @return \Phinx\Config\Config
100	2		*/
101		View Code Duplication	public static function fromJson($configFilePath)
			0 ignored issues – show Duplication introduced 2017-09-15 20:49 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
102	2		{
103	2		$configArray = json_decode(file_get_contents($configFilePath), true);
104	1		if (!is_array($configArray)) {
105	1		throw new \RuntimeException(sprintf(
106			'File \'%s\' must be valid JSON',
107	1		$configFilePath
108			));
109	1		}
110
111			return new static($configArray, $configFilePath);
112			}
113
114			/**
115			* Create a new instance of the config class using a PHP file path.
116			*
117			* @param string $configFilePath Path to the PHP File
118			* @throws \RuntimeException
119	3		* @return \Phinx\Config\Config
120			*/
121	3	View Code Duplication	public static function fromPhp($configFilePath)
			0 ignored issues – show Duplication introduced 2017-09-15 20:49 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
122			{
123	3		ob_start();
124			/** @noinspection PhpIncludeInspection */
125			$configArray = include($configFilePath);
126	3
127			// Hide console output
128	3		ob_end_clean();
129	2
130	2		if (!is_array($configArray)) {
131			throw new \RuntimeException(sprintf(
132	2		'PHP file \'%s\' must return an array',
133			$configFilePath
134			));
135	1		}
136
137			return new static($configArray, $configFilePath);
138			}
139
140			/**
141	25		* {@inheritdoc}
142			*/
143	25		public function getEnvironments()
144	24		{
145	24		if (isset($this->values) && isset($this->values['environments'])) {
146	24		$environments = [];
147	24		foreach ($this->values['environments'] as $key => $value) {
148	24		if (is_array($value)) {
149	24		$environments[$key] = $value;
150			}
151	24		}
152
153			return $environments;
154	1		}
155
156			return null;
157			}
158
159			/**
160	25		* {@inheritdoc}
161			*/
162	25		public function getEnvironment($name)
163			{
164	25		$environments = $this->getEnvironments();
165	21
166	21		if (isset($environments[$name])) {
167	21		if (isset($this->values['environments']['default_migration_table'])) {
168	21		$environments[$name]['default_migration_table'] =
169			$this->values['environments']['default_migration_table'];
170	21		}
171
172			return $environments[$name];
173	5		}
174
175			return null;
176			}
177
178			/**
179	9		* {@inheritdoc}
180			*/
181	9		public function hasEnvironment($name)
182			{
183			return ($this->getEnvironment($name) !== null);
184			}
185
186			/**
187	20		* {@inheritdoc}
188			*/
189			public function getDefaultEnvironment()
190	20		{
191	20		// The $PHINX_ENVIRONMENT variable overrides all other default settings
192	2		$env = getenv('PHINX_ENVIRONMENT');
193	1		if (!empty($env)) {
194			if ($this->hasEnvironment($env)) {
195			return $env;
196	1		}
197	1
198			throw new \RuntimeException(sprintf(
199	1		'The environment configuration (read from $PHINX_ENVIRONMENT) for \'%s\' is missing',
200			$env
201			));
202			}
203
204	19		// if the user has configured a default database then use it,
205	17		// providing it actually exists!
206	16		if (isset($this->values['environments']['default_database'])) {
207			if ($this->getEnvironment($this->values['environments']['default_database'])) {
208			return $this->values['environments']['default_database'];
209	1		}
210	1
211	1		throw new \RuntimeException(sprintf(
212	1		'The environment configuration for \'%s\' is missing',
213			$this->values['environments']['default_database']
214			));
215			}
216	2
217	1		// else default to the first available one
218	1		if (is_array($this->getEnvironments()) && count($this->getEnvironments()) > 0) {
219			$names = array_keys($this->getEnvironments());
220
221	1		return $names[0];
222			}
223
224			throw new \RuntimeException('Could not find a default environment');
225			}
226
227	7		/**
228			* {@inheritdoc}
229	7		*/
230			public function getAlias($alias)
231			{
232			return !empty($this->values['aliases'][$alias]) ? $this->values['aliases'][$alias] : null;
233			}
234
235	448		/**
236			* {@inheritdoc}
237	448		*/
238			public function getConfigFilePath()
239			{
240			return $this->configFilePath;
241			}
242
243	423		/**
244			* {@inheritdoc}
245	423		*/
246	1	View Code Duplication	public function getMigrationPaths()
			0 ignored issues – show Duplication introduced 2017-09-15 20:49 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
247			{
248			if (!isset($this->values['paths']['migrations'])) {
249	422		throw new \UnexpectedValueException('Migrations path missing from config file');
250	219		}
251	219
252			if (is_string($this->values['paths']['migrations'])) {
253	422		$this->values['paths']['migrations'] = [$this->values['paths']['migrations']];
254			}
255
256			return $this->values['paths']['migrations'];
257			}
258
259			/**
260			* {@inheritdoc}
261			*/
262	14		public function getSubscriberPaths()
263			{
264	14		if(!isset($this->values['paths']['subscribers'])){
265			return [];
266	14		}
267
268			return (array)$this->values['paths']['subscribers'];
269			}
270
271			/**
272	48		* Gets the base class name for migrations.
273			*
274	48		* @param bool $dropNamespace Return the base migration class name without the namespace.
275	28		* @return string
276			*/
277			public function getMigrationBaseClassName($dropNamespace = true)
278	20		{
279	13		$className = !isset($this->values['migration_base_class']) ? 'Phinx\Migration\AbstractMigration' : $this->values['migration_base_class'];
280	13
281			return $dropNamespace ? substr(strrchr($className, '\\'), 1) ?: $className : $className;
282	20		}
283
284			/**
285			* {@inheritdoc}
286			*/
287		View Code Duplication	public function getSeedPaths()
			0 ignored issues – show Duplication introduced 2017-09-15 20:49 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
288			{
289			if (!isset($this->values['paths']['seeds'])) {
290	14		throw new \UnexpectedValueException('Seeds path missing from config file');
291			}
292	14
293	13		if (is_string($this->values['paths']['seeds'])) {
294			$this->values['paths']['seeds'] = [$this->values['paths']['seeds']];
295			}
296	1
297			return $this->values['paths']['seeds'];
298			}
299
300			/**
301			* Get the template file name.
302			*
303			* @return string\|false
304	14		*/
305		View Code Duplication	public function getTemplateFile()
			0 ignored issues – show Duplication introduced 2017-09-15 20:49 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
306	14		{
307	10		if (!isset($this->values['templates']['file'])) {
308			return false;
309			}
310	4
311			return $this->values['templates']['file'];
312			}
313
314			/**
315			* Get the template class name.
316			*
317			* @return string\|false
318	384		*/
319		View Code Duplication	public function getTemplateClass()
			0 ignored issues – show Duplication introduced 2017-09-15 20:49 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
320	384		{
321	162		if (!isset($this->values['templates']['class'])) {
322			return false;
323			}
324	222
325			return $this->values['templates']['class'];
326			}
327
328			/**
329			* Get the version order.
330			*
331			* @return string
332	357		*/
333			public function getVersionOrder()
334	357		{
335			if (!isset($this->values['version_order'])) {
336	357		return self::VERSION_ORDER_CREATION_TIME;
337			}
338
339			return $this->values['version_order'];
340			}
341
342			/**
343			* Is version order creation time?
344			*
345			* @return bool
346			*/
347	448		public function isVersionOrderCreationTime()
348			{
349			$versionOrder = $this->getVersionOrder();
350
351	448		return $versionOrder == self::VERSION_ORDER_CREATION_TIME;
352	448		}
353	448
354	2		/**
355	2		* Replace tokens in the specified array.
356	448		*
357			* @param array $arr Array to replace
358			* @return array
359	448		*/
360	448		protected function replaceTokens(array $arr)
			0 ignored issues – show Coding Style introduced 2017-09-15 20:49 UTC by Report Bug Copy Issue Report `replaceTokens` uses the super-global variable `$_SERVER` which is generally not recommended. Instead of super-globals, we recommend to explicitly inject the dependencies of your class. This makes your code less dependent on global state and it becomes generally more testable: // Bad class Router { public function generate($path) { return $_SERVER['HOST'].$path; } } // Better class Router { private $host; public function __construct($host) { $this->host = $host; } public function generate($path) { return $this->host.$path; } } class Controller { public function myAction(Request $request) { // Instead of $page = isset($_GET['page']) ? intval($_GET['page']) : 1; // Better (assuming you use the Symfony2 request) $page = $request->query->get('page', 1); } } Loading history...
361			{
362			// Get environment variables
363	448		// $_ENV is empty because variables_order does not include it normally
364			$tokens = [];
365			foreach ($_SERVER as $varname => $varvalue) {
366			if (0 === strpos($varname, 'PHINX_')) {
367			$tokens['%%' . $varname . '%%'] = $varvalue;
368			}
369			}
370
371			// Phinx defined tokens (override env tokens)
372			$tokens['%%PHINX_CONFIG_PATH%%'] = $this->getConfigFilePath();
373	448		$tokens['%%PHINX_CONFIG_DIR%%'] = dirname($this->getConfigFilePath());
374
375	448		// Recurse the array and replace tokens
376	448		return $this->recurseArrayForTokens($arr, $tokens);
377	447		}
378	446
379	446		/**
380			* Recurse an array for the specified tokens and replace them.
381	446		*
382	446		* @param array $arr Array to recurse
383	446		* @param array $tokens Array of tokens to search for
384	446		* @return array
385	446		*/
386	446		protected function recurseArrayForTokens($arr, $tokens)
387			{
388	43		$out = [];
389	448		foreach ($arr as $name => $value) {
390	448		if (is_array($value)) {
391			$out[$name] = $this->recurseArrayForTokens($value, $tokens);
392			continue;
393			}
394			if (is_string($value)) {
395			foreach ($tokens as $token => $tval) {
396	213		$value = str_replace($token, $tval, $value);
397			}
398	213		$out[$name] = $value;
399	213		continue;
400			}
401			$out[$name] = $value;
402			}
403
404	2		return $out;
405			}
406	2
407	1		/**
408			* {@inheritdoc}
409			*/
410	1		public function offsetSet($id, $value)
411			{
412			$this->values[$id] = $value;
413			}
414
415			/**
416	1		* {@inheritdoc}
417			*/
418	1		public function offsetGet($id)
419			{
420			if (!array_key_exists($id, $this->values)) {
421			throw new \InvalidArgumentException(sprintf('Identifier "%s" is not defined.', $id));
422			}
423
424	1		return $this->values[$id] instanceof \Closure ? $this->values[$id]($this) : $this->values[$id];
425			}
426	1
427	1		/**
428			* {@inheritdoc}
429			*/
430			public function offsetExists($id)
431			{
432			return isset($this->values[$id]);
433			}
434
435			/**
436			* {@inheritdoc}
437			*/
438			public function offsetUnset($id)
439			{
440			unset($this->values[$id]);
441			}
442			}
443

cakephp / phinx

Pull Request — master (#1382)

Config::getSubscriberPaths() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like