Spec-Zone.ru › CakePHP 2.8

Класс AclBehavior

Поведение ACL

Разрешает объектам легко интегрироваться в систему ACL

Объект
Extended by ModelBehavior
Extended by AclBehavior
Пакет: Cake\Модель\Поведение
Ссылка: http://book.cakephp.org/2.0/ru/core-libraries/behaviors/acl.html
Авторские права: Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
Лицензия: MIT Лицензия
Расположение: Cake/Model/Behavior/AclBehavior.php

Краткое описание свойств

  • $_typeMaps protected
    array
    Сопоставление параметров типа ACL с моделями ACL

Унаследованные свойства

  • mapMethods, settings

Краткое описание методов

  • afterDelete() public
    Удаляет узел ARO/ACO, связанный с удаленной записью
  • afterSave() public
    Создает новый узел ARO/ACO, связанный с этой записью
  • node() public
    Получает узел Aro/Aco для этой модели
  • setup() public
    Настраивает конфигурацию для модели и загружает модели ACL, если они еще не загружены

Подробное описание методов

afterDelete()source public

afterDelete( Model $model )

Удаляет узел ARO/ACO, связанный с удаленной записью

Параметры

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

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

ModelBehavior::afterDelete()

afterSave()source public

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

Создает новый узел ARO/ACO, связанный с этой записью

Параметры

Model $model
Модель, использующая это поведение.
boolean $created
True, если это новая запись
array $options optional array()
Параметры, переданные из Model::save().

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

ModelBehavior::afterSave()

node()source public

node( Model $model , string|array|Model $ref null , string $type null )

Возвращает узел Aro/Aco для этой модели

Параметры

Model $model
Модель, использующая это поведение.
string|array|Model $ref optional null
Массив с 'model' и 'foreign_key', объект модели или строковое значение
string $type optional null
Необходимо только при настройке ACL как 'both', укажите 'Aro' или 'Aco', чтобы получить правильный узел

Возвращает

array

Ссылка

http://book.cakephp.org/2.0/ru/core-libraries/behaviors/acl.html#node

setup()source public

setup( Model $model , array $config array() )

Настраивает конфигурацию для модели и загружает модели ACL, если они еще не загружены

Параметры

Model $model
Модель, использующая это поведение.
array $config optional array()
Параметры конфигурации.

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

ModelBehavior::setup()

Наследованные методы из ModelBehavior

_addToWhitelist()source protected

_addToWhitelist( Model $model , string $field )

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

Параметры

Model $model
Модель, использующая это поведение
string $field
Поле, которое нужно добавить в список разрешенных полей $model

afterFind()source public

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

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

Параметры

Model $model
Модель, использующая это поведение
mixed $results
Результаты операции поиска
boolean $primary optional false
Признак того, запрашивается ли эта модель напрямую (или же в качестве ассоциации)

Возвращает

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

afterValidate()source public

afterValidate( Model $model )

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

Параметры

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

Возвращает

mixed
False остановит распространение этого события другим поведениям

beforeDelete()source public

beforeDelete( Model $model , boolean $cascade true )

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

Параметры

Model $model
Модель, использующая это поведение
boolean $cascade optional true
Если true, записи, зависящие от этой записи, также будут удалены

Возвращает

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

beforeFind()source public

beforeFind( Model $model , array $query )

beforeFind может использоваться для отмены операций поиска или изменения запроса, который будет выполнен. Возврат null/false прерывает поиск. Возврат массива изменяет/заменяет запрос, который будет выполнен.

Параметры

Model $model
Модель, использующая это поведение
array $query
Данные, используемые для выполнения этого запроса, т.е. условия, порядок и т.д.

Возвращает

boolean|array

False или null прерывает операцию. Можно вернуть массив для замены $query, который в конечном итоге будет выполнен.


beforeSave()source public

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

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

Параметры

Model $model
Модель, использующая это поведение
array $options optional array()
Параметры, переданные из Model::save().

Возвращает

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

См. также

Model::save()

beforeValidate()source public

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

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

Параметры

Model $model
Модель, использующая это поведение
array $options optional array()
Параметры, переданные из Model::save().

Возвращает

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

См. также

Model::save()
END_OF_DOCUMENT_MARKER

cleanup()source public

cleanup( Model $model )

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

Параметры

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

См. также

BehaviorCollection::detach()

onError()source public

onError( Model $model , string $error )

Обработчик ошибок источника данных

Параметры

Model $model
Модель, использующая это поведение
строка $error
Ошибка, сгенерированная источником данных

Методы, унаследованные от Object

__construct()source public

__construct( )

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

_mergeVars()source protected

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

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

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

Параметры

массив $properties
Имя свойств для объединения.
строка $class
Класс для объединения свойства с.
булево $normalize необязательно true
Установите в значение true, чтобы выполнить свойства через Hash::normalize() перед объединением.

_set()source protected

_set( array $properties array() )

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

Параметры

массив $properties необязательно array()
Ассоциативный массив, содержащий свойства и соответствующие значения.

_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 необязательно array()
Список параметров для использования при вызове $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 необязательно array()

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

Возвращает

mixed

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


toString()source public

toString( )

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

Возвращает

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

Подробное описание свойств

$_typeMapssource

protected массив

Сопоставление опций типа ACL с моделями ACL

array('requester' => 'Aro', 'controlled' => 'Aco', 'both' => array('Aro', 'Aco'))

© 2005–2016 The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
http://api.cakephp.org/2.8/class-AclBehavior.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API