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 ArrayIterator;

[16] Fix | Delete

use Cake\Event\EventDispatcherInterface;

[17] Fix | Delete

use Cake\Event\EventListenerInterface;

[18] Fix | Delete

use Countable;

[19] Fix | Delete

use IteratorAggregate;

[20] Fix | Delete

use RuntimeException;

[21] Fix | Delete

[22] Fix | Delete

/**

[23] Fix | Delete

* Acts as a registry/factory for objects.

[24] Fix | Delete

[25] Fix | Delete

* Provides registry & factory functionality for object types. Used

[26] Fix | Delete

* as a super class for various composition based re-use features in CakePHP.

[27] Fix | Delete

[28] Fix | Delete

* Each subclass needs to implement the various abstract methods to complete

[29] Fix | Delete

* the template method load().

[30] Fix | Delete

[31] Fix | Delete

* The ObjectRegistry is EventManager aware, but each extending class will need to use

[32] Fix | Delete

* \Cake\Event\EventDispatcherTrait to attach and detach on set and bind

[33] Fix | Delete

[34] Fix | Delete

* @see \Cake\Controller\ComponentRegistry

[35] Fix | Delete

* @see \Cake\View\HelperRegistry

[36] Fix | Delete

* @see \Cake\Console\TaskRegistry

[37] Fix | Delete

[38] Fix | Delete

abstract class ObjectRegistry implements Countable, IteratorAggregate

[39] Fix | Delete

{

[40] Fix | Delete

/**

[41] Fix | Delete

* Map of loaded objects.

[42] Fix | Delete

[43] Fix | Delete

* @var object[]

[44] Fix | Delete

[45] Fix | Delete

protected $_loaded = [];

[46] Fix | Delete

[47] Fix | Delete

/**

[48] Fix | Delete

* Loads/constructs an object instance.

[49] Fix | Delete

[50] Fix | Delete

* Will return the instance in the registry if it already exists.

[51] Fix | Delete

* If a subclass provides event support, you can use `$config['enabled'] = false`

[52] Fix | Delete

* to exclude constructed objects from being registered for events.

[53] Fix | Delete

[54] Fix | Delete

* Using Cake\Controller\Controller::$components as an example. You can alias

[55] Fix | Delete

* an object by setting the 'className' key, i.e.,

[56] Fix | Delete

[57] Fix | Delete

* ```

[58] Fix | Delete

* public $components = [

[59] Fix | Delete

* 'Email' => [

[60] Fix | Delete

* 'className' => '\App\Controller\Component\AliasedEmailComponent'

[61] Fix | Delete

* ];

[62] Fix | Delete

* ];

[63] Fix | Delete

* ```

[64] Fix | Delete

[65] Fix | Delete

* All calls to the `Email` component would use `AliasedEmail` instead.

[66] Fix | Delete

[67] Fix | Delete

* @param string $objectName The name/class of the object to load.

[68] Fix | Delete

* @param array $config Additional settings to use when loading the object.

[69] Fix | Delete

* @return mixed

[70] Fix | Delete

* @throws \Exception If the class cannot be found.

[71] Fix | Delete

[72] Fix | Delete

public function load($objectName, $config = [])

[73] Fix | Delete

{

[74] Fix | Delete

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

[75] Fix | Delete

$name = $objectName;

[76] Fix | Delete

$objectName = $config['className'];

[77] Fix | Delete

} else {

[78] Fix | Delete

list(, $name) = pluginSplit($objectName);

[79] Fix | Delete

}

[80] Fix | Delete

[81] Fix | Delete

$loaded = isset($this->_loaded[$name]);

[82] Fix | Delete

if ($loaded && !empty($config)) {

[83] Fix | Delete

$this->_checkDuplicate($name, $config);

[84] Fix | Delete

}

[85] Fix | Delete

if ($loaded) {

[86] Fix | Delete

return $this->_loaded[$name];

[87] Fix | Delete

}

[88] Fix | Delete

[89] Fix | Delete

$className = $this->_resolveClassName($objectName);

[90] Fix | Delete

if (!$className || (is_string($className) && !class_exists($className))) {

[91] Fix | Delete

list($plugin, $objectName) = pluginSplit($objectName);

[92] Fix | Delete

$this->_throwMissingClassError($objectName, $plugin);

[93] Fix | Delete

}

[94] Fix | Delete

$instance = $this->_create($className, $name, $config);

[95] Fix | Delete

$this->_loaded[$name] = $instance;

[96] Fix | Delete

[97] Fix | Delete

return $instance;

[98] Fix | Delete

}

[99] Fix | Delete

[100] Fix | Delete

/**

[101] Fix | Delete

* Check for duplicate object loading.

[102] Fix | Delete

[103] Fix | Delete

* If a duplicate is being loaded and has different configuration, that is

[104] Fix | Delete

* bad and an exception will be raised.

[105] Fix | Delete

[106] Fix | Delete

* An exception is raised, as replacing the object will not update any

[107] Fix | Delete

* references other objects may have. Additionally, simply updating the runtime

[108] Fix | Delete

* configuration is not a good option as we may be missing important constructor

[109] Fix | Delete

* logic dependent on the configuration.

[110] Fix | Delete

[111] Fix | Delete

* @param string $name The name of the alias in the registry.

[112] Fix | Delete

* @param array $config The config data for the new instance.

[113] Fix | Delete

* @return void

[114] Fix | Delete

* @throws \RuntimeException When a duplicate is found.

[115] Fix | Delete

[116] Fix | Delete

protected function _checkDuplicate($name, $config)

[117] Fix | Delete

{

[118] Fix | Delete

/** @var \Cake\Core\InstanceConfigTrait $existing */

