Class CounterCacheBehavior

[
    'Users' => [
        'post_count'
    ]
]

[
    'Users' => [
        'posts_published' => [
            'conditions' => [
                'published' => true
            ]
        ]
    ]
]

[
    'Users' => [
        'posts_published' => [
            'finder' => 'published' // Will be using findPublished()
        ]
    ]
]

[
    '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();
         }
    ]
]

[
    'Users' => [
        'posts_published' => [
            'ignoreDirty' => true
        ]
    ]
]

$this->Articles->save($article, ['ignoreCounterCache' => true]);

_getCount()source protected

_getCount( array $config , array $conditions )

Fetches and returns the count for a single field in an association

Parameters

array $config

The counter cache configuration for a single field

array $conditions

Additional conditions given to the query

Returns

integer
The number of relations matching the given config and conditions

_processAssociation()source protected

_processAssociation( Cake\Event\Event $event , Cake\Datasource\EntityInterface $entity , Cake\ORM\Association $assoc , array $settings )

Updates counter cache for a single association

Parameters

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

_processAssociations()source protected

_processAssociations( Cake\Event\Event $event , Cake\Datasource\EntityInterface $entity )

Iterate all associations and update counter caches.

Parameters

Cake\Event\Event $event

Event instance.

Cake\Datasource\EntityInterface $entity

Entity.

afterDelete()source public

afterDelete( Cake\Event\Event $event , Cake\Datasource\EntityInterface $entity , ArrayObject $options )

afterDelete callback.

Makes sure to update counter cache when a record is deleted.

Parameters

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

afterSave()source public

afterSave( Cake\Event\Event $event , Cake\Datasource\EntityInterface $entity , ArrayObject $options )

afterSave callback.

Makes sure to update counter cache when a new record is created or updated.

Parameters

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

beforeSave()source public

beforeSave( Cake\Event\Event $event , Cake\Datasource\EntityInterface $entity , ArrayObject $options )

beforeSave callback.

Check if a field, which should be ignored, is dirty

Parameters

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

__construct()source public

__construct( Cake\ORM\Table $table , array $config [] )

Constructor

Merges config with the default and store in the config property

Parameters

Cake\ORM\Table $table

The table this behavior is attached to.

array $config optional []

The config for this behavior.

_reflectionCache()source protected

_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

Returns

array

_resolveMethodAliases()source protected

_resolveMethodAliases( string $key , array $defaults , array $config )

Removes aliased methods that would otherwise be duplicated by userland configuration.

Parameters

string $key

The key to filter.

array $defaults

The default method mappings.

array $config

The customized method mappings.

Returns

array
A de-duped list of config data.

getTable()source public

getTable( )

Get the table instance this behavior is bound to.

Returns

Cake\ORM\Table
The bound table instance.

implementedEvents()source public

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.

Returns

array

Implementation of

Cake\Event\EventListenerInterface::implementedEvents()

implementedFinders()source public

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

Returns

array

implementedMethods()source public

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

Returns

array

initialize()source public

initialize( array $config )

Constructor hook method.

Implement this method to avoid having to overwrite the constructor and call parent.

Parameters

array $config

The configuration settings provided to this behavior.

verifyConfig()source public

verifyConfig( )

verifyConfig

Checks that implemented keys contain values pointing at callable.

Throws

Cake\Core\Exception\Exception
if config are invalid

_configDelete()source protected

_configDelete( string $key )

Deletes a single config key.

Parameters

string $key

Key to delete.

Throws

Cake\Core\Exception\Exception
if attempting to clobber existing config

_configRead()source protected

_configRead( string|null $key )

Reads a config key.

Parameters

string|null $key

Key to read.

Returns

mixed

_configWrite()source protected

_configWrite( string|array $key , mixed $value , boolean|string $merge false )

Writes a config key.

Parameters

string|array $key

Key to write to.

mixed $value

Value to write.

boolean|string $merge optional false

True to merge recursively, 'shallow' for simple merge, false to overwrite, defaults to false.

Throws

Cake\Core\Exception\Exception
if attempting to clobber existing config

config()source public

config( string|array|null $key null , mixed|null $value null , boolean $merge true )

Gets/Sets the config.

Usage

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']);

Deprecated

3.4.0 use setConfig()/getConfig() instead.

Parameters

string|array|null $key optional null

The key to get/set, or a complete array of configs.

mixed|null $value optional null

The value to set.

boolean $merge optional true

Whether to recursively merge or overwrite existing config, defaults to true.

Returns

mixed
Config value being read, or the object itself on write operations.

Throws

Cake\Core\Exception\Exception
When trying to set a key that is invalid.

configShallow()source public

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->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']);

Parameters

string|array $key

The key to set, or a complete array of configs.

mixed|null $value optional null

The value to set.

Returns

$this

getConfig()source public

getConfig( string|null $key null , mixed $default null )

Returns the config.

Usage

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');

Parameters

string|null $key optional null

The key to get or null for the whole config.

mixed $default optional null

The return value when the key does not exist.

Returns

mixed
Config value being read.

setConfig()source public

setConfig( string|array $key , mixed|null $value null , boolean $merge true )

Sets the config.

Usage

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']);

Parameters

string|array $key

The key to set, or a complete array of configs.

mixed|null $value optional null

The value to set.

boolean $merge optional true

Whether to recursively merge or overwrite existing config, defaults to true.

Returns

$this

Throws

Cake\Core\Exception\Exception
When trying to set a key that is invalid.

[]