Class TimestampBehavior
array<string, mixed>
Runtime config
bool
Whether the config property has already been configured with defaults
array<string, mixed>
Default config
array<string, array>
Reflection method cache for behaviors.
Cake\ORM\Table
Table instance.
Cake\I18n\FrozenTime|null
Current timestamp
Constructor
Deletes a single config key.
Reads a config key.
Writes a config key.
Gets the methods implemented by this behavior
Removes aliased methods that would otherwise be duplicated by userland configuration.
Update a field, if it hasn't been updated already
Merge provided config with existing config. Unlike config()
which does a recursive merge for nested keys, this method does a simple merge.
Returns the config.
Returns the config for this specific key.
Get the table instance this behavior is bound to.
There is only one event handler, it can be configured to be called for any event
implementedEvents
implementedFinders
implementedMethods
Initialize hook
Sets the config.
Get the table instance this behavior is bound to.
Get or set the timestamp to be used
Touch an entity
verifyConfig
__construct(Cake\ORM\Table $table, array<string, mixed> $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<string, mixed>
$config optional The config for this behavior.
_configDelete(string $key): void
Deletes a single config key.
string
$key Key to delete.
void
Cake\Core\Exception\CakeException
_configRead(string|null $key): mixed
Reads a config key.
string|null
$key Key to read.
mixed
_configWrite(array<string, mixed>|string $key, mixed $value, string|bool $merge = false): void
Writes a config key.
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.
void
Cake\Core\Exception\CakeException
_reflectionCache(): array
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
array
ReflectionException
_resolveMethodAliases(string $key, array<string, mixed> $defaults, array<string, mixed> $config): array
Removes aliased methods that would otherwise be duplicated by userland configuration.
string
$key The key to filter.
array<string, mixed>
$defaults The default method mappings.
array<string, mixed>
$config The customized method mappings.
array
_updateField(Cake\Datasource\EntityInterface $entity, string $field, bool $refreshTimestamp): void
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.
void
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']);
array<string, mixed>|string
$key The key to set, or a complete array of configs.
mixed|null
$value optional The value to set.
$this
getConfig(string|null $key = null, mixed $default = null): mixed
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.
mixed
getConfigOrFail(string $key): mixed
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.
mixed
InvalidArgumentException
getTable(): Cake\ORM\Table
Get the table instance this behavior is bound to.
Cake\ORM\Table
handleEvent(Cake\Event\EventInterface $event, Cake\Datasource\EntityInterface $entity): true
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.
true
UnexpectedValueException
UnexpectedValueException
implementedEvents(): array<string, mixed>
implementedEvents
The implemented events of this behavior depend on configuration
array<string, mixed>
implementedFinders(): array
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
array
ReflectionException
implementedMethods(): array
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
array
ReflectionException
initialize(array<string, mixed> $config): void
Initialize hook
If events are specified - do not merge them with existing events, overwrite the events to listen on
array<string, mixed>
$config The config for this behavior.
void
setConfig(array<string, mixed>|string $key, mixed|null $value = null, bool $merge = true): $this
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']);
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.
$this
Cake\Core\Exception\CakeException
table(): Cake\ORM\Table
Get the table instance this behavior is bound to.
Cake\ORM\Table
timestamp(DateTimeInterface|null $ts = null, bool $refreshTimestamp = false): Cake\I18n\FrozenTime
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\FrozenTime
touch(Cake\Datasource\EntityInterface $entity, string $eventName = 'Model.beforeSave'): bool
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.
bool
verifyConfig(): void
verifyConfig
Checks that implemented keys contain values pointing at callable.
void
Cake\Core\Exception\CakeException
Runtime config
array<string, mixed>
Whether the config property has already been configured with defaults
bool
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.
array<string, mixed>
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.
array<string, array>
Table instance.
Cake\ORM\Table
Current timestamp
Cake\I18n\FrozenTime|null
© 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.4/class-Cake.ORM.Behavior.TimestampBehavior.html