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.6 Red Velvet API

  • Overview
  • Tree
  • Deprecated
  • Version:
    • 3.6
      • 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
    • Command
    • Console
      • Exception
    • Controller
      • Component
      • Exception
    • Core
      • Configure
        • Engine
      • Exception
      • Retry
    • Database
      • Driver
      • Exception
      • Expression
      • Schema
      • Statement
      • Type
    • Datasource
      • Exception
    • Error
      • Middleware
    • Event
      • Decorator
    • Filesystem
    • Form
    • Http
      • Client
        • Adapter
        • Auth
      • Cookie
      • Exception
      • Middleware
      • Session
    • I18n
      • Formatter
      • Middleware
      • Parser
    • Log
      • Engine
    • Mailer
      • Exception
      • Transport
    • Network
      • Exception
    • ORM
      • Association
      • Behavior
        • Translate
      • Exception
      • Locator
      • Rule
    • Routing
      • Exception
      • Filter
      • Middleware
      • Route
    • Shell
      • Helper
      • Task
    • TestSuite
      • Constraint
      • Fixture
      • Stub
    • Utility
      • Exception
    • Validation
    • View
      • Exception
      • Form
      • Helper
      • Widget
  • None

Classes

  • CounterCacheBehavior
  • TimestampBehavior
  • TranslateBehavior
  • TreeBehavior

Class TimestampBehavior

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.

Mixin methods

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

Callback methods

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(Event $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 or not this is the root query, or an associated query.

  • buildValidator(Event $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(Event $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(Event $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(Event $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(Event $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(Event $event, EntityInterface $entity, ArrayObject $options) Fired after an entity is saved.

  • beforeDelete(Event $event, EntityInterface $entity, ArrayObject $options) Fired before an entity is deleted. By stopping this event you will abort the delete operation.

  • afterDelete(Event $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.

Finder methods

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)
Cake\ORM\Behavior implements Cake\Event\EventListenerInterface uses Cake\Core\InstanceConfigTrait
Extended by Cake\ORM\Behavior\TimestampBehavior
Namespace: Cake\ORM\Behavior
See: \Cake\ORM\Table::addBehavior()
See: Cake\Event\EventManager
Mixin: \Cake\Core\InstanceConfigTrait
Location: ORM/Behavior/TimestampBehavior.php

Properties summary

  • $_defaultConfig protected
    array
    Default config
  • $_ts protected
    DateTime
    Current timestamp

Inherited Properties

  • _reflectionCache, _table _config, _configInitialized

Method Summary

  • _updateField() protected
    Update a field, if it hasn't been updated already
  • handleEvent() public
    There is only one event handler, it can be configured to be called for any event
  • implementedEvents() public
    implementedEvents
  • initialize() public
    Initialize hook
  • timestamp() public
    Get or set the timestamp to be used
  • touch() public
    Touch an entity

Method Detail

_updateField() protected ¶

_updateField( Cake\Datasource\EntityInterface $entity , string $field , boolean $refreshTimestamp )

Update a field, if it hasn't been updated already

Parameters
Cake\Datasource\EntityInterface $entity
Entity instance.
string $field
Field name
boolean $refreshTimestamp
Whether to refresh timestamp.

handleEvent() public ¶

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

There is only one event handler, it can be configured to be called for any event

Parameters
Cake\Event\Event $event
Event instance.
Cake\Datasource\EntityInterface $entity
Entity instance.
Returns
boolean
Returns true irrespective of the behavior logic, the save will not be prevented.
Throws
UnexpectedValueException
if a field's when value is misdefined
UnexpectedValueException
When the value for an event is not 'always', 'new' or 'existing'

implementedEvents() public ¶

implementedEvents( )

implementedEvents

The implemented events of this behavior depend on configuration

Returns
array
Overrides
Cake\ORM\Behavior::implementedEvents()

initialize() public ¶

initialize( array $config )

Initialize hook

If events are specified - do not merge them with existing events, overwrite the events to listen on

Parameters
array $config
The config for this behavior.
Overrides
Cake\ORM\Behavior::initialize()

timestamp() public ¶

timestamp( DateTime $ts null , boolean $refreshTimestamp false )

Get or set the timestamp to be used

Set the timestamp to the given DateTime object, or if not passed a new DateTime object If an explicit date time is passed, the config option refreshTimestamp is automatically set to false.

Parameters
DateTime $ts optional null
Timestamp
boolean $refreshTimestamp optional false
If true timestamp is refreshed.
Returns
DateTime

touch() public ¶

touch( Cake\Datasource\EntityInterface $entity , string $eventName 'Model.beforeSave' )

Touch an entity

Bumps timestamp fields for an entity. For any fields configured to be updated "always" or "existing", update the timestamp value. This method will overwrite any pre-existing value.

Parameters
Cake\Datasource\EntityInterface $entity
Entity instance.
string $eventName optional 'Model.beforeSave'
Event name.
Returns
boolean
true if a field is updated, false if no action performed

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.

getTable() public ¶

getTable( )

Get the table instance this behavior is bound to.

Returns
Cake\ORM\Table
The bound table instance.

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

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 )

Deletes 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 )

Reads a config key.

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

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

Properties detail

$_defaultConfig ¶

protected array

Default config

These are merged with user-provided config when the behavior is used.

events - an event-name keyed array of which fields to update, and when, for a given event possible values for when a field will be updated are "always", "new" or "existing", to set the field value always, only when a new record or only when an existing record.

refreshTimestamp - if true (the default) the timestamp used will be the current time when the code is executed, to set to an explicit date time value - set refreshTimetamp to false and call setTimestamp() on the behavior class before use.

[
    'implementedFinders' => [],
    'implementedMethods' => [
        'timestamp' => 'timestamp',
        'touch' => 'touch'
    ],
    'events' => [
        'Model.beforeSave' => [
            'created' => 'new',
            'modified' => 'always'
        ]
    ],
    'refreshTimestamp' => true
]

$_ts ¶

protected DateTime

Current timestamp

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