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(); } ] ]
_getCount( array $config , array $conditions )
Fetches and returns the count for a single field in an association
$config
$conditions
integer
_processAssociation( Cake\Event\Event $event , Cake\Datasource\EntityInterface $entity , Cake\ORM\Association $assoc , array $settings )
Updates counter cache for a single association
Cake\Event\Event
$event
Cake\Datasource\EntityInterface
$entity
Cake\ORM\Association
$assoc
$settings
_processAssociations( Cake\Event\Event $event , Cake\Datasource\EntityInterface $entity )
Iterate all associations and update counter caches.
Cake\Event\Event
$event
Cake\Datasource\EntityInterface
$entity
afterDelete( Cake\Event\Event $event , Cake\Datasource\EntityInterface $entity )
afterDelete callback.
Makes sure to update counter cache when a record is deleted.
Cake\Event\Event
$event
Cake\Datasource\EntityInterface
$entity
afterSave( Cake\Event\Event $event , Cake\Datasource\EntityInterface $entity )
afterSave callback.
Makes sure to update counter cache when a new record is created or updated.
Cake\Event\Event
$event
Cake\Datasource\EntityInterface
$entity
__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
array
_resolveMethodAliases( string $key , array $defaults , array $config )
Removes aliased methods that would otherwise be duplicated by userland configuration.
$key
$defaults
$config
array
implementedEvents( )
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
Cake\Event\EventListenerInterface::implementedEvents()
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
array
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
array
initialize( array $config )
Constructor hook method.
Implement this method to avoid having to overwrite the constructor and call parent.
$config
verifyConfig( )
verifyConfig
Checks that implemented keys contain values pointing at callable.
Cake\Core\Exception\Exception
_configDelete( string $key )
Delete a single config key
$key
Cake\Core\Exception\Exception
_configRead( string|null $key )
Read a config variable
$key
mixed
_configWrite( string|array $key , mixed $value , boolean|string $merge false )
Write a config variable
$key
$value
$merge
optional false Cake\Core\Exception\Exception
config( string|array|null $key null , mixed|null $value null , boolean $merge true )
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 mixed
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->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
$value
optional null mixed
protected array
Default configuration
These are merged with user-provided configuration when the behavior is used.
[]
protected static array
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.
[]
protected boolean
Whether the config property has already been configured with defaults
false
© 2005–2016 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.
http://api.cakephp.org/3.1/class-Cake.ORM.Behavior.CounterCacheBehavior.html