Base class for behaviors.
Behaviors allow you to simulate mixins, and create reusable blocks of application logic, that can be reused across several models. Behaviors also provide a way to hook into model callbacks and augment their behavior.
Behaviors can provide mixin like features by declaring public methods. These methods will be accessible on the tables the behavior has been added to.
function doSomething($arg1, $arg2) { // do something }
Would be called like $table->doSomething($arg1, $arg2);
.
Behaviors can listen to any events fired on a Table. By default, CakePHP provides a number of lifecycle events your behaviors can listen to:
beforeFind(EventInterface $event, Query $query, ArrayObject $options, boolean $primary)
Fired before each find operation. By stopping the event and supplying a return value you can bypass the find operation entirely. Any changes done to the $query instance will be retained for the rest of the find. The $primary parameter indicates whether this is the root query, or an associated query.
buildValidator(EventInterface $event, Validator $validator, string $name)
Fired when the validator object identified by $name is being built. You can use this callback to add validation rules or add validation providers.
buildRules(EventInterface $event, RulesChecker $rules)
Fired when the rules checking object for the table is being built. You can use this callback to add more rules to the set.
beforeRules(EventInterface $event, EntityInterface $entity, ArrayObject $options, $operation)
Fired before an entity is validated using by a rules checker. By stopping this event, you can return the final value of the rules checking operation.
afterRules(EventInterface $event, EntityInterface $entity, ArrayObject $options, bool $result, $operation)
Fired after the rules have been checked on the entity. By stopping this event, you can return the final value of the rules checking operation.
beforeSave(EventInterface $event, EntityInterface $entity, ArrayObject $options)
Fired before each entity is saved. Stopping this event will abort the save operation. When the event is stopped the result of the event will be returned.
afterSave(EventInterface $event, EntityInterface $entity, ArrayObject $options)
Fired after an entity is saved.
beforeDelete(EventInterface $event, EntityInterface $entity, ArrayObject $options)
Fired before an entity is deleted. By stopping this event you will abort the delete operation.
afterDelete(EventInterface $event, EntityInterface $entity, ArrayObject $options)
Fired after an entity has been deleted.
In addition to the core events, behaviors can respond to any event fired from your Table classes including custom application specific ones.
You can set the priority of a behaviors callbacks by using the priority
setting when attaching a behavior. This will set the priority for all the callbacks a behavior provides.
Behaviors can provide finder methods that hook into a Table's find() method. Custom finders are a great way to provide preset queries that relate to your behavior. For example a SluggableBehavior could provide a find('slugged') finder. Behavior finders are implemented the same as other finders. Any method starting with find
will be setup as a finder. Your finder methods should expect the following arguments:
findSlugged(Query $query, array $options)
array<string, mixed>
Runtime config
bool
Whether the config property has already been configured with defaults
array<string, mixed>
Default configuration
array<string, array>
Reflection method cache for behaviors.
Cake\ORM\Table
Table instance.
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.
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.
Gets the Model callbacks this behavior is interested in.
implementedFinders
implementedMethods
Constructor hook method.
Sets the config.
Get the table instance this behavior is bound to.
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
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
implementedEvents(): array<string, mixed>
Gets the Model callbacks this behavior is interested in.
By defining one of the callback methods a behavior is assumed to be interested in the related event.
Override this method if you need to add non-conventional event listeners. Or if you want your behavior to listen to non-standard events.
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
Constructor hook method.
Implement this method to avoid having to overwrite the constructor and call parent.
array<string, mixed>
$config The configuration settings provided to 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
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 configuration
These are merged with user-provided configuration when the behavior is used.
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
© 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.html