CakePHP
  • Documentation
    • Book
    • API
    • Videos
    • Logos & Trademarks
  • Business Solutions
  • Swag
  • Road Trip
  • Team
  • Community
    • Community
    • Team
    • Issues (Github)
    • YouTube Channel
    • Get Involved
    • Bakery
    • Featured Resources
    • Newsletter
    • Certification
    • My CakePHP
    • CakeFest
    • Facebook
    • Twitter
    • Help & Support
    • Forum
    • Stack Overflow
    • IRC
    • Slack
    • Paid Support
CakePHP

C CakePHP 3.1 Red Velvet API

  • Overview
  • Tree
  • Deprecated
  • Version:
    • 3.1
      • 3.8
      • 3.7
      • 3.6
      • 3.5
      • 3.4
      • 3.3
      • 3.2
      • 3.1
      • 3.0
      • 2.10
      • 2.9
      • 2.8
      • 2.7
      • 2.6
      • 2.5
      • 2.4
      • 2.3
      • 2.2
      • 2.1
      • 2.0
      • 1.3
      • 1.2

Namespaces

  • Cake
    • Auth
      • Storage
    • Cache
      • Engine
    • Collection
      • Iterator
    • Console
      • Exception
    • Controller
      • Component
      • Exception
    • Core
      • Configure
        • Engine
      • Exception
    • Database
      • Driver
      • Exception
      • Expression
      • Schema
      • Statement
      • Type
    • Datasource
      • Exception
    • Error
    • Event
    • Filesystem
    • Form
    • I18n
      • Formatter
      • Parser
    • Log
      • Engine
    • Mailer
      • Exception
      • Transport
    • Network
      • Exception
      • Http
        • Adapter
        • Auth
        • FormData
      • Session
    • ORM
      • Association
      • Behavior
        • Translate
      • Exception
      • Locator
      • Rule
    • Routing
      • Exception
      • Filter
      • Route
    • Shell
      • Helper
      • Task
    • TestSuite
      • Fixture
      • Stub
    • Utility
      • Exception
    • Validation
    • View
      • Exception
      • Form
      • Helper
      • Widget
  • None

Classes

  • CounterCacheBehavior
  • TimestampBehavior
  • TranslateBehavior
  • TreeBehavior

Class CounterCacheBehavior

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();
         }
    ]
]
Cake\ORM\Behavior implements Cake\Event\EventListenerInterface uses Cake\Core\InstanceConfigTrait
Extended by Cake\ORM\Behavior\CounterCacheBehavior
Namespace: Cake\ORM\Behavior
Location: ORM/Behavior/CounterCacheBehavior.php

Inherited Properties

  • _defaultConfig, _reflectionCache, _table _config, _configInitialized

Method Summary

  • _getCount() protected
    Fetches and returns the count for a single field in an association
  • _processAssociation() protected
    Updates counter cache for a single association
  • _processAssociations() protected
    Iterate all associations and update counter caches.
  • afterDelete() public
    afterDelete callback.
  • afterSave() public
    afterSave callback.

Method Detail

_getCount() 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() 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() 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() public ¶

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

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.

afterSave() public ¶

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.

Parameters
Cake\Event\Event $event
The afterSave event that was fired.
Cake\Datasource\EntityInterface $entity
The entity that was saved.

Methods inherited from Cake\ORM\Behavior

__construct() 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() 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() 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.

implementedEvents() 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() 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() 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() 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() public ¶

verifyConfig( )

verifyConfig

Checks that implemented keys contain values pointing at callable.

Throws
Cake\Core\Exception\Exception
if config are invalid

Methods used from Cake\Core\InstanceConfigTrait

_configDelete() protected ¶

_configDelete( string $key )

Delete a single config key

Parameters
string $key
Key to delete.
Throws
Cake\Core\Exception\Exception
if attempting to clobber existing config

_configRead() protected ¶

_configRead( string|null $key )

Read a config variable

Parameters
string|null $key
Key to read.
Returns
mixed

_configWrite() protected ¶

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

Write a config variable

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() public ¶

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

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']);
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() 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->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']);
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 The object itself.
Follow @CakePHP
#IRC
OpenHub
Rackspace
  • Business Solutions
  • Showcase
  • Documentation
  • Book
  • API
  • Videos
  • Logos & Trademarks
  • Community
  • Team
  • Issues (Github)
  • YouTube Channel
  • Get Involved
  • Bakery
  • Featured Resources
  • Newsletter
  • Certification
  • My CakePHP
  • CakeFest
  • Facebook
  • Twitter
  • Help & Support
  • Forum
  • Stack Overflow
  • IRC
  • Slack
  • Paid Support

Generated using CakePHP API Docs