Class AuthenticatorCollection
Property Summary
-
$_config protected
array<string, mixed>
Runtime config
-
$_configInitialized protected
bool
Whether the config property has already been configured with defaults
-
$_defaultConfig protected
array
Config array.
-
$_identifiers protected
Authentication\Identifier\IdentifierCollection
Identifier collection.
-
$_loaded protected
array<string, object>
Map of loaded objects.
Method Summary
-
__construct() public
Constructor.
-
__debugInfo() public
Debug friendly object properties.
-
__get() public
Provide public read access to the loaded objects
-
__isset() public
Provide isset access to _loaded
-
__set() public
Sets an object.
-
__unset() public
Unsets an object.
-
_checkDuplicate() protected
Check for duplicate object loading.
-
_configDelete() protected
Deletes a single config key.
-
_configRead() protected
Reads a config key.
-
_configWrite() protected
Writes a config key.
-
_create() protected
Creates authenticator instance.
-
_resolveClassName() protected
Resolves authenticator class name.
-
_throwMissingClassError() protected
Throw an exception when the requested object name is missing.
-
configShallow() public
Merge provided config with existing config. Unlike
config()
which does a recursive merge for nested keys, this method does a simple merge. -
count() public
Returns the number of loaded objects.
-
get() public
Get loaded object instance.
-
getConfig() public
Returns the config.
-
getConfigOrFail() public
Returns the config for this specific key.
-
getIterator() public
Returns an array iterator.
-
has() public
Check whether a given object is loaded.
-
isEmpty() public
Returns true if a collection is empty.
-
load() public
Loads/constructs an object instance.
-
loaded() public
Get the list of loaded objects.
-
normalizeArray() public
Normalizes an object configuration array into associative form for making lazy loading easier.
-
reset() public
Clear loaded instances in the registry.
-
set() public
Set an object directly into the registry by name.
-
setConfig() public
Sets the config.
-
unload() public
Remove an object from the registry.
Method Detail
__construct() ¶ public
__construct(Authentication\Identifier\IdentifierCollection $identifiers, array $config = [])
Constructor.
Parameters
-
Authentication\Identifier\IdentifierCollection
$identifiers Identifiers collection.
-
array
$config optional Config array.
__debugInfo() ¶ public
__debugInfo(): array<string, mixed>
Debug friendly object properties.
Returns
array<string, mixed>
__get() ¶ public
__get(string $name): object|null
Provide public read access to the loaded objects
Parameters
-
string
$name Name of property to read
Returns
object|null
__isset() ¶ public
__isset(string $name): bool
Provide isset access to _loaded
Parameters
-
string
$name Name of object being checked.
Returns
bool
__set() ¶ public
__set(string $name, object $object): void
Sets an object.
Parameters
-
string
$name Name of a property to set.
-
object
$object Object to set.
Returns
void
__unset() ¶ public
__unset(string $name): void
Unsets an object.
Parameters
-
string
$name Name of a property to unset.
Returns
void
_checkDuplicate() ¶ protected
_checkDuplicate(string $name, array<string, mixed> $config): void
Check for duplicate object loading.
If a duplicate is being loaded and has different configuration, that is bad and an exception will be raised.
An exception is raised, as replacing the object will not update any references other objects may have. Additionally, simply updating the runtime configuration is not a good option as we may be missing important constructor logic dependent on the configuration.
Parameters
-
string
$name The name of the alias in the registry.
-
array<string, mixed>
$config The config data for the new instance.
Returns
void
Throws
Cake\Core\Exception\CakeException
When a duplicate is found.
_configDelete() ¶ protected
_configDelete(string $key): void
Deletes a single config key.
Parameters
-
string
$key Key to delete.
Returns
void
Throws
Cake\Core\Exception\CakeException
if attempting to clobber existing config
_configRead() ¶ protected
_configRead(string|null $key): mixed
Reads a config key.
Parameters
-
string|null
$key Key to read.
Returns
mixed
_configWrite() ¶ protected
_configWrite(array<string, mixed>|string $key, mixed $value, string|bool $merge = false): void
Writes a config key.
Parameters
-
array<string, mixed>|string
$key Key to write to.
-
mixed
$value Value to write.
-
string|bool
$merge optional True to merge recursively, 'shallow' for simple merge, false to overwrite, defaults to false.
Returns
void
Throws
Cake\Core\Exception\CakeException
if attempting to clobber existing config
_create() ¶ protected
_create(object|string $class, string $alias, array<string, mixed> $config): Authentication\Authenticator\AuthenticatorInterface
Creates authenticator instance.
This method should construct and do any other initialization logic required.
Parameters
-
object|string
$class Authenticator class.
-
string
$alias Authenticator alias.
-
array<string, mixed>
$config Config array.
Returns
Authentication\Authenticator\AuthenticatorInterface
Throws
RuntimeException
_resolveClassName() ¶ protected
_resolveClassName(string $class): class-stringAuthentication\Authenticator\AuthenticatorInterface>|null
Resolves authenticator class name.
Parameters
-
string
$class Class name to be resolved.
Returns
class-stringAuthentication\Authenticator\AuthenticatorInterface>|null
_throwMissingClassError() ¶ protected
_throwMissingClassError(string $class, string|null $plugin): void
Throw an exception when the requested object name is missing.
Parameters
-
string
$class Missing class.
-
string|null
$plugin Class plugin.
Returns
void
Throws
RuntimeException
configShallow() ¶ public
configShallow(array<string, mixed>|string $key, mixed|null $value = null): $this
Merge provided config with existing config. Unlike config()
which does
a recursive merge for nested keys, this method does a simple merge.
Setting a specific value:
$this->configShallow('key', $value);
Setting a nested value:
$this->configShallow('some.nested.key', $value);
Updating multiple config settings at the same time:
$this->configShallow(['one' => 'value', 'another' => 'value']);
Parameters
-
array<string, mixed>|string
$key The key to set, or a complete array of configs.
-
mixed|null
$value optional The value to set.
Returns
$this
get() ¶ public
get(string $name): object
Get loaded object instance.
Parameters
-
string
$name Name of object.
Returns
object
Throws
Cake\Core\Exception\CakeException
If not loaded or found.
getConfig() ¶ public
getConfig(string|null $key = null, mixed $default = null): mixed
Returns the config.
Usage
Reading the whole config:
$this->getConfig();
Reading a specific value:
$this->getConfig('key');
Reading a nested value:
$this->getConfig('some.nested.key');
Reading with default value:
$this->getConfig('some-key', 'default-value');
Parameters
-
string|null
$key optional The key to get or null for the whole config.
-
mixed
$default optional The return value when the key does not exist.
Returns
mixed
getConfigOrFail() ¶ public
getConfigOrFail(string $key): mixed
Returns the config for this specific key.
The config value for this key must exist, it can never be null.
Parameters
-
string
$key The key to get.
Returns
mixed
Throws
InvalidArgumentException
has() ¶ public
has(string $name): bool
Check whether a given object is loaded.
Parameters
-
string
$name The object name to check for.
Returns
bool
load() ¶ public
load(string $name, array<string, mixed> $config = []): object
Loads/constructs an object instance.
Will return the instance in the registry if it already exists.
If a subclass provides event support, you can use $config['enabled'] = false
to exclude constructed objects from being registered for events.
Using {@link \Cake\Controller\Component::$components} as an example. You can alias an object by setting the 'className' key, i.e.,
protected $components = [
'Email' => [
'className' => 'App\Controller\Component\AliasedEmailComponent'
];
];
All calls to the Email
component would use AliasedEmail
instead.
Parameters
-
string
$name The name/class of the object to load.
-
array<string, mixed>
$config optional Additional settings to use when loading the object.
Returns
object
Throws
Exception
If the class cannot be found.
normalizeArray() ¶ public
normalizeArray(array $objects): array<string, array>
Normalizes an object configuration array into associative form for making lazy loading easier.
Parameters
-
array
$objects Array of child objects to normalize.
Returns
array<string, array>
reset() ¶ public
reset(): $this
Clear loaded instances in the registry.
If the registry subclass has an event manager, the objects will be detached from events as well.
Returns
$this
set() ¶ public
set(string $name, object $object): $this
Set an object directly into the registry by name.
If this collection implements events, the passed object will be attached into the event manager
Parameters
-
string
$name The name of the object to set in the registry.
-
object
$object instance to store in the registry
Returns
$this
setConfig() ¶ public
setConfig(array<string, mixed>|string $key, mixed|null $value = null, bool $merge = true): $this
Sets the config.
Usage
Setting a specific value:
$this->setConfig('key', $value);
Setting a nested value:
$this->setConfig('some.nested.key', $value);
Updating multiple config settings at the same time:
$this->setConfig(['one' => 'value', 'another' => 'value']);
Parameters
-
array<string, mixed>|string
$key The key to set, or a complete array of configs.
-
mixed|null
$value optional The value to set.
-
bool
$merge optional Whether to recursively merge or overwrite existing config, defaults to true.
Returns
$this
Throws
Cake\Core\Exception\CakeException
When trying to set a key that is invalid.
unload() ¶ public
unload(string $name): $this
Remove an object from the registry.
If this registry has an event manager, the object will be detached from any events as well.
Parameters
-
string
$name The name of the object to remove from the registry.
Returns
$this