Class AbstractCollection

Abstract
Namespace: Authentication

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.
$_loaded protected

array<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() abstract protected

Create an instance of a given classname.
_resolveClassName() abstract protected

Should resolve the classname for a given object type.
_throwMissingClassError() abstract 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 array, creates an array that makes 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(array $config = [])

Constructor

Parameters

array $config optional: Configuration

__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

RuntimeException
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() ¶ abstract protected

_create(object|string $class, string $alias, array<string, mixed> $config): object

Create an instance of a given classname.

This method should construct and do any other initialization logic required.

Parameters

object|string $class: The class to build.
string $alias: The alias of the object.
array<string, mixed> $config: The Configuration settings for construction

Returns

object

_resolveClassName() ¶ abstract protected

_resolveClassName(string $class): string|null

Should resolve the classname for a given object type.

Parameters

string $class: The class to resolve.

Returns

string|null

_throwMissingClassError() ¶ abstract protected

_throwMissingClassError(string $class, string|null $plugin): void

Throw an exception when the requested object name is missing.

Parameters

string $class: The class that is missing.
string|null $plugin: The plugin $class is missing from.

Returns

void

Throws

Exception

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

count() ¶ public

count(): int

Returns the number of loaded objects.

Returns

int

get() ¶ public

get(string $name): object

Get loaded object instance.

Parameters

string $name: Name of object.

Returns

object

Throws

RuntimeException
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

getIterator() ¶ public

getIterator(): Traversable

Returns an array iterator.

Returns

Traversable

has() ¶ public

has(string $name): bool

Check whether a given object is loaded.

Parameters

string $name: The object name to check for.

Returns

bool

isEmpty() ¶ public

isEmpty(): bool

Returns true if a collection is empty.

Returns

bool

load() ¶ public

load(string $name, array<string, mixed> $config = []): mixed

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

mixed

Throws

Exception
If the class cannot be found.

loaded() ¶ public

loaded(): array<string>

Get the list of loaded objects.

Returns

array<string>

normalizeArray() ¶ public

normalizeArray(array $objects): array<string, array>

Normalizes an object array, creates an array that makes 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

Property Detail

`$_config` ¶ protected

Runtime config

Type

array<string, mixed>

`$_configInitialized` ¶ protected

Whether the config property has already been configured with defaults

Type

bool

`$_defaultConfig` ¶ protected

Config array.

Type

array

`$_loaded` ¶ protected

Map of loaded objects.

Type

array<object>

Namespaces

Class AbstractCollection

Property Summary

Method Summary

__construct() public

__debugInfo() public

__get() public

__isset() public

__set() public

__unset() public

_checkDuplicate() protected

_configDelete() protected

_configRead() protected

_configWrite() protected

_create() abstract protected

_resolveClassName() abstract protected

_throwMissingClassError() abstract protected

configShallow() public

count() public

get() public

getConfig() public

getConfigOrFail() public

getIterator() public

has() public

isEmpty() public

load() public

loaded() public

normalizeArray() public

reset() public

set() public

setConfig() public

unload() public

Method Detail

__construct() ¶ public

Parameters

__debugInfo() ¶ public

Returns

__get() ¶ public

Parameters

Returns

__isset() ¶ public

Parameters

Returns

__set() ¶ public

Parameters

Returns

__unset() ¶ public

Parameters

Returns

_checkDuplicate() ¶ protected

Parameters

Returns

Throws

_configDelete() ¶ protected

Parameters

Returns

Throws

_configRead() ¶ protected

Parameters

Returns

_configWrite() ¶ protected

Parameters

Returns

Throws

_create() ¶ abstract protected

Parameters

Returns

_resolveClassName() ¶ abstract protected

Parameters

Returns

_throwMissingClassError() ¶ abstract protected

Parameters

Returns

Throws

configShallow() ¶ public

Parameters

Returns

count() ¶ public

Returns

get() ¶ public

`$_config` ¶ protected

`$_configInitialized` ¶ protected

`$_defaultConfig` ¶ protected

`$_loaded` ¶ protected