Class TimestampBehavior
Class TimestampBehavior
- Cake\ORM\Behavior implements Cake\Event\EventListenerInterface uses Cake\Core\InstanceConfigTrait
-
Cake\ORM\Behavior\TimestampBehavior
Properties summary
-
$_defaultConfigprotectedarrayDefault config -
$_tsprotectedCurrent timestamp
Inherited Properties
Method Summary
-
_updateField() protected
Update a field, if it hasn't been updated already -
handleEvent() public
There is only one event handler, it can be configured to be called for any event -
implementedEvents() public
implementedEvents -
initialize() public
Initialize hook -
timestamp() public
Get or set the timestamp to be used -
touch() public
Touch an entity
Method Detail
_updateField() protected ¶
_updateField( Cake\Datasource\EntityInterface $entity , string $field , boolean $refreshTimestamp )
Update a field, if it hasn't been updated already
Parameters
-
Cake\Datasource\EntityInterface$entity - Entity instance.
- string $field
- Field name
- boolean $refreshTimestamp
- Whether to refresh timestamp.
handleEvent() public ¶
handleEvent( Cake\Event\Event $event , Cake\Datasource\EntityInterface $entity )
There is only one event handler, it can be configured to be called for any event
Parameters
-
Cake\Event\Event$event - Event instance.
-
Cake\Datasource\EntityInterface$entity - Entity instance.
Returns
Returns true irrespective of the behavior logic, the save will not be prevented.
Throws
if a field's when value is misdefined
UnexpectedValueException
When 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
Overrides
initialize() 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.
Overrides
timestamp() public ¶
timestamp( DateTime $ts null , boolean $refreshTimestamp false )
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
- DateTime $ts optional null
- Timestamp
- boolean $refreshTimestamp optional false
- If true timestamp is refreshed.
Returns
touch() public ¶
touch( Cake\Datasource\EntityInterface $entity , string $eventName 'Model.beforeSave' )
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 'Model.beforeSave'
- Event name.
Returns
true if a field is updated, false if no action performed
Methods inherited from Cake\ORM\Behavior
__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.
_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
Throws
_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
A de-duped list of config data.
implementedFinders() 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
Throws
implementedMethods() 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
Throws
verifyConfig() public ¶
verifyConfig( )
verifyConfig
Checks that implemented keys contain values pointing at callable.
Throws
Methods used from Cake\Core\InstanceConfigTrait
_configDelete() protected ¶
_configDelete( string $key )
Deletes a single config key.
Parameters
- string $key
- Key to delete.
Throws
_configRead() protected ¶
_configRead( string|null $key )
Reads a config key.
Parameters
- string|null $key
- Key to read.
Returns
_configWrite() protected ¶
_configWrite( string|array $key , mixed $value , boolean|string $merge false )
Writes a config key.
Parameters
- string|array $key
- Key to write to.
- mixed $value
- Value to write.
- boolean|string $merge optional false
True to merge recursively, 'shallow' for simple merge, false to overwrite, defaults to false.
Throws
config() public ¶
config( string|array|null $key null , mixed|null $value null , boolean $merge true )
Gets/Sets the config.
Usage
Reading the whole config:
$this->config();
Reading a specific value:
$this->config('key');
Reading a nested value:
$this->config('some.nested.key');
Setting a specific value:
$this->config('key', $value);
Setting a nested value:
$this->config('some.nested.key', $value);
Updating multiple config settings at the same time:
$this->config(['one' => 'value', 'another' => 'value']);
Deprecated
Parameters
- string|array|null $key optional null
- The key to get/set, or a complete array of configs.
- mixed|null $value optional null
- The value to set.
- boolean $merge optional true
- Whether to recursively merge or overwrite existing config, defaults to true.
Returns
Config value being read, or the object itself on write operations.
Throws
configShallow() public ¶
configShallow( string|array $key , mixed|null $value null )
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 null
- The value to set.
Returns
$this
getConfig() public ¶
getConfig( string|null $key null , mixed $default null )
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 null
- The key to get or null for the whole config.
- mixed $default optional null
- The return value when the key does not exist.
Returns
Config value being read.
setConfig() public ¶
setConfig( string|array $key , mixed|null $value null , boolean $merge true )
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 null
- The value to set.
- boolean $merge optional true
- Whether to recursively merge or overwrite existing config, defaults to true.
Returns
$this
Throws
Properties detail
$_defaultConfig ¶
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.
[
'implementedFinders' => [],
'implementedMethods' => [
'timestamp' => 'timestamp',
'touch' => 'touch'
],
'events' => [
'Model.beforeSave' => [
'created' => 'new',
'modified' => 'always'
]
],
'refreshTimestamp' => true
]