Class TimestampBehavior
Class TimestampBehavior
Properties summary
-
$_config protected
arrayRuntime config
-
$_configInitialized protected
boolWhether the config property has already been configured with defaults
-
$_defaultConfig protected
arrayDefault config
-
$_reflectionCache protected static
arrayReflection method cache for behaviors.
-
$_table protected
\Cake\ORM\TableTable instance.
-
$_ts protected
\Cake\I18n\TimeCurrent timestamp
Method Summary
-
__construct() public
Constructor
-
_configDelete() protected
Deletes a single config key.
-
_configRead() protected
Reads a config key.
-
_configWrite() protected
Writes a config key.
-
_reflectionCache() protected
Gets the methods implemented by this behavior
-
_resolveMethodAliases() protected
Removes aliased methods that would otherwise be duplicated by userland configuration.
-
_updateField() protected
Update a field, if it hasn't been updated already
-
configShallow() public
Merge provided config with existing config. Unlike
config()which does a recursive merge for nested keys, this method does a simple merge. -
getConfig() public
Returns the config.
-
getConfigOrFail() public
Returns the config for this specific key.
-
getTable() public
Get the table instance this behavior is bound to.
-
handleEvent() public
There is only one event handler, it can be configured to be called for any event
-
implementedEvents() public
implementedEvents
-
implementedFinders() public
implementedFinders
-
implementedMethods() public
implementedMethods
-
initialize() public
Initialize hook
-
setConfig() public
Sets the config.
-
timestamp() public
Get or set the timestamp to be used
-
touch() public
Touch an entity
-
verifyConfig() public
verifyConfig
Method Detail
__construct() public ¶
__construct(\Cake\ORM\Table $table, array $config)
Constructor
Merges config with the default and store in the config property
Parameters
-
\Cake\ORM\Table$table The table this behavior is attached to.
-
array$config optional The config for this behavior.
_configDelete() protected ¶
_configDelete(string $key)
Deletes a single config key.
Parameters
-
string$key Key to delete.
Throws
Cake\Core\Exception\Exceptionif attempting to clobber existing config
_configRead() protected ¶
_configRead(?string $key)
Reads a config key.
Parameters
-
string|null$key Key to read.
Returns
mixed_configWrite() protected ¶
_configWrite(mixed $key, mixed $value, mixed $merge)
Writes a config key.
Parameters
-
string|array$key Key to write to.
-
mixed$value Value to write.
-
bool|string$merge optional True to merge recursively, 'shallow' for simple merge, false to overwrite, defaults to false.
Throws
Cake\Core\Exception\Exceptionif attempting to clobber existing config
_reflectionCache() protected ¶
_reflectionCache()
Gets the methods implemented by this behavior
Uses the implementedEvents() method to exclude callback methods.
Methods starting with _ will be ignored, as will methods
declared on Cake\ORM\Behavior
Returns
arrayThrows
ReflectionException_resolveMethodAliases() protected ¶
_resolveMethodAliases(string $key, array $defaults, array $config)
Removes aliased methods that would otherwise be duplicated by userland configuration.
Parameters
-
string$key The key to filter.
-
array$defaults The default method mappings.
-
array$config The customized method mappings.
Returns
arrayA de-duped list of config data.
_updateField() protected ¶
_updateField(\Cake\Datasource\EntityInterface $entity, string $field, bool $refreshTimestamp)
Update a field, if it hasn't been updated already
Parameters
-
\Cake\Datasource\EntityInterface$entity Entity instance.
-
string$field Field name
-
bool$refreshTimestamp Whether to refresh timestamp.
configShallow() public ¶
configShallow(mixed $key, mixed $value)
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
-
string|array$key The key to set, or a complete array of configs.
-
mixed|null$value optional The value to set.
Returns
$thisgetConfig() public ¶
getConfig(?string $key, mixed $default)
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
mixedConfiguration data at the named key or null if the key does not exist.
getConfigOrFail() public ¶
getConfigOrFail(string $key)
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
mixedConfiguration data at the named key
Throws
InvalidArgumentExceptiongetTable() public ¶
getTable()
Get the table instance this behavior is bound to.
Returns
\Cake\ORM\TableThe bound table instance.
handleEvent() public ¶
handleEvent(\Cake\Event\EventInterface $event, \Cake\Datasource\EntityInterface $entity)
There is only one event handler, it can be configured to be called for any event
Parameters
-
\Cake\Event\EventInterface$event Event instance.
-
\Cake\Datasource\EntityInterface$entity Entity instance.
Returns
trueReturns true irrespective of the behavior logic, the save will not be prevented.
Throws
UnexpectedValueExceptionif a field's when value is misdefined
UnexpectedValueExceptionWhen the value for an event is not 'always', 'new' or 'existing'
implementedEvents() public ¶
implementedEvents()
implementedEvents
The implemented events of this behavior depend on configuration
Returns
arrayimplementedFinders() public ¶
implementedFinders()
implementedFinders
Provides an alias->methodname map of which finders a behavior implements. Example:
[
'this' => 'findThis',
'alias' => 'findMethodName'
]With the above example, a call to $table->find('this') will call $behavior->findThis()
and a call to $table->find('alias') will call $behavior->findMethodName()
It is recommended, though not required, to define implementedFinders in the config property of child classes such that it is not necessary to use reflections to derive the available method list. See core behaviors for examples
Returns
arrayThrows
ReflectionExceptionimplementedMethods() public ¶
implementedMethods()
implementedMethods
Provides an alias->methodname map of which methods a behavior implements. Example:
[
'method' => 'method',
'aliasedMethod' => 'somethingElse'
]With the above example, a call to $table->method() will call $behavior->method()
and a call to $table->aliasedMethod() will call $behavior->somethingElse()
It is recommended, though not required, to define implementedFinders in the config property of child classes such that it is not necessary to use reflections to derive the available method list. See core behaviors for examples
Returns
arrayThrows
ReflectionExceptioninitialize() public ¶
initialize(array $config)
Initialize hook
If events are specified - do not merge them with existing events, overwrite the events to listen on
Parameters
-
array$config The config for this behavior.
setConfig() public ¶
setConfig(mixed $key, mixed $value, mixed $merge)
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
-
string|array$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\ExceptionWhen trying to set a key that is invalid.
timestamp() public ¶
timestamp(?\DateTimeInterface $ts, bool $refreshTimestamp)
Get or set the timestamp to be used
Set the timestamp to the given DateTime object, or if not passed a new DateTime object
If an explicit date time is passed, the config option refreshTimestamp is
automatically set to false.
Parameters
-
\DateTimeInterface|null$ts optional Timestamp
-
bool$refreshTimestamp optional If true timestamp is refreshed.
Returns
\Cake\I18n\Timetouch() public ¶
touch(\Cake\Datasource\EntityInterface $entity, string $eventName)
Touch an entity
Bumps timestamp fields for an entity. For any fields configured to be updated "always" or "existing", update the timestamp value. This method will overwrite any pre-existing value.
Parameters
-
\Cake\Datasource\EntityInterface$entity Entity instance.
-
string$eventName optional Event name.
Returns
booltrue if a field is updated, false if no action performed
verifyConfig() public ¶
verifyConfig()
verifyConfig
Checks that implemented keys contain values pointing at callable.
Throws
Cake\Core\Exception\Exceptionif config are invalid
Property Detail
$_configInitialized ¶ protected
Whether the config property has already been configured with defaults
Type
bool$_defaultConfig ¶ protected
Default config
These are merged with user-provided config when the behavior is used.
events - an event-name keyed array of which fields to update, and when, for a given event possible values for when a field will be updated are "always", "new" or "existing", to set the field value always, only when a new record or only when an existing record.
refreshTimestamp - if true (the default) the timestamp used will be the current time when the code is executed, to set to an explicit date time value - set refreshTimetamp to false and call setTimestamp() on the behavior class before use.
Type
array$_reflectionCache ¶ protected static
Reflection method cache for behaviors.
Stores the reflected method + finder methods per class. This prevents reflecting the same class multiple times in a single process.
Type
array