Spec-Zone.ru › CakePHP 2.7

Класс IniAcl

IniAcl реализует систему контроля доступа, используя файл INI. Пример используемого файла INI можно найти в /config/acl.ini.php.

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

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

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

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

Метод без действия, allow не может быть выполнен с IniAcl

Параметры

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

Возвращаемое значение

boolean
Успех

Реализация

AclInterface::allow()

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

arrayTrim( array $array )

Удаляет хвостовые пробелы из всех элементов массива (для подготовки к поиску)

Параметры

массив $array
Массив для обрезки

Возвращаемое значение

array
Отрезанный массив

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

check( string $aro , string $aco , string $action null )

Основная функция проверки ACL. Проверяет, имеет ли ARO (объект запроса доступа) доступ к ACO (объекту управления доступом). Ищет разрешения в файле acl.ini.php (см. инструкции в /config/acl.ini.php).

Параметры

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

Возвращаемое значение

boolean
Успех

Реализация

AclInterface::check()

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

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

Метод без действия, deny не может быть выполнен с IniAcl

Параметры

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

Возвращаемое значение

boolean
Успех

Реализация

AclInterface::deny()

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

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

Метод без действия, inherit не может быть выполнен с IniAcl

Параметры

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

Возвращаемое значение

boolean
Успех

Реализация

AclInterface::inherit()

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

initialize( Component $component )

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

Параметры

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

Реализация

AclInterface::initialize()

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

readConfigFile( string $filename )

Парсит файл INI и возвращает массив, отражающий структуру разделов файла INI. Поддержка двойных кавычек.

Параметры

строка $filename
Файл

Возвращаемое значение

array
Структура разделов INI

Методы, унаследованные от Объект

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

__construct( )

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

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

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

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

Это обеспечивает некоторую DRY-магию 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
Успех записи в журнал
END_OF_DOCUMENT_MARKER

requestActionsource 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'.

toStringsource public

toString( )

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

Возвращает

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

Резюме свойств

$configsource

public массив

Массив с конфигурацией, разобранной из файла ini

null

$userPathsource

public строка

Путь Hash::extract() к идентификатору пользователя/aro в файле acl.ini. Этот путь будет использоваться для извлечения строкового представления пользователя, используемого в файле ini.

'User.username'

© 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-IniAcl.html

Spec-Zone.ru

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