[119] Fix | Delete

$existing = $this->_loaded[$name];

[120] Fix | Delete

$msg = sprintf('The "%s" alias has already been loaded.', $name);

[121] Fix | Delete

$hasConfig = method_exists($existing, 'config');

[122] Fix | Delete

if (!$hasConfig) {

[123] Fix | Delete

throw new RuntimeException($msg);

[124] Fix | Delete

}

[125] Fix | Delete

if (empty($config)) {

[126] Fix | Delete

return;

[127] Fix | Delete

}

[128] Fix | Delete

$existingConfig = $existing->getConfig();

[129] Fix | Delete

unset($config['enabled'], $existingConfig['enabled']);

[130] Fix | Delete

[131] Fix | Delete

$failure = null;

[132] Fix | Delete

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

[133] Fix | Delete

if (!array_key_exists($key, $existingConfig)) {

[134] Fix | Delete

$failure = " The `{$key}` was not defined in the previous configuration data.";

[135] Fix | Delete

break;

[136] Fix | Delete

}

[137] Fix | Delete

if (isset($existingConfig[$key]) && $existingConfig[$key] !== $value) {

[138] Fix | Delete

$failure = sprintf(

[139] Fix | Delete

' The `%s` key has a value of `%s` but previously had a value of `%s`',

[140] Fix | Delete

$key,

[141] Fix | Delete

json_encode($value),

[142] Fix | Delete

json_encode($existingConfig[$key])

[143] Fix | Delete

);

[144] Fix | Delete

break;

[145] Fix | Delete

}

[146] Fix | Delete

}

[147] Fix | Delete

if ($failure) {

[148] Fix | Delete

throw new RuntimeException($msg . $failure);

[149] Fix | Delete

}

[150] Fix | Delete

}

[151] Fix | Delete

[152] Fix | Delete

/**

[153] Fix | Delete

* Should resolve the classname for a given object type.

[154] Fix | Delete

[155] Fix | Delete

* @param string $class The class to resolve.

[156] Fix | Delete

* @return string|false The resolved name or false for failure.

[157] Fix | Delete

[158] Fix | Delete

abstract protected function _resolveClassName($class);

[159] Fix | Delete

[160] Fix | Delete

/**

[161] Fix | Delete

* Throw an exception when the requested object name is missing.

[162] Fix | Delete

[163] Fix | Delete

* @param string $class The class that is missing.

[164] Fix | Delete

* @param string|null $plugin The plugin $class is missing from.

[165] Fix | Delete

* @return void

[166] Fix | Delete

* @throws \Exception

[167] Fix | Delete

[168] Fix | Delete

abstract protected function _throwMissingClassError($class, $plugin);

[169] Fix | Delete

[170] Fix | Delete

/**

[171] Fix | Delete

* Create an instance of a given classname.

[172] Fix | Delete

[173] Fix | Delete

* This method should construct and do any other initialization logic

[174] Fix | Delete

* required.

[175] Fix | Delete

[176] Fix | Delete

* @param string $class The class to build.

[177] Fix | Delete

* @param string $alias The alias of the object.

[178] Fix | Delete

* @param array $config The Configuration settings for construction

[179] Fix | Delete

* @return mixed

[180] Fix | Delete

[181] Fix | Delete

abstract protected function _create($class, $alias, $config);

[182] Fix | Delete

[183] Fix | Delete

/**

[184] Fix | Delete

* Get the list of loaded objects.

[185] Fix | Delete

[186] Fix | Delete

* @return string[] List of object names.

[187] Fix | Delete

[188] Fix | Delete

public function loaded()

[189] Fix | Delete

{

[190] Fix | Delete

return array_keys($this->_loaded);

[191] Fix | Delete

}

[192] Fix | Delete

[193] Fix | Delete

/**

[194] Fix | Delete

* Check whether or not a given object is loaded.

[195] Fix | Delete

[196] Fix | Delete

* @param string $name The object name to check for.

[197] Fix | Delete

* @return bool True is object is loaded else false.

[198] Fix | Delete

[199] Fix | Delete

public function has($name)

[200] Fix | Delete

{

[201] Fix | Delete

return isset($this->_loaded[$name]);

[202] Fix | Delete

}

[203] Fix | Delete

[204] Fix | Delete

/**

[205] Fix | Delete

* Get loaded object instance.

[206] Fix | Delete

[207] Fix | Delete

* @param string $name Name of object.

[208] Fix | Delete

* @return object|null Object instance if loaded else null.

[209] Fix | Delete

[210] Fix | Delete

public function get($name)

[211] Fix | Delete

{

[212] Fix | Delete

if (isset($this->_loaded[$name])) {

[213] Fix | Delete

return $this->_loaded[$name];

[214] Fix | Delete

}

[215] Fix | Delete

[216] Fix | Delete

return null;

[217] Fix | Delete

}

[218] Fix | Delete

[219] Fix | Delete

/**

[220] Fix | Delete

* Provide public read access to the loaded objects

[221] Fix | Delete

[222] Fix | Delete

* @param string $name Name of property to read

[223] Fix | Delete

* @return mixed

[224] Fix | Delete

[225] Fix | Delete

public function __get($name)

[226] Fix | Delete

{

[227] Fix | Delete

return $this->get($name);

[228] Fix | Delete

}

[229] Fix | Delete

[230] Fix | Delete

/**

[231] Fix | Delete

* Provide isset access to _loaded

[232] Fix | Delete

[233] Fix | Delete

* @param string $name Name of object being checked.

[234] Fix | Delete

* @return bool

[235] Fix | Delete

[236] Fix | Delete

public function __isset($name)

[237] Fix | Delete

{

[238] Fix | Delete

return isset($this->_loaded[$name]);

[239] Fix | Delete

}

[240] Fix | Delete

[241] Fix | Delete

/**

[242] Fix | Delete

* Sets an object.

[243] Fix | Delete

[244] Fix | Delete

* @param string $name Name of a property to set.

[245] Fix | Delete

* @param mixed $object Object to set.

[246] Fix | Delete

* @return void

[247] Fix | Delete

[248] Fix | Delete

public function __set($name, $object)

[249] Fix | Delete

{

[250] Fix | Delete

$this->set($name, $object);

[251] Fix | Delete

}

[252] Fix | Delete

[253] Fix | Delete

/**

[254] Fix | Delete

* Unsets an object.

[255] Fix | Delete

[256] Fix | Delete

* @param string $name Name of a property to unset.

[257] Fix | Delete

* @return void

[258] Fix | Delete

[259] Fix | Delete

public function __unset($name)

[260] Fix | Delete

{

[261] Fix | Delete

$this->unload($name);

[262] Fix | Delete

}

[263] Fix | Delete

[264] Fix | Delete

/**

[265] Fix | Delete

* Normalizes an object array, creates an array that makes lazy loading

[266] Fix | Delete

* easier

[267] Fix | Delete

[268] Fix | Delete

* @param array $objects Array of child objects to normalize.

[269] Fix | Delete

* @return array Array of normalized objects.

[270] Fix | Delete

[271] Fix | Delete

public function normalizeArray($objects)

[272] Fix | Delete

{

[273] Fix | Delete

$normal = [];

[274] Fix | Delete

foreach ($objects as $i => $objectName) {

[275] Fix | Delete

$config = [];

[276] Fix | Delete

if (!is_int($i)) {

[277] Fix | Delete

$config = (array)$objectName;

[278] Fix | Delete

$objectName = $i;

[279] Fix | Delete

}

[280] Fix | Delete

list(, $name) = pluginSplit($objectName);

[281] Fix | Delete

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

[282] Fix | Delete

$normal[$name] = $config;

[283] Fix | Delete

} else {

[284] Fix | Delete

$normal[$name] = ['class' => $objectName, 'config' => $config];

[285] Fix | Delete

}

[286] Fix | Delete

}

[287] Fix | Delete

[288] Fix | Delete

return $normal;

[289] Fix | Delete

}

[290] Fix | Delete

[291] Fix | Delete

/**

[292] Fix | Delete

* Clear loaded instances in the registry.

[293] Fix | Delete

[294] Fix | Delete

* If the registry subclass has an event manager, the objects will be detached from events as well.

[295] Fix | Delete

[296] Fix | Delete

* @return $this

[297] Fix | Delete

[298] Fix | Delete

public function reset()

[299] Fix | Delete

{

[300] Fix | Delete

foreach (array_keys($this->_loaded) as $name) {

[301] Fix | Delete

$this->unload($name);

[302] Fix | Delete

}

[303] Fix | Delete

[304] Fix | Delete

return $this;

[305] Fix | Delete

}

[306] Fix | Delete

[307] Fix | Delete

/**

[308] Fix | Delete

* Set an object directly into the registry by name.

[309] Fix | Delete

[310] Fix | Delete

* If this collection implements events, the passed object will

[311] Fix | Delete

* be attached into the event manager

[312] Fix | Delete

[313] Fix | Delete

* @param string $objectName The name of the object to set in the registry.

[314] Fix | Delete

* @param object $object instance to store in the registry

[315] Fix | Delete

* @return $this

[316] Fix | Delete

[317] Fix | Delete

public function set($objectName, $object)

[318] Fix | Delete

{

[319] Fix | Delete

list(, $name) = pluginSplit($objectName);

[320] Fix | Delete

[321] Fix | Delete

// Just call unload if the object was loaded before

[322] Fix | Delete

if (array_key_exists($objectName, $this->_loaded)) {

[323] Fix | Delete

$this->unload($objectName);

[324] Fix | Delete

}

[325] Fix | Delete

if ($this instanceof EventDispatcherInterface && $object instanceof EventListenerInterface) {

[326] Fix | Delete

$this->getEventManager()->on($object);

[327] Fix | Delete

}

[328] Fix | Delete

$this->_loaded[$name] = $object;

[329] Fix | Delete

[330] Fix | Delete

return $this;

[331] Fix | Delete

}

[332] Fix | Delete

[333] Fix | Delete

/**

[334] Fix | Delete

* Remove an object from the registry.

[335] Fix | Delete

[336] Fix | Delete

* If this registry has an event manager, the object will be detached from any events as well.

[337] Fix | Delete

[338] Fix | Delete

* @param string $objectName The name of the object to remove from the registry.

[339] Fix | Delete

* @return $this

[340] Fix | Delete

[341] Fix | Delete

public function unload($objectName)

[342] Fix | Delete

{

[343] Fix | Delete

if (empty($this->_loaded[$objectName])) {

[344] Fix | Delete

list($plugin, $objectName) = pluginSplit($objectName);

[345] Fix | Delete

$this->_throwMissingClassError($objectName, $plugin);

[346] Fix | Delete

}

[347] Fix | Delete

[348] Fix | Delete

$object = $this->_loaded[$objectName];

[349] Fix | Delete

if ($this instanceof EventDispatcherInterface && $object instanceof EventListenerInterface) {

[350] Fix | Delete

$this->getEventManager()->off($object);

[351] Fix | Delete

}

[352] Fix | Delete

unset($this->_loaded[$objectName]);

[353] Fix | Delete

[354] Fix | Delete

return $this;

[355] Fix | Delete

}

[356] Fix | Delete

[357] Fix | Delete

/**

[358] Fix | Delete

* Returns an array iterator.

[359] Fix | Delete

[360] Fix | Delete

* @return \ArrayIterator

[361] Fix | Delete

[362] Fix | Delete

public function getIterator()

[363] Fix | Delete

{

[364] Fix | Delete

return new ArrayIterator($this->_loaded);

[365] Fix | Delete

}

[366] Fix | Delete

[367] Fix | Delete

/**

[368] Fix | Delete

* Returns the number of loaded objects.

[369] Fix | Delete

[370] Fix | Delete

* @return int

[371] Fix | Delete

[372] Fix | Delete

public function count()

[373] Fix | Delete

{

[374] Fix | Delete

return count($this->_loaded);

[375] Fix | Delete

}

[376] Fix | Delete

[377] Fix | Delete

/**

[378] Fix | Delete

* Debug friendly object properties.

[379] Fix | Delete

[380] Fix | Delete

* @return array

[381] Fix | Delete

[382] Fix | Delete

public function __debugInfo()

[383] Fix | Delete

{

[384] Fix | Delete

$properties = get_object_vars($this);

[385] Fix | Delete

if (isset($properties['_loaded'])) {

[386] Fix | Delete

$properties['_loaded'] = array_keys($properties['_loaded']);

[387] Fix | Delete

}

[388] Fix | Delete

[389] Fix | Delete

return $properties;

[390] Fix | Delete

}

[391] Fix | Delete

}

[392] Fix | Delete

[393] Fix | Delete