Класс ContainableBehavior

beforeFind()source public

beforeFind( Model $Model , array $query )

Вызывается перед операцией find(). Используется для разрешения установки 'contain' как части вызова find, например:

Model->find('all', array('contain' => array('Model1', 'Model2')));

Model->find('all', array('contain' => array(
    'Model1' => array('Model11', 'Model12'),
    'Model2',
    'Model3' => array(
        'Model31' => 'Model311',
        'Model32',
        'Model33' => array('Model331', 'Model332')
)));

Параметры

Model $Model

Модель, использующая поведение

массив $query

Параметры запроса, заданные Cake

Возвращает

массив

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

ModelBehavior::beforeFind()

contain()source public

contain( Model $Model )

Отключает все отношения от модели, за исключением указанных. Вызов этой функции без параметров отключает все связанные модели.

Параметры

Model $Model

Модель, к которой применяется ограничение привязки

Ссылка

http://book.cakephp.org/2.0/ru/core-libraries/behaviors/containable.html#using-containable

containments()source public

containments( Model $Model , array $contain , array $containments array() , boolean $throwErrors null )

Обработка содержаний для модели.

Параметры

Model $Model

Модель, к которой применяется ограничение привязки

массив $contain

Параметры для ограничения этой модели

массив $containments необязательно массив()

Текущий набор содержаний

булево $throwErrors необязательно null

Показывать ли ошибки для несуществующих связей

Возвращает

массив
Содержимое

containmentsMap()source public

containmentsMap( array $containments )

Построение карты содержаний

Параметры

массив $containments

Содержимое

Возвращает

массив
Сгенерированное содержимое

fieldDependencies()source public

fieldDependencies( Model $Model , array $map , array|boolean $fields array() )

Вычисление необходимых полей для извлечения требуемых связей для данной модели.

Параметры

Model $Model

Модель

массив $map

Карта отношений для данной модели

массив/булево $fields необязательно массив()

Если массив, поля для начальной загрузки, если false, использовать $Model в качестве основной модели

Возвращает

массив
Поля

resetBindings()source public

resetBindings( Model $Model )

Постоянно восстанавливает исходные настройки привязки данной модели, полезно для восстановления привязок после использования 'reset' => false в рамках вызова contain.

Параметры

Model $Model

Модель, для которой необходимо сбросить привязки

setup()source public

setup( Model $Model , array $settings array() )

Инициализация поведения для модели с использованием указанных настроек.

Доступные настройки:

• recursive: (булево, необязательно) установите в значение true, чтобы позволить containable автоматически определить уровень рекурсии, необходимый для извлечения указанных моделей, и установить рекурсию модели на этот уровень. Установка в значение false отключает эту функцию. ПО УМОЛЧАНИЮ: true
• notices: (булево, необязательно) выводит сообщения об ошибках для привязок, на которые ссылается вызов containable, которые не являются допустимыми. ПО УМОЛЧАНИЮ: true
• autoFields: (булево, необязательно) автоматически добавляет необходимые поля для извлечения запрошенных привязок. ПО УМОЛЧАНИЮ: true

Параметры

Model $Model

Модель, использующая поведение

массив $settings необязательно массив()

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

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

ModelBehavior::setup()

_addToWhitelist()source protected

_addToWhitelist( Model $model , string $field )

Если свойство whitelist модели $model не пустое, $field будет добавлен в него. Примечание: этот метод следует использовать только в beforeValidate или beforeSave для обеспечения того, что он изменяет список разрешенных полей только для текущей операции сохранения. Также убедитесь, что вы явно задаете значение поля, которое вы разрешаете.

Параметры

Model $model

Модель, использующая это поведение

строка $field

Поле, которое нужно добавить в список разрешенных полей модели $model

afterDelete()source public

afterDelete( Model $model )

afterDelete вызывается после любой операции удаления прикрепленной модели.

Параметры

Model $model

Модель, использующая это поведение

afterFind()source public

afterFind( Model $model , mixed $results , boolean $primary false )

Обработчик after find. Может быть использован для изменения любых результатов, возвращаемых find.

Параметры

Model $model

Модель, использующая это поведение

смешанное $results

Результаты операции find

булево $primary необязательно false

Признак того, запрашивается ли эта модель напрямую (а не как ассоциация)

Возвращает

смешанное
Значение массива заменит значение $results - любые другие значения будут проигнорированы.

afterSave()source public

afterSave( Model $model , boolean $created , array $options array() )

Метод afterSave вызывается после сохранения модели.

Параметры

Model $model

Модель, использующая данный механизм

boolean $created

Истинно, если это сохранение создало новый запис

массив $options дополнительно массив()

Опции, переданные из Model::save().

Возвращает

boolean

См. также

Model::save()

afterValidate()source public

afterValidate( Model $model )

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

Параметры

Model $model

Модель, использующая данный механизм

Возвращает

mixed
False прекратит передачу события другим механизмам

beforeDelete()source public

beforeDelete( Model $model , boolean $cascade true )

beforeDelete вызывается перед любым удалением прикрепленной модели, но после вызова beforeDelete модели. Возврат false из beforeDelete прервёт удаление.

Параметры

Model $model

Модель, использующая данный механизм

boolean $cascade дополнительно true

Если true, записи, зависящие от этой записи, также будут удалены

Возвращает

mixed
False, если операция должна быть прервана. Любой другой результат будет продолжен.

beforeSave()source public

beforeSave( Model $model , array $options array() )

beforeSave вызывается перед сохранением модели. Возврат false из beforeSave прервёт операцию сохранения.

Параметры

Model $model

Модель, использующая данный механизм

массив $options дополнительно массив()

Опции, переданные из Model::save().

Возвращает

mixed
False, если операция должна быть прервана. Любой другой результат будет продолжен.

См. также

Model::save()

beforeValidate()source public

beforeValidate( Model $model , array $options array() )

beforeValidate вызывается перед валидацией модели. Можно использовать этот обработчик для добавления правил валидации поведения в массив validate модели. Возврат false позволит сделать валидацию неудачной.

Параметры

Model $model

Модель, использующая данный механизм

массив $options дополнительно массив()

Опции, переданные из Model::save().

Возвращает

mixed
False или null прервут операцию. Любой другой результат будет продолжен.

См. также

Model::save()

cleanup()source public

cleanup( Model $model )

Очистка любой инициализации, выполненной этим поведением в модели. Вызывается при динамическом отсоединении поведения от модели с помощью Model::detach().

Параметры

Model $model

Модель, использующая данный механизм

См. также

BehaviorCollection::detach()

onError()source public

onError( Model $model , string $error )

Обработчик ошибок DataSource

Параметры

Model $model

Модель, использующая данный механизм

строка $error

Ошибка, сгенерированная в DataSource

__construct()source public

__construct( )

Конструктор, без действия

_mergeVars()source protected

_mergeVars( array $properties , string $class , boolean $normalize true )

Объединяет свойства $property этого объекта со свойствами в определении $class. Значение свойства этого класса будет объединено поверх значения $class.

Это обеспечивает часть "магии" DRY в CakePHP. Если вы хотите отключить это, переопределите этот метод как пустую функцию.

Параметры

массив $properties

Имя свойств для объединения.

строка $class

Класс для объединения свойства с.

boolean $normalize дополнительно true

Установите значение true, чтобы запустить свойства через Hash::normalize() перед объединением.

_set()source protected

_set( array $properties array() )

Позволяет установить несколько свойств объекта в одной строке кода. Будут установлены только свойства, которые являются частью объявления класса.

Параметры

массив $properties дополнительно массив()

Ассоциативный массив, содержащий свойства и соответствующие значения.

_stop()source protected

_stop( integer|string $status 0 )

Остановка выполнения текущего скрипта. Оборачивает exit(), что упрощает тестирование.

Параметры

целое число/строка $status дополнительно 0

см. http://php.net/exit для значений

dispatchMethod()source public

dispatchMethod( string $method , array $params array() )

Вызывает метод этого объекта с заданными параметрами. Предоставляет объектно-ориентированный обертку для call_user_func_array

Параметры

строка $method

Имя метода для вызова

массив $params дополнительно массив()

Список параметров для использования при вызове $method

Возвращает

mixed
Возвращает результат вызова метода

log()source public

log( string $msg , integer $type LOG_ERR , null|string|array $scope null )

Удобный метод для записи сообщения в CakeLog. Для получения более подробной информации о записи в журналы см. CakeLog::write().

Параметры

строка $msg

Сообщение журнала

целое число $type дополнительно LOG_ERR

Константа типа ошибки. Определена в app/Config/core.php.

null|строка|массив $scope дополнительно null

Области, в которых создается сообщение журнала. См. CakeLog::config() для получения дополнительной информации о областях ведения журнала.

Возвращает

boolean
Успех записи в журнал

requestAction()source public

requestAction( string|array $url , array $extra array() )

Вызывает метод контроллера из любого места. Может использоваться для подключения контроллеров друг к другу или для интеграции плагинов в основное приложение. requestAction может использоваться для возврата рендеренных представлений или получения возвращаемого значения из действий контроллера.

Под капотом этот метод использует Router::reverse() для преобразования параметра $url в строку URL. Используйте форматы URL, совместимые с Router::reverse().

Передача данных POST и GET

Данные POST и GET могут быть смоделированы в requestAction. Используйте $extra['url'] для данных GET. Параметр $extra['data'] позволяет моделировать данные POST.

Параметры

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

Строка или массив URL. В отличие от других массивов URL в CakePHP, этот URL не будет автоматически обрабатывать передаваемые и именованные аргументы в параметре $url.

массив $extra дополнительно массив()

Если массив включает ключ "return", он устанавливает AutoRender в true. Также может использоваться для отправки данных GET/POST и именованных/передаваемых аргументов.

Возвращает

mixed

Булево значение true или false об успехе/неудачи, или содержимое рендерного действия, если в $extra задан ключ "return".

toString()source public

toString( )

Преобразование объекта в строку. Каждый класс может переопределить этот метод по мере необходимости.

Возвращает

строка
Имя этого класса

array()

array('belongsTo', 'hasOne', 'hasMany', 'hasAndBelongsToMany')