Класс PhpAro

Объект запроса доступа

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

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

string

DEFAULT_ROLE

'Role/default'

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

$_tree protected

array
внутреннее представление ARO
$aliases public

array
псевдонимы для сопоставления
$map public

array
отображение внешних идентификаторов. Например, если

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

__construct() public
Конструктор
addAlias() public
добавляет один или несколько псевдонимов во внутреннюю карту. Перезаписывает существующие записи.
addRole() public
добавляет новую ARO в дерево
build() public
построение структуры дерева ARO для внутренней обработки
resolve() public

преобразование идентификатора ARO во внутреннюю строку ARO с использованием внутренней информации о сопоставлении.
roles() public

С точки зрения заданной ARO, перейдите вниз по дереву и соберите все наследуемые ARO уровнем, так что ARO из разных ветвей с одинаковым расстоянием до запрошенной ARO будут собраны в одном и том же индексе. Результирующий массив будет содержать упорядоченный по приоритету список (списков) ролей, от самых удалённых ARO до самой запрошенной.

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

__construct()source public

__construct( array $aro array() , array $map array() , array $aliases array() )

Конструктор

Параметры

массив $aro необязательно array(): данные ARO
массив $map необязательно array(): отображение идентификаторов
массив $aliases необязательно array(): псевдонимы для сопоставления.

addAlias()source public

addAlias( array $alias )

добавляет один или несколько псевдонимов во внутреннюю карту. Перезаписывает существующие записи.

Параметры

массив $alias: псевдоним из => в (например, Role/13 -> Role/editor)

addRole()source public

addRole( array $aro )

добавляет новую ARO в дерево

Параметры

массив $aro: один или несколько записей ARO

build()source public

build( array $aros )

построение структуры дерева ARO для внутренней обработки

Параметры

массив $aros: массив ARO в качестве ключа и их наследуемых ARO в качестве значений

resolve()source public

resolve( string|array $aro )

преобразование идентификатора ARO во внутреннюю строку ARO с использованием внутренней информации о сопоставлении.

Параметры

строка|массив $aro: идентификатор ARO (User.jeff, массив('User' => ...), и т.д.)

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

строка
внутренняя строка ARO (например, User/jeff, Role/default)

roles()source public

roles( string|array $aro )

С точки зрения заданной ARO, перейдите вниз по дереву и соберите все наследуемые ARO уровнем, так что ARO из разных ветвей с одинаковым расстоянием до запрошенной ARO будут собраны в одном и том же индексе. Результирующий массив будет содержать упорядоченный по приоритету список (списков) ролей, от самых удалённых ARO до самой запрошенной.

Параметры

строка|массив $aro: идентификатор ARO

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

массив
упорядоченные ARO

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

$_treesource

protected массив

внутреннее представление ARO

array()

$aliasessource

public массив

псевдонимы для сопоставления

array()

$mapsource

public массив

отображение внешних идентификаторов. Например, если

массив('User' => массив('username' => 'jeff', 'role' => 'editor'))

передан как ARO в один из методов компонента Acl, PhpAcl проверит, можно ли его преобразовать в User или Role, определённые в файле конфигурации.

См. также

app/Config/acl.php

array(
    'User' => 'User/username',
    'Role' => 'User/role',
)

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