Class TimestampBehavior
$_defaultConfig
protected array
$_ts
protected _updateField( Cake\Datasource\EntityInterface $entity , string $field , boolean $refreshTimestamp )
Update a field, if it hasn't been updated already
Cake\Datasource\EntityInterface
$entity
$field
$refreshTimestamp
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
Cake\Event\Event
$event
Cake\Datasource\EntityInterface
$entity
implementedEvents( )
implementedEvents
The implemented events of this behavior depend on configuration
Cake\ORM\Behavior::implementedEvents()
initialize( array $config )
Initialize hook
If events are specified - do not merge them with existing events, overwrite the events to listen on
$config
Cake\ORM\Behavior::initialize()
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.
$ts
optional null $refreshTimestamp
optional false Cake\I18n\Time
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.
Cake\Datasource\EntityInterface
$entity
$eventName
optional 'Model.beforeSave' __construct( Cake\ORM\Table $table , array $config = [] )
Constructor
Merges config with the default and store in the config property
Cake\ORM\Table
$table
$config
optional [] _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
_resolveMethodAliases( string $key , array $defaults , array $config )
Removes aliased methods that would otherwise be duplicated by userland configuration.
$key
$defaults
$config
getTable( )
Get the table instance this behavior is bound to.
Cake\ORM\Table
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
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
verifyConfig( )
verifyConfig
Checks that implemented keys contain values pointing at callable.
Cake\Core\Exception\Exception
_configDelete( string $key )
Deletes a single config key.
$key
Cake\Core\Exception\Exception
_configRead( string|null $key )
Reads a config key.
$key
_configWrite( string|array $key , mixed $value , boolean|string $merge = false )
Writes a config key.
$key
$value
$merge
optional false True to merge recursively, 'shallow' for simple merge, false to overwrite, defaults to false.
Cake\Core\Exception\Exception
config( string|array|null $key = null , mixed|null $value = null , boolean $merge = true )
Gets/Sets the config.
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']);
$key
optional null $value
optional null $merge
optional true Cake\Core\Exception\Exception
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']);
$key
$value
optional null getConfig( string|null $key = null , mixed $default = null )
Returns the config.
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');
$key
optional null $default
optional null setConfig( string|array $key , mixed|null $value = null , boolean $merge = true )
Sets the config.
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']);
$key
$value
optional null $merge
optional true Cake\Core\Exception\Exception
protected array
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 ]
© 2005–present The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
https://api.cakephp.org/3.8/class-Cake.ORM.Behavior.TimestampBehavior.html