Класс IniAcl
IniAcl реализует систему управления доступом, используя файл INI. Пример используемого файла INI можно найти в /config/acl.ini.php.
- CakeObject
-
IniAcl реализует AclInterface
Авторские права: Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
Лицензия: MIT License
Расположение: Cake/Controller/Component/Acl/IniAcl.php
Краткое описание свойств
-
$configpublicМассив с конфигурацией, полученной из файла iniarray -
$userPathpublicstringПуть Hash::extract() для идентификатора пользователя/ARO в файле acl.ini. Этот путь будет использован для извлечения строкового представления пользователя, используемого в файле ini.
Краткое описание методов
- allow() publicМетод без действия, allow не может быть выполнен с IniAcl
- arrayTrim() publicУдаляет пробелы в конце всех элементов массива (для подготовки к поиску)
- 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 )
Удаляет пробелы в конце всех элементов массива (для подготовки к поиску)
Параметры
- 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 - Экземпляр AclComponent.
Реализация
AclInterface::initialize() readConfigFile()source public
readConfigFile( string $filename )
Парсит файл INI и возвращает массив, отражающий структуру разделов файла INI. Поддержка двойных кавычек.
Параметры
- string
$filename - Файл
Возвращает
arrayСтруктура раздела INI
Методы унаследованные от CakeObject
_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Возвращает результат вызова метода
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 и именованных/переданных аргументов.
Возвращаемое значение
смешанноеБулево значение true или false при успехе/неудаче, или содержимое отрисованного действия, если в $extra установлен ключ 'return'.
toString()source public
toString( )
Преобразование CakeObject в строку. Каждый класс может переопределить этот метод по мере необходимости.
Возвращаемое значение
строкаИмя этого класса
Подробности свойств
$userPathsource
public строка
Путь Hash::extract() для идентификатора пользователя/aro в файле acl.ini. Этот путь будет использоваться для извлечения строкового представления пользователя, используемого в файле ini.
'User.username'
© 2005–2017 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.10/class-IniAcl.html