Edit File by line

<?php

[0] Fix | Delete

/**

[1] Fix | Delete

* CakePHP(tm) : Rapid Development Framework (https://cakephp.org)

[2] Fix | Delete

* Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)

[3] Fix | Delete

[4] Fix | Delete

* Licensed under The MIT License

[5] Fix | Delete

* For full copyright and license information, please see the LICENSE.txt

[6] Fix | Delete

* Redistributions of files must retain the above copyright notice.

[7] Fix | Delete

[8] Fix | Delete

* @copyright Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)

[9] Fix | Delete

* @link https://cakephp.org CakePHP(tm) Project

[10] Fix | Delete

* @since 3.0.0

[11] Fix | Delete

* @license https://opensource.org/licenses/mit-license.php MIT License

[12] Fix | Delete

[13] Fix | Delete

namespace Cake\Core;

[14] Fix | Delete

[15] Fix | Delete

use BadMethodCallException;

[16] Fix | Delete

use InvalidArgumentException;

[17] Fix | Delete

use LogicException;

[18] Fix | Delete

[19] Fix | Delete

/**

[20] Fix | Delete

* A trait that provides a set of static methods to manage configuration

[21] Fix | Delete

* for classes that provide an adapter facade or need to have sets of

[22] Fix | Delete

* configuration data registered and manipulated.

[23] Fix | Delete

[24] Fix | Delete

* Implementing objects are expected to declare a static `$_dsnClassMap` property.

[25] Fix | Delete

[26] Fix | Delete

trait StaticConfigTrait

[27] Fix | Delete

{

[28] Fix | Delete

/**

[29] Fix | Delete

* Configuration sets.

[30] Fix | Delete

[31] Fix | Delete

* @var array

[32] Fix | Delete

[33] Fix | Delete

protected static $_config = [];

[34] Fix | Delete

[35] Fix | Delete

/**

[36] Fix | Delete

* This method can be used to define configuration adapters for an application.

[37] Fix | Delete

[38] Fix | Delete

* To change an adapter's configuration at runtime, first drop the adapter and then

[39] Fix | Delete

* reconfigure it.

[40] Fix | Delete

[41] Fix | Delete

* Adapters will not be constructed until the first operation is done.

[42] Fix | Delete

[43] Fix | Delete

* ### Usage

[44] Fix | Delete

[45] Fix | Delete

* Assuming that the class' name is `Cache` the following scenarios

[46] Fix | Delete

* are supported:

[47] Fix | Delete

[48] Fix | Delete

* Setting a cache engine up.

[49] Fix | Delete

[50] Fix | Delete

* ```

[51] Fix | Delete

* Cache::setConfig('default', $settings);

[52] Fix | Delete

* ```

[53] Fix | Delete

[54] Fix | Delete

* Injecting a constructed adapter in:

[55] Fix | Delete

[56] Fix | Delete

* ```

[57] Fix | Delete

* Cache::setConfig('default', $instance);

[58] Fix | Delete

* ```

[59] Fix | Delete

[60] Fix | Delete

* Configure multiple adapters at once:

[61] Fix | Delete

[62] Fix | Delete

* ```

[63] Fix | Delete

* Cache::setConfig($arrayOfConfig);

[64] Fix | Delete

* ```

[65] Fix | Delete

[66] Fix | Delete

* @param string|array $key The name of the configuration, or an array of multiple configs.

[67] Fix | Delete

* @param array|object|null $config An array of name => configuration data for adapter.

[68] Fix | Delete

* @throws \BadMethodCallException When trying to modify an existing config.

[69] Fix | Delete

* @throws \LogicException When trying to store an invalid structured config array.

[70] Fix | Delete

* @return void

[71] Fix | Delete

[72] Fix | Delete

public static function setConfig($key, $config = null)

[73] Fix | Delete

{

[74] Fix | Delete

if ($config === null) {

[75] Fix | Delete

if (!is_array($key)) {

[76] Fix | Delete

throw new LogicException('If config is null, key must be an array.');

[77] Fix | Delete

}

[78] Fix | Delete

foreach ($key as $name => $settings) {

[79] Fix | Delete

static::setConfig($name, $settings);

[80] Fix | Delete

}

[81] Fix | Delete

[82] Fix | Delete

return;

[83] Fix | Delete

}

[84] Fix | Delete

[85] Fix | Delete

if (isset(static::$_config[$key])) {

[86] Fix | Delete

throw new BadMethodCallException(sprintf('Cannot reconfigure existing key "%s"', $key));

[87] Fix | Delete

}

[88] Fix | Delete

[89] Fix | Delete

if (is_object($config)) {

[90] Fix | Delete

$config = ['className' => $config];

[91] Fix | Delete

}

[92] Fix | Delete

[93] Fix | Delete

if (isset($config['url'])) {

[94] Fix | Delete

$parsed = static::parseDsn($config['url']);

[95] Fix | Delete

unset($config['url']);

[96] Fix | Delete

$config = $parsed + $config;

[97] Fix | Delete

}

[98] Fix | Delete

[99] Fix | Delete

if (isset($config['engine']) && empty($config['className'])) {

[100] Fix | Delete

$config['className'] = $config['engine'];

[101] Fix | Delete

unset($config['engine']);

[102] Fix | Delete

}

[103] Fix | Delete

static::$_config[$key] = $config;

[104] Fix | Delete

}

[105] Fix | Delete

[106] Fix | Delete

/**

[107] Fix | Delete

* Reads existing configuration.

[108] Fix | Delete

[109] Fix | Delete

* @param string $key The name of the configuration.

[110] Fix | Delete

* @return mixed|null Configuration data at the named key or null if the key does not exist.

[111] Fix | Delete

[112] Fix | Delete

public static function getConfig($key)

[113] Fix | Delete

{

[114] Fix | Delete

return isset(static::$_config[$key]) ? static::$_config[$key] : null;

[115] Fix | Delete

}

[116] Fix | Delete

[117] Fix | Delete

/**

[118] Fix | Delete

* This method can be used to define configuration adapters for an application

[119] Fix | Delete

* or read existing configuration.

[120] Fix | Delete

[121] Fix | Delete

* To change an adapter's configuration at runtime, first drop the adapter and then

[122] Fix | Delete

* reconfigure it.

[123] Fix | Delete

[124] Fix | Delete

* Adapters will not be constructed until the first operation is done.

[125] Fix | Delete

[126] Fix | Delete

* ### Usage

[127] Fix | Delete

[128] Fix | Delete

* Assuming that the class' name is `Cache` the following scenarios

[129] Fix | Delete

* are supported:

[130] Fix | Delete

[131] Fix | Delete

* Reading config data back:

[132] Fix | Delete

[133] Fix | Delete

* ```

[134] Fix | Delete

* Cache::config('default');

[135] Fix | Delete

* ```

[136] Fix | Delete

[137] Fix | Delete

* Setting a cache engine up.

[138] Fix | Delete

[139] Fix | Delete

* ```

[140] Fix | Delete

* Cache::config('default', $settings);

[141] Fix | Delete

* ```

[142] Fix | Delete

[143] Fix | Delete

* Injecting a constructed adapter in:

[144] Fix | Delete

[145] Fix | Delete

* ```

[146] Fix | Delete

* Cache::config('default', $instance);

[147] Fix | Delete

* ```

[148] Fix | Delete

[149] Fix | Delete

* Configure multiple adapters at once:

[150] Fix | Delete

[151] Fix | Delete

* ```

[152] Fix | Delete

* Cache::config($arrayOfConfig);

[153] Fix | Delete

* ```

[154] Fix | Delete

[155] Fix | Delete

* @deprecated 3.4.0 Use setConfig()/getConfig() instead.

[156] Fix | Delete

* @param string|array $key The name of the configuration, or an array of multiple configs.

[157] Fix | Delete

* @param array|null $config An array of name => configuration data for adapter.

[158] Fix | Delete

* @return array|null Null when adding configuration or an array of configuration data when reading.

[159] Fix | Delete

* @throws \BadMethodCallException When trying to modify an existing config.

[160] Fix | Delete

[161] Fix | Delete

public static function config($key, $config = null)

[162] Fix | Delete

{

[163] Fix | Delete

deprecationWarning(

[164] Fix | Delete

get_called_class() . '::config() is deprecated. ' .

[165] Fix | Delete

'Use setConfig()/getConfig() instead.'

[166] Fix | Delete

);

[167] Fix | Delete

[168] Fix | Delete

if ($config !== null || is_array($key)) {

[169] Fix | Delete

static::setConfig($key, $config);

[170] Fix | Delete

[171] Fix | Delete

return null;

[172] Fix | Delete

}

[173] Fix | Delete

[174] Fix | Delete

return static::getConfig($key);

[175] Fix | Delete

}

[176] Fix | Delete

[177] Fix | Delete

/**

[178] Fix | Delete

* Reads existing configuration for a specific key.

[179] Fix | Delete

[180] Fix | Delete

* The config value for this key must exist, it can never be null.

[181] Fix | Delete

[182] Fix | Delete

* @param string|null $key The name of the configuration.

[183] Fix | Delete

* @return mixed Configuration data at the named key.

[184] Fix | Delete

* @throws \InvalidArgumentException If value does not exist.

[185] Fix | Delete

[186] Fix | Delete

public static function getConfigOrFail($key)

[187] Fix | Delete

{

[188] Fix | Delete

if (!isset($key)) {

[189] Fix | Delete

throw new InvalidArgumentException('$key must not be null.');

[190] Fix | Delete

}

[191] Fix | Delete

if (!isset(static::$_config[$key])) {

[192] Fix | Delete

throw new InvalidArgumentException(sprintf('Expected configuration `%s` not found.', $key));

[193] Fix | Delete

}

[194] Fix | Delete

[195] Fix | Delete

return static::$_config[$key];

[196] Fix | Delete

}

[197] Fix | Delete

[198] Fix | Delete

/**

[199] Fix | Delete

* Drops a constructed adapter.

[200] Fix | Delete

[201] Fix | Delete

* If you wish to modify an existing configuration, you should drop it,

[202] Fix | Delete

* change configuration and then re-add it.

[203] Fix | Delete

[204] Fix | Delete

* If the implementing objects supports a `$_registry` object the named configuration

[205] Fix | Delete

* will also be unloaded from the registry.

[206] Fix | Delete

[207] Fix | Delete

* @param string $config An existing configuration you wish to remove.

[208] Fix | Delete

* @return bool Success of the removal, returns false when the config does not exist.

[209] Fix | Delete

[210] Fix | Delete

public static function drop($config)

[211] Fix | Delete

{

[212] Fix | Delete

if (!isset(static::$_config[$config])) {

[213] Fix | Delete

return false;

[214] Fix | Delete

}

[215] Fix | Delete

if (isset(static::$_registry)) {

[216] Fix | Delete

static::$_registry->unload($config);

[217] Fix | Delete

}

[218] Fix | Delete

unset(static::$_config[$config]);

[219] Fix | Delete

[220] Fix | Delete

return true;

[221] Fix | Delete

}

[222] Fix | Delete

[223] Fix | Delete

/**

[224] Fix | Delete

* Returns an array containing the named configurations

[225] Fix | Delete

[226] Fix | Delete

* @return string[] Array of configurations.

[227] Fix | Delete

[228] Fix | Delete

public static function configured()

[229] Fix | Delete

{

[230] Fix | Delete

return array_keys(static::$_config);

[231] Fix | Delete

}

[232] Fix | Delete

[233] Fix | Delete

/**

[234] Fix | Delete

* Parses a DSN into a valid connection configuration

[235] Fix | Delete

[236] Fix | Delete

* This method allows setting a DSN using formatting similar to that used by PEAR::DB.

[237] Fix | Delete

* The following is an example of its usage:

[238] Fix | Delete

[239] Fix | Delete

* ```

[240] Fix | Delete

* $dsn = 'mysql://user:pass@localhost/database?';

[241] Fix | Delete

* $config = ConnectionManager::parseDsn($dsn);

[242] Fix | Delete

[243] Fix | Delete

* $dsn = 'Cake\Log\Engine\FileLog://?types=notice,info,debug&file=debug&path=LOGS';

[244] Fix | Delete

* $config = Log::parseDsn($dsn);

[245] Fix | Delete

[246] Fix | Delete

* $dsn = 'smtp://user:secret@localhost:25?timeout=30&client=null&tls=null';

[247] Fix | Delete

* $config = Email::parseDsn($dsn);

[248] Fix | Delete

[249] Fix | Delete

* $dsn = 'file:///?className=\My\Cache\Engine\FileEngine';

[250] Fix | Delete

* $config = Cache::parseDsn($dsn);

[251] Fix | Delete

[252] Fix | Delete

* $dsn = 'File://?prefix=myapp_cake_core_&serialize=true&duration=+2 minutes&path=/tmp/persistent/';

[253] Fix | Delete

* $config = Cache::parseDsn($dsn);

[254] Fix | Delete

* ```

[255] Fix | Delete

[256] Fix | Delete

* For all classes, the value of `scheme` is set as the value of both the `className`

[257] Fix | Delete

* unless they have been otherwise specified.

[258] Fix | Delete

[259] Fix | Delete

* Note that querystring arguments are also parsed and set as values in the returned configuration.

[260] Fix | Delete

[261] Fix | Delete

* @param string $dsn The DSN string to convert to a configuration array

[262] Fix | Delete

* @return array The configuration array to be stored after parsing the DSN

[263] Fix | Delete

* @throws \InvalidArgumentException If not passed a string, or passed an invalid string

[264] Fix | Delete

[265] Fix | Delete

public static function parseDsn($dsn)

[266] Fix | Delete

{

[267] Fix | Delete

if (empty($dsn)) {

[268] Fix | Delete

return [];

[269] Fix | Delete

}

[270] Fix | Delete

[271] Fix | Delete

if (!is_string($dsn)) {

[272] Fix | Delete

throw new InvalidArgumentException('Only strings can be passed to parseDsn');

[273] Fix | Delete

}

[274] Fix | Delete

[275] Fix | Delete

$pattern = <<<'REGEXP'

[276] Fix | Delete

{

[277] Fix | Delete

[278] Fix | Delete

(?P<_scheme>

[279] Fix | Delete

(?P<scheme>[\w\\\\]+)://

[280] Fix | Delete

)

[281] Fix | Delete

(?P<_username>

[282] Fix | Delete

(?P<username>.*?)

[283] Fix | Delete

(?P<_password>

[284] Fix | Delete

:(?P<password>.*?)

[285] Fix | Delete

[286] Fix | Delete

[287] Fix | Delete

[288] Fix | Delete

(?P<_host>

[289] Fix | Delete

(?P<host>[^?#/:@]+)

[290] Fix | Delete

(?P<_port>

[291] Fix | Delete

:(?P<port>\d+)

[292] Fix | Delete

[293] Fix | Delete

[294] Fix | Delete

(?P<_path>

[295] Fix | Delete

(?P<path>/[^?#]*)

[296] Fix | Delete

[297] Fix | Delete

(?P<_query>

[298] Fix | Delete

\?(?P<query>[^#]*)

[299] Fix | Delete

[300] Fix | Delete

(?P<_fragment>

[301] Fix | Delete

\#(?P<fragment>.*)

[302] Fix | Delete

[303] Fix | Delete

[304] Fix | Delete

[305] Fix | Delete

REGEXP;

[306] Fix | Delete

[307] Fix | Delete

preg_match($pattern, $dsn, $parsed);

[308] Fix | Delete

[309] Fix | Delete

if (!$parsed) {

[310] Fix | Delete

throw new InvalidArgumentException("The DSN string '{$dsn}' could not be parsed.");

[311] Fix | Delete

}

[312] Fix | Delete

[313] Fix | Delete

$exists = [];

[314] Fix | Delete

foreach ($parsed as $k => $v) {

[315] Fix | Delete

if (is_int($k)) {

[316] Fix | Delete

unset($parsed[$k]);

[317] Fix | Delete

} elseif (strpos($k, '_') === 0) {

[318] Fix | Delete

$exists[substr($k, 1)] = ($v !== '');

[319] Fix | Delete

unset($parsed[$k]);

[320] Fix | Delete

} elseif ($v === '' && !$exists[$k]) {

[321] Fix | Delete

unset($parsed[$k]);

[322] Fix | Delete

}

[323] Fix | Delete

}

[324] Fix | Delete

[325] Fix | Delete

$query = '';

[326] Fix | Delete

[327] Fix | Delete

if (isset($parsed['query'])) {

[328] Fix | Delete

$query = $parsed['query'];

[329] Fix | Delete

unset($parsed['query']);

[330] Fix | Delete

}

[331] Fix | Delete

[332] Fix | Delete

parse_str($query, $queryArgs);

[333] Fix | Delete

[334] Fix | Delete

foreach ($queryArgs as $key => $value) {

[335] Fix | Delete

if ($value === 'true') {

[336] Fix | Delete

$queryArgs[$key] = true;

[337] Fix | Delete

} elseif ($value === 'false') {

[338] Fix | Delete

$queryArgs[$key] = false;

[339] Fix | Delete

} elseif ($value === 'null') {

[340] Fix | Delete

$queryArgs[$key] = null;

[341] Fix | Delete

}

[342] Fix | Delete

}

[343] Fix | Delete

[344] Fix | Delete

$parsed = $queryArgs + $parsed;

[345] Fix | Delete

[346] Fix | Delete

if (empty($parsed['className'])) {

[347] Fix | Delete

$classMap = static::getDsnClassMap();

[348] Fix | Delete

[349] Fix | Delete

$parsed['className'] = $parsed['scheme'];

[350] Fix | Delete

if (isset($classMap[$parsed['scheme']])) {

[351] Fix | Delete

$parsed['className'] = $classMap[$parsed['scheme']];

[352] Fix | Delete

}

[353] Fix | Delete

}

[354] Fix | Delete

[355] Fix | Delete

return $parsed;

[356] Fix | Delete

}

[357] Fix | Delete

[358] Fix | Delete

/**

[359] Fix | Delete

* Updates the DSN class map for this class.

[360] Fix | Delete

[361] Fix | Delete

* @param string[] $map Additions/edits to the class map to apply.

[362] Fix | Delete

* @return void

[363] Fix | Delete

[364] Fix | Delete

public static function setDsnClassMap(array $map)

[365] Fix | Delete

{

[366] Fix | Delete

static::$_dsnClassMap = $map + static::$_dsnClassMap;

[367] Fix | Delete

}

[368] Fix | Delete

[369] Fix | Delete

/**

[370] Fix | Delete

* Returns the DSN class map for this class.

[371] Fix | Delete

[372] Fix | Delete

* @return string[]

[373] Fix | Delete

[374] Fix | Delete

public static function getDsnClassMap()

[375] Fix | Delete

{

[376] Fix | Delete

return static::$_dsnClassMap;

[377] Fix | Delete

}

[378] Fix | Delete

[379] Fix | Delete

/**

[380] Fix | Delete

* Returns or updates the DSN class map for this class.

[381] Fix | Delete

[382] Fix | Delete

* @deprecated 3.4.0 Use setDsnClassMap()/getDsnClassMap() instead.

[383] Fix | Delete

* @param string[]|null $map Additions/edits to the class map to apply.

[384] Fix | Delete

* @return string[]

[385] Fix | Delete

[386] Fix | Delete

public static function dsnClassMap(array $map = null)

[387] Fix | Delete

{

[388] Fix | Delete

deprecationWarning(

[389] Fix | Delete

get_called_class() . '::setDsnClassMap() is deprecated. ' .

[390] Fix | Delete

'Use setDsnClassMap()/getDsnClassMap() instead.'

[391] Fix | Delete

);

[392] Fix | Delete

[393] Fix | Delete

if ($map !== null) {

[394] Fix | Delete

static::setDsnClassMap($map);

[395] Fix | Delete

}

[396] Fix | Delete

[397] Fix | Delete

return static::getDsnClassMap();

[398] Fix | Delete

}

[399] Fix | Delete

}

[400] Fix | Delete

[401] Fix | Delete