Spec-Zone.ru › CakePHP 2.7

Класс PhpAcl

PhpAcl реализует систему управления доступом, используя обычный конфигурационный файл PHP. Пример файла можно найти в app/Config/acl.php

Объект
Extended by PhpAcl реализует AclInterface
Пакет: Cake\Контроллер\Компонент\Acl
Авторские права: Авторские права (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
Лицензия: MIT Лицензия
Расположение: Cake/Controller/Component/Acl/PhpAcl.php

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

__constructисходный код public

__construct( )

Конструктор

Устанавливает несколько значений по умолчанию.

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

Object::__construct()

allowисходный код public

allow( string $aro , string $aco , string $action "*" )

Метод без действия, разрешение недоступно с PhpAcl

Параметры

строка $aro
ARO Идентификатор запрашивающего объекта.
строка $aco
ACO Идентификатор контролируемого объекта.
строка $action необязательно "*"
Действие (по умолчанию *)

Возвращает

boolean
Успех

Реализация

AclInterface::allow()

buildисходный код public

build( array $config )

Создаёт и настраивает внутреннее представление ACL

Параметры

массив $config
конфигурационный массив, см. документацию

Исключения

AclException
Когда отсутствуют необходимые ключи.

checkисходный код public

check( string $aro , string $aco , string $action "*" )

Основная функция проверки ACL. Проверяет, имеет ли ARO (объект запроса доступа) доступ к ACO (объекту управления доступом).

Параметры

строка $aro
ARO
строка $aco
ACO
строка $action необязательно "*"
Действие

Возвращает

boolean
true, если доступ предоставлен, иначе false

Реализация

AclInterface::check()

denyисходный код public

deny( string $aro , string $aco , string $action "*" )

Запрещает ARO доступ к ACO

Параметры

строка $aro
ARO Идентификатор запрашивающего объекта.
строка $aco
ACO Идентификатор контролируемого объекта.
строка $action необязательно "*"
Действие (по умолчанию *)

Возвращает

boolean
Успех

Реализация

AclInterface::deny()

inheritисходный код public

inherit( string $aro , string $aco , string $action "*" )

Метод без действия

Параметры

строка $aro
ARO Идентификатор запрашивающего объекта.
строка $aco
ACO Идентификатор контролируемого объекта.
строка $action необязательно "*"
Действие (по умолчанию *)

Возвращает

boolean
Успех

Реализация

AclInterface::inherit()

initializeисходный код public

initialize( Component $Component )

Метод инициализации

Параметры

Component $Component
Экземпляр компонента

Реализация

AclInterface::initialize()

Наследованные методы из Объекта

_mergeVarsисходный код protected

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

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

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

Параметры

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

_setисходный код protected

_set( array $properties array() )

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

Параметры

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

_stopисходный код protected

_stop( integer|string $status 0 )

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

Параметры

целое число|строка $status необязательно 0
см. http://php.net/exit для значений

dispatchMethodисходный код public

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

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

Параметры

строка $method
Имя вызываемого метода
массив $params необязательно array()
Список параметров для использования при вызове $method

Возвращает

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

logисходный код 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исходный код 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 при успехе/неудаче, или содержимое рендерного действия, если в $extra установлен ключ 'return'.

toStringисходный код public

toString( )

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

Возвращает

string
Название данного класса

Резюме констант

boolean ALLOW

Константа для разрешения

true
boolean DENY

Константа для запрещения

false

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

$Acosource

public PhpAco

Объект Aco

null

$Arosource

public PhpAro

Объект Aro

null

$optionssource

public массив

Параметры: - policy: определяет поведение метода check. Политика Deny требует явных правил allow, политика allow требует явных правил deny - config: абсолютный путь к файлу конфигурации, содержащему правила acl (@see app/Config/acl.php)

array()

© 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.7/class-PhpAcl.html

Spec-Zone.ru

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