Class TimestampBehavior
arrayRuntime config
boolWhether the config property has already been configured with defaults
arrayDefault config
arrayReflection method cache for behaviors.
\Cake\ORM\TableTable instance.
\Cake\I18n\TimeCurrent timestamp
Removes aliased methods that would otherwise be duplicated by userland configuration.
Merge provided config with existing config. Unlike config() which does a recursive merge for nested keys, this method does a simple merge.
There is only one event handler, it can be configured to be called for any event
__construct(\Cake\ORM\Table $table, array $config)
Constructor
Merges config with the default and store in the config property
\Cake\ORM\Table $table The table this behavior is attached to.
array $config optional The config for this behavior.
_configDelete(string $key)
Deletes a single config key.
string $key Key to delete.
Cake\Core\Exception\Exception_configRead(?string $key)
Reads a config key.
string|null $key Key to read.
mixed_configWrite(mixed $key, mixed $value, mixed $merge)
Writes a config key.
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.
Cake\Core\Exception\Exception_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
arrayReflectionException_resolveMethodAliases(string $key, array $defaults, array $config)
Removes aliased methods that would otherwise be duplicated by userland configuration.
string $key The key to filter.
array $defaults The default method mappings.
array $config The customized method mappings.
arrayA de-duped list of config data.
_updateField(\Cake\Datasource\EntityInterface $entity, string $field, bool $refreshTimestamp)
Update a field, if it hasn't been updated already
\Cake\Datasource\EntityInterface $entity Entity instance.
string $field Field name
bool $refreshTimestamp Whether to refresh timestamp.
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']);
string|array $key The key to set, or a complete array of configs.
mixed|null $value optional The value to set.
$thisgetConfig(?string $key, mixed $default)
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'); 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.
mixedConfiguration data at the named key or null if the key does not exist.
getConfigOrFail(string $key)
Returns the config for this specific key.
The config value for this key must exist, it can never be null.
string $key The key to get.
mixedConfiguration data at the named key
InvalidArgumentExceptiongetTable()
Get the table instance this behavior is bound to.
\Cake\ORM\TableThe bound table instance.
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
\Cake\Event\EventInterface $event Event instance.
\Cake\Datasource\EntityInterface $entity Entity instance.
trueReturns true irrespective of the behavior logic, the save will not be prevented.
UnexpectedValueExceptionUnexpectedValueExceptionimplementedEvents()
implementedEvents
The implemented events of this behavior depend on configuration
arrayimplementedFinders()
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
arrayReflectionExceptionimplementedMethods()
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
arrayReflectionExceptioninitialize(array $config)
Initialize hook
If events are specified - do not merge them with existing events, overwrite the events to listen on
array $config The config for this behavior.
setConfig(mixed $key, mixed $value, mixed $merge)
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']);
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.
$thisCake\Core\Exception\Exceptiontimestamp(?\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.
\DateTimeInterface|null $ts optional Timestamp
bool $refreshTimestamp optional If true timestamp is refreshed.
\Cake\I18n\Timetouch(\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.
\Cake\Datasource\EntityInterface $entity Entity instance.
string $eventName optional Event name.
booltrue if a field is updated, false if no action performed
verifyConfig()
verifyConfig
Checks that implemented keys contain values pointing at callable.
Cake\Core\Exception\ExceptionRuntime config
arrayWhether the config property has already been configured with defaults
boolDefault 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.
arrayReflection method cache for behaviors.
Stores the reflected method + finder methods per class. This prevents reflecting the same class multiple times in a single process.
arrayTable instance.
\Cake\ORM\TableCurrent timestamp
\Cake\I18n\Time
© 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/4.1/class-Cake.ORM.Behavior.TimestampBehavior.html