Class Identity
Identity object
Property Summary
-
$_config protected
array<string, mixed>Runtime config
-
$_configInitialized protected
boolWhether the config property has already been configured with defaults
-
$_defaultConfig protected
arrayDefault configuration.
-
$data protected
ArrayAccess|arrayIdentity data
Method Summary
-
__construct() public
Constructor
-
__debugInfo() public
Debug info
-
__get() public
Get data from the identity using object access.
-
__isset() public
Check if the field isset() using object access.
-
_configDelete() protected
Deletes a single config key.
-
_configRead() protected
Reads a config key.
-
_configWrite() protected
Writes a config key.
-
configShallow() public
Merge provided config with existing config. Unlike
config()which does a recursive merge for nested keys, this method does a simple merge. -
get() public
Get data from the identity
-
getConfig() public
Returns the config.
-
getConfigOrFail() public
Returns the config for this specific key.
-
getIdentifier() public
Get the primary key/id field for the identity.
-
getOriginalData() public
Gets the original data object.
-
offsetExists() public
Whether a offset exists
-
offsetGet() public
Offset to retrieve
-
offsetSet() public
Offset to set
-
offsetUnset() public
Offset to unset
-
setConfig() public
Sets the config.
Method Detail
__construct() ¶ public
__construct(ArrayAccess|array $data, array $config = [])Constructor
Parameters
-
ArrayAccess|array$data Identity data
-
array$config optional Config options
__get() ¶ public
__get(string $field): mixedGet data from the identity using object access.
Parameters
-
string$field Field in the user data.
Returns
mixed__isset() ¶ public
__isset(string $field): boolCheck if the field isset() using object access.
Parameters
-
string$field Field in the user data.
Returns
bool_configDelete() ¶ protected
_configDelete(string $key): voidDeletes a single config key.
Parameters
-
string$key Key to delete.
Returns
voidThrows
Cake\Core\Exception\CakeExceptionif attempting to clobber existing config
_configRead() ¶ protected
_configRead(string|null $key): mixedReads 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): voidWrites 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
voidThrows
Cake\Core\Exception\CakeExceptionif attempting to clobber existing config
configShallow() ¶ public
configShallow(array<string, mixed>|string $key, mixed|null $value = null): $thisMerge 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
$thisget() ¶ public
get(string $field): mixedGet data from the identity
Parameters
-
string$field Field in the user data.
Returns
mixedgetConfig() ¶ public
getConfig(string|null $key = null, mixed $default = null): mixedReturns 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
mixedgetConfigOrFail() ¶ public
getConfigOrFail(string $key): mixedReturns 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
mixedThrows
InvalidArgumentExceptiongetIdentifier() ¶ public
getIdentifier(): array|string|int|nullGet the primary key/id field for the identity.
Returns
array|string|int|nullgetOriginalData() ¶ public
getOriginalData(): ArrayAccess|arrayGets the original data object.
Returns
ArrayAccess|arrayoffsetExists() ¶ public
offsetExists(mixed $offset): boolWhether a offset exists
Parameters
-
mixed$offset Offset
Returns
boolLinks
offsetGet() ¶ public
offsetGet(mixed $offset): Authentication\IdentityInterface|nullOffset to retrieve
Parameters
-
mixed$offset Offset
Returns
Authentication\IdentityInterface|nullLinks
offsetSet() ¶ public
offsetSet(mixed $offset, mixed $value): voidOffset to set
Parameters
-
mixed$offset The offset to assign the value to.
-
mixed$value Value
Returns
voidThrows
BadMethodCallExceptionLinks
offsetUnset() ¶ public
offsetUnset(mixed $offset): voidOffset to unset
Parameters
-
mixed$offset Offset
Returns
voidThrows
BadMethodCallExceptionLinks
setConfig() ¶ public
setConfig(array<string, mixed>|string $key, mixed|null $value = null, bool $merge = true): $thisSets 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
$thisThrows
Cake\Core\Exception\CakeExceptionWhen trying to set a key that is invalid.
Property Detail
$_configInitialized ¶ protected
Whether the config property has already been configured with defaults
Type
bool