Класс Behavior

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

findSlugged(Query $query, array $options)

__constructsource public

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

Конструктор

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

Параметры

Cake\ORM\Table $table

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

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

Настройка для данного поведения.

_reflectionCachesource protected

_reflectionCache( )

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

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

Возвращает

array
массив

_resolveMethodAliasessource protected

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

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

Параметры

строка $key

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

массив $defaults

Настройки по умолчанию для методов.

массив $config

Настроенные сопоставления методов.

Возвращает

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

implementedEventssource public

implementedEvents( )

Получает обратные вызовы модели, которыми интересуется это поведение.

Определив один из методов обратного вызова, предполагается, что поведение заинтересовано в соответствующем событии.

Переопределите этот метод, если вам нужно добавить нестандартные обработчики событий. Или если вы хотите, чтобы ваше поведение отслеживало нестандартные события.

Возвращает

array
массив

Реализация

Cake\Event\EventListenerInterface::implementedEvents()

implementedFinderssource public

implementedFinders( )

implementedFinders

Предоставляет отображение алиас->имя_метода для методов поиска, реализуемых поведением. Пример:

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

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

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

Возвращает

array
массив

implementedMethodssource public

implementedMethods( )

implementedMethods

Предоставляет отображение алиас->имя_метода для методов, реализуемых поведением. Пример:

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

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

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

Возвращает

array
массив

initializesource public

initialize( array $config )

Метод подключения конструктора.

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

Параметры

массив $config

Параметры конфигурации, предоставленные данному поведению.

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

Истинно для рекурсивного слияния, 'поверхностно' для простого слияния, ложно для перезаписи, по умолчанию ложно.

Возбуждает

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

Параметры

string|array|null $key необязательно null

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

mixed|null $value необязательно null

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

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

Выполнять рекурсивное слияние или перезапись существующей конфигурации, по умолчанию 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']);

Параметры

string|array $key

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

mixed|null $value необязательно null

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

Возвращает

mixed
$this Сам объект.

[]

[]

[]

false