$_table
$_table : \Cake\ORM\Table
Table instance.
CounterCache behavior
Enables models to cache the amount of connections in a given relation.
Examples with Post model belonging to User model
Regular counter cache
[
'Users' => [
'post_count'
]
]Counter cache with scope
[
'Users' => [
'posts_published' => [
'conditions' => [
'published' => true
]
]
]
]Counter cache using custom find
[
'Users' => [
'posts_published' => [
'finder' => 'published' // Will be using findPublished()
]
]
]Counter cache using lambda function returning the count This is equivalent to example #2
[
'Users' => [
'posts_published' => function (Event $event, EntityInterface $entity, Table $table) {
$query = $table->find('all')->where([
'published' => true,
'user_id' => $entity->get('user_id')
]);
return $query->count();
}
]
]When using a lambda function you can return false to disable updating the counter value
for the current operation.
Ignore updating the field if it is dirty
[
'Users' => [
'posts_published' => [
'ignoreDirty' => true
]
]
]You can disable counter updates entirely by sending the ignoreCounterCache option
to your save operation:
$this->Articles->save($article, ['ignoreCounterCache' => true]);$_table : \Cake\ORM\Table
Table instance.
__construct(\Cake\ORM\Table $table, array $config = array())
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 | The config for this behavior. |
getTable() : \Cake\ORM\Table
Get the table instance this behavior is bound to.
The bound table instance.
implementedEvents() : array
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.
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
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
setConfig(string|array $key, mixed|null $value = null, boolean $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']);| string|array | $key | The key to set, or a complete array of configs. |
| mixed|null | $value | The value to set. |
| boolean | $merge | Whether to recursively merge or overwrite existing config, defaults to true. |
When trying to set a key that is invalid.
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 | The key to get or null for the whole config. |
| mixed | $default | The return value when the key does not exist. |
Config value being read.
config(string|array|null $key = null, mixed|null $value = null, boolean $merge = true) : mixed
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']);| string|array|null | $key | The key to get/set, or a complete array of configs. |
| mixed|null | $value | The value to set. |
| boolean | $merge | Whether to recursively merge or overwrite existing config, defaults to true. |
When trying to set a key that is invalid.
Config value being read, or the object itself on write operations.
configShallow(string|array $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']);| string|array | $key | The key to set, or a complete array of configs. |
| mixed|null | $value | The value to set. |
beforeSave(\Cake\Event\Event $event, \Cake\Datasource\EntityInterface $entity, \ArrayObject $options) : void
beforeSave callback.
Check if a field, which should be ignored, is dirty
| \Cake\Event\Event | $event | The beforeSave event that was fired |
| \Cake\Datasource\EntityInterface | $entity | The entity that is going to be saved |
| \ArrayObject | $options | The options for the query |
afterSave(\Cake\Event\Event $event, \Cake\Datasource\EntityInterface $entity, \ArrayObject $options) : void
afterSave callback.
Makes sure to update counter cache when a new record is created or updated.
| \Cake\Event\Event | $event | The afterSave event that was fired. |
| \Cake\Datasource\EntityInterface | $entity | The entity that was saved. |
| \ArrayObject | $options | The options for the query |
afterDelete(\Cake\Event\Event $event, \Cake\Datasource\EntityInterface $entity, \ArrayObject $options) : void
afterDelete callback.
Makes sure to update counter cache when a record is deleted.
| \Cake\Event\Event | $event | The afterDelete event that was fired. |
| \Cake\Datasource\EntityInterface | $entity | The entity that was deleted. |
| \ArrayObject | $options | The options for the query |
_resolveMethodAliases(string $key, array $defaults, array $config) : array
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. |
A de-duped list of config data.
_configWrite(string|array $key, mixed $value, boolean|string $merge = false) : void
Writes a config key.
| string|array | $key | Key to write to. |
| mixed | $value | Value to write. |
| boolean|string | $merge | True to merge recursively, 'shallow' for simple merge, false to overwrite, defaults to false. |
if attempting to clobber existing config
_processAssociations(\Cake\Event\Event $event, \Cake\Datasource\EntityInterface $entity) : void
Iterate all associations and update counter caches.
| \Cake\Event\Event | $event | Event instance. |
| \Cake\Datasource\EntityInterface | $entity | Entity. |
_processAssociation(\Cake\Event\Event $event, \Cake\Datasource\EntityInterface $entity, \Cake\ORM\Association $assoc, array $settings) : void
Updates counter cache for a single association
| \Cake\Event\Event | $event | Event instance. |
| \Cake\Datasource\EntityInterface | $entity | Entity |
| \Cake\ORM\Association | $assoc | The association object |
| array | $settings | The settings for for counter cache for this association |
If invalid callable is passed.
_getCount(array $config, array $conditions) : integer
Fetches and returns the count for a single field in an association
| array | $config | The counter cache configuration for a single field |
| array | $conditions | Additional conditions given to the query |
The number of relations matching the given config and conditions