Class IdentityHelper
Identity Helper
A convenience helper to access the identity data
Property Summary
-
$_View protected
Cake\View\View
The View instance this helper is attached to
-
$_config protected
array<string, mixed>
Runtime config
-
$_configInitialized protected
bool
Whether the config property has already been configured with defaults
-
$_defaultConfig protected
array<string, mixed>
Configuration options
-
$_helperMap protected
array<string, array>
A helper lookup table used to lazy load helper objects.
-
$_identity protected
nullAuthentication\IdentityInterface
Identity Object
-
$helpers protected
array
List of helpers used by this helper
Method Summary
-
__call() public
Provide non fatal errors on missing method calls.
-
__construct() public
Default Constructor
-
__debugInfo() public
Returns an array that can be used to describe the internal state of this object.
-
__get() public
Lazy loads helpers.
-
_configDelete() protected
Deletes a single config key.
-
_configRead() protected
Reads a config key.
-
_configWrite() protected
Writes a config key.
-
_confirm() protected
Returns a string to be used as onclick handler for confirm dialogs.
-
addClass() public
Adds the given class to the element options
-
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
Gets user data
-
getConfig() public
Returns the config.
-
getConfigOrFail() public
Returns the config for this specific key.
-
getId() public
Gets the id of the current logged in identity
-
getView() public
Get the view instance this helper is bound to.
-
implementedEvents() public
Get the View callbacks this helper is interested in.
-
initialize() public
Constructor hook method.
-
is() public
This check can be used to tell if a record that belongs to some user is the current logged in user and compare other fields as well
-
isLoggedIn() public
Checks if a user is logged in
-
setConfig() public
Sets the config.
Method Detail
__call() ¶ public
__call(string $method, array $params): mixed|void
Provide non fatal errors on missing method calls.
Parameters
-
string
$method Method to invoke
-
array
$params Array of params for the method.
Returns
mixed|void
__construct() ¶ public
__construct(Cake\View\View $view, array<string, mixed> $config = [])
Default Constructor
Parameters
-
Cake\View\View
$view The View this helper is being attached to.
-
array<string, mixed>
$config optional Configuration settings for the helper.
__debugInfo() ¶ public
__debugInfo(): array<string, mixed>
Returns an array that can be used to describe the internal state of this object.
Returns
array<string, mixed>
__get() ¶ public
__get(string $name): Cake\View\Helper|null|void
Lazy loads helpers.
Parameters
-
string
$name Name of the property being accessed.
Returns
Cake\View\Helper|null|void
_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
_confirm() ¶ protected
_confirm(string $okCode, string $cancelCode): string
Returns a string to be used as onclick handler for confirm dialogs.
Parameters
-
string
$okCode Code to be executed after user chose 'OK'
-
string
$cancelCode Code to be executed after user chose 'Cancel'
Returns
string
addClass() ¶ public
addClass(array<string, mixed> $options, string $class, string $key = 'class'): array<string, mixed>
Adds the given class to the element options
Parameters
-
array<string, mixed>
$options Array options/attributes to add a class to
-
string
$class The class name being added.
-
string
$key optional the key to use for class. Defaults to
'class'
.
Returns
array<string, mixed>
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|null $key = null): mixed
Gets user data
Parameters
-
string|null
$key optional Key of something you want to get from the identity data
Returns
mixed
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
getId() ¶ public
getId(): string|int|array|null
Gets the id of the current logged in identity
Returns
string|int|array|null
getView() ¶ public
getView(): Cake\View\View
Get the view instance this helper is bound to.
Returns
Cake\View\View
implementedEvents() ¶ public
implementedEvents(): array<string, mixed>
Get the View callbacks this helper is interested in.
By defining one of the callback methods a helper is assumed to be interested in the related event.
Override this method if you need to add non-conventional event listeners. Or if you want helpers to listen to non-standard events.
Returns
array<string, mixed>
initialize() ¶ public
initialize(array<string, mixed> $config): void
Constructor hook method.
Implement this method to avoid having to overwrite the constructor and call parent.
Parameters
-
array<string, mixed>
$config The configuration settings provided to this helper.
Returns
void
is() ¶ public
is(int|string $id, string $field = 'id'): bool
This check can be used to tell if a record that belongs to some user is the current logged in user and compare other fields as well
If you have more complex requirements on visibility checks based on some kind of permission you should use the Authorization plugin instead:
https://github.com/cakephp/authorization
This method is mostly a convenience method for simple cases and not intended to replace any kind of proper authorization implementation.
Parameters
-
int|string
$id Identity id to check against
-
string
$field optional Name of the field in the identity data to check against, id by default
Returns
bool
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.
Property Detail
$_configInitialized ¶ protected
Whether the config property has already been configured with defaults
Type
bool
$_defaultConfig ¶ protected
Configuration options
identityAttribute
- The request attribute which holds the identity.
Type
array<string, mixed>
$_helperMap ¶ protected
A helper lookup table used to lazy load helper objects.
Type
array<string, array>