Класс TimestampBehavior

function doSomething($arg1, $arg2) {
  // do something
}

findSlugged(Query $query, array $options)

_updateFieldисходный код защищенный

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

Обновить поле, если оно еще не было обновлено

Параметры

Cake\Datasource\EntityInterface $entity

Экземпляр сущности.

строка $field

Имя поля

логический $refreshTimestamp

Обновить метку времени.

handleEventисходный код публичный

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

Существует только один обработчик событий, он может быть настроен для вызова для любого события

Параметры

Cake\Event\Event $event

Экземпляр события.

Cake\Datasource\EntityInterface $entity

Экземпляр сущности.

Возвращает

true
(независимо от логики поведения, сохранение не будет предотвращено)

Вызывает

UnexpectedValueException
если значение поля when определено неправильно
UnexpectedValueException
Когда значение для события не равно 'всегда', 'новый' или 'существующий'

implementedEventsисходный код публичный

implementedEvents( )

implementedEvents

Реализованные события этого поведения зависят от конфигурации

Возвращает

array
массив

Переопределяет

Cake\ORM\Behavior::implementedEvents()

initializeисходный код публичный

initialize( array $config )

Обработчик инициализации

Если события указаны — не объединяйте их с существующими событиями, перезаписывайте события для прослушивания

Параметры

массив $config

Конфигурация для данного поведения.

Переопределяет

Cake\ORM\Behavior::initialize()

timestampисходный код публичный

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

Получить или установить используемую метку времени

Установите метку времени на заданный объект DateTime или, если он не передан, новый объект DateTime. Если явно передается объект DateTime, опция конфигурации refreshTimestamp автоматически устанавливается в значение false.

Параметры

DateTime $ts необязательно null

Метка времени

логический $refreshTimestamp необязательно false

Если true, метка времени обновляется.

Возвращает

Cake\I18n\Time
\Cake\I18n\Time

touchисходный код публичный

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

Обновить метку времени для сущности

Обновляет поля метки времени для сущности. Для любых полей, настроенных на обновление «всегда» или «существующий», обновляется значение метки времени. Этот метод перезапишет любое существующее значение.

Параметры

Cake\Datasource\EntityInterface $entity

Экземпляр сущности.

строка $eventName необязательно 'Model.beforeSave'

Имя события.

Возвращает

boolean
true, если поле обновлено, false, если действие не выполнено

__constructисходный код публичный

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

Конструктор

Объединяет конфигурацию со значениями по умолчанию и сохраняет в свойстве конфигурации

Параметры

Cake\ORM\Table $table

Таблица, к которой прикреплено данное поведение.

массив $config необязательно []

Конфигурация для данного поведения.

_reflectionCacheисходный код защищенный

_reflectionCache( )

Получает методы, реализованные данным поведением

Использует метод implementedEvents() для исключения методов обратных вызовов. Методы, начинающиеся с _, будут игнорироваться, как и методы, объявленные в Cake\ORM\Behavior

Возвращает

array
массив

_resolveMethodAliasesисходный код защищенный

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

Удаляет алиасированные методы, которые в противном случае были бы дублированы пользовательской конфигурацией.

Параметры

строка $key

Ключ для фильтрации.

массив $defaults

Стандартные отображения методов.

массив $config

Настраиваемые отображения методов.

Возвращает

array
Список конфигурационных данных без дублирования.

implementedFindersисходный код публичный

implementedFinders( )

implementedFinders

Предоставляет карту «алиас» - «имя метода» реализованных методов поиска поведением. Пример:

[
  'this' => 'findThis',
  'alias' => 'findMethodName'
]

Приведенном примере вызов $Table->find('this') вызовет $Behavior->findThis(), а вызов $Table->find('alias') вызовет $Behavior->findMethodName()

Рекомендуется, хотя и не обязательно, определять implementedFinders в свойстве конфигурации дочерних классов, чтобы не было необходимости использовать отражения для получения списка доступных методов. Примеры см. в базовых классах.

Возвращает

array
массив

implementedMethodssource public

implementedMethods( )

implementedMethods

Предоставляет отображение «псевдоним»-«имя метода» реализованных методом поведения. Пример:

[
  'method' => 'method',
  'aliasedmethod' => 'somethingElse'
]

В приведенном примере вызов $Table->method() вызовет $Behavior->method() , а вызов $Table->aliasedmethod() вызовет $Behavior->somethingElse()

Рекомендуется (но не обязательно) определять implementedFinders в свойстве config дочерних классов, чтобы не было необходимости использовать рефлексию для получения списка доступных методов. См. примеры в базовых поведенческих классах.

Возвращает

array
массив

verifyConfigsource public

verifyConfig( )

verifyConfig

Проверяет, что реализованные ключи содержат значения, указывающие на вызываемые объекты.

Выбрасывает

Cake\Core\Exception\Exception
если конфигурация неверна

_configDeletesource protected

_configDelete( string $key )

Удаление отдельного ключа конфигурации

Параметры

строка $key

Ключ для удаления.

Выбрасывает

Cake\Core\Exception\Exception
если происходит попытка перезаписи существующей конфигурации

_configReadsource protected

_configRead( string|null $key )

Чтение переменной конфигурации

Параметры

строка|null $key

Ключ для чтения.

Возвращает

mixed
смешанный тип

_configWritesource protected

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

Запись переменной конфигурации

Параметры

строка|массив $key

Ключ для записи.

смешанный тип $value

Значение для записи.

булево|строка $merge необязательно false

Истина для рекурсивного слияния, «shallow» для простого слияния, ложь для перезаписи, по умолчанию — ложь.

Выбрасывает

Cake\Core\Exception\Exception
если происходит попытка перезаписи существующей конфигурации

configsource public

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

Использование

Чтение всей конфигурации:

$this->config();

Чтение определенного значения:

$this->config('key');

Чтение вложенного значения:

$this->config('some.nested.key');

Установка определенного значения:

$this->config('key', $value);

Установка вложенного значения:

$this->config('some.nested.key', $value);

Обновление нескольких настроек конфигурации одновременно:

$this->config(['one' => 'value', 'another' => 'value']);

Параметры

строка|массив|null $key необязательно null

Ключ для получения/установки или полный массив конфигураций.

смешанный тип|null $value необязательно null

Значение для установки.

булево $merge необязательно true

Требуется ли рекурсивное слияние или перезапись существующей конфигурации, по умолчанию — истина.

Возвращает

mixed
Значение конфигурации, которое читается, или сам объект при операциях записи.

Выбрасывает

Cake\Core\Exception\Exception
При попытке установить недопустимый ключ.

configShallowsource public

configShallow( string|array $key , mixed|null $value null )

Объединяет предоставленную конфигурацию с существующей конфигурацией. В отличие от config() , которая выполняет рекурсивное слияние для вложенных ключей, этот метод выполняет простое слияние.

Установка определенного значения:

$this->config('key', $value);

Установка вложенного значения:

$this->config('some.nested.key', $value);

Обновление нескольких настроек конфигурации одновременно:

$this->config(['one' => 'value', 'another' => 'value']);

Параметры

строка|массив $key

Ключ для установки или полный массив конфигураций.

смешанный тип|null $value необязательно null

Значение для установки.

Возвращает

mixed
Сам объект.

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

[]

[]

false