Spec-Zone.ru › CakePHP 2.9

Класс IniAcl

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

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

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

  • $config public
    array
    Массив с конфигурацией, разобранной из файла ini
  • $userPath public
    string

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

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

  • allow() public
    Метод без действия, allow не может быть выполнен с IniAcl
  • arrayTrim() public
    Удаляет trailing пробелы из всех элементов массива (для подготовки к поиску)
  • check() public

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

  • deny() public
    Метод без действия, deny не может быть выполнен с IniAcl
  • inherit() public
    Метод без действия, inherit не может быть выполнен с IniAcl
  • initialize() public
    Метод инициализации
  • readConfigFile() public

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

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

allow()source public

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

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

Параметры

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

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

boolean
Успех

Реализация

AclInterface::allow()

arrayTrim()source public

arrayTrim( array $array )

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

Параметры

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

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

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

check()source public

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

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

Параметры

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

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

boolean
Успех

Реализация

AclInterface::check()

deny()source public

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

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

Параметры

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

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

boolean
Успех

Реализация

AclInterface::deny()

inherit()source public

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

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

Параметры

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

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

boolean
Успех

Реализация

AclInterface::inherit()

initialize()source public

initialize( Component $component )

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

Параметры

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

Реализация

AclInterface::initialize()

readConfigFile()source public

readConfigFile( string $filename )

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

Параметры

string $filename
Файл

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

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

Наследуемые методы из CakeObject

__construct()source public

__construct( )

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

_mergeVars()source protected

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

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

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

Параметры

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

_set()source protected

_set( array $properties array() )

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

Параметры

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

_stop()source protected

_stop( integer|string $status 0 )

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

Параметры

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

dispatchMethod()source public

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

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

Параметры

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

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

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

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. Для данных GET используйте $extra['url']. Параметр $extra['data'] позволяет моделировать данные POST.

Параметры

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

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

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

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

Возвращает

mixed

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


toString()source public

toString( )

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

Возвращает

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

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

$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.
https://api.cakephp.org/2.9/class-IniAcl.html

Spec-Zone.ru

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