Spec-Zone.ru › Yii 1.1

CAuthItem

Пакет system.web.auth
Наследование class CAuthItem » CComponent
С 1.0
Исходный код framework/web/auth/CAuthItem.php
CAuthItem представляет элемент авторизации. Элемент авторизации может быть операцией, задачей или ролью. Они образуют иерархию авторизации. Элементы на более высоких уровнях иерархии наследуют разрешения, представленные элементами на более низких уровнях. Пользователь может получить один или несколько элементов авторизации (называемых назначаемыми). Он может выполнить операцию только тогда, когда она находится среди его назначенных элементов.

Свойства публичные

Свойство Тип Описание Определено
authManager IAuthManager менеджер авторизации CAuthItem
bizRule строка правило бизнеса, связанное с этим элементом CAuthItem
children массив Возвращает дочерние элементы данного элемента. CAuthItem
data смешанный тип дополнительные данные, связанные с этим элементом CAuthItem
description строка описание элемента CAuthItem
name строка имя элемента CAuthItem
type целое число тип элемента авторизации. CAuthItem

Методы публичные

Метод Описание Определено
__call() Вызывает метод с заданным именем, который не является методом класса. CComponent
__construct() Конструктор. CAuthItem
__get() Возвращает значение свойства, список обработчиков событий или поведение на основе его имени. CComponent
__isset() Проверяет, является ли значение свойства нулевым. CComponent
__set() Устанавливает значение свойства компонента. CComponent
__unset() Устанавливает свойство компонента в значение null. CComponent
addChild() Добавляет дочерний элемент. CAuthItem
asa() Возвращает объект поведения с заданным именем. CComponent
assign() Назначает этот элемент пользователю. CAuthItem
attachBehavior() Присоединяет поведение к этому компоненту. CComponent
attachBehaviors() Присоединяет список поведений к компоненту. CComponent
attachEventHandler() Присоединяет обработчик событий к событию. CComponent
canGetProperty() Определяет, может ли свойство читаться. CComponent
canSetProperty() Определяет, может ли свойство быть установлено. CComponent
checkAccess() Проверяет, находится ли указанный элемент в иерархии, начиная с этого элемента. CAuthItem
detachBehavior() Отсоединяет поведение от компонента. CComponent
detachBehaviors() Отсоединяет все поведения от компонента. CComponent
detachEventHandler() Отсоединяет существующий обработчик событий. CComponent
disableBehavior() Отключает присоединенное поведение. CComponent
disableBehaviors() Отключает все присоединенные поведения к этому компоненту. CComponent
enableBehavior() Включает присоединенное поведение. CComponent
enableBehaviors() Включает все присоединенные к этому компоненту поведения. CComponent
evaluateExpression() Вычисляет выражение PHP или обратный вызов в контексте этого компонента. CComponent
getAssignment() Возвращает информацию о назначении элемента. CAuthItem
getAuthManager() Возвращает менеджер авторизации CAuthItem
getBizRule() Возвращает правило бизнеса, связанное с этим элементом CAuthItem
getChildren() Возвращает дочерние элементы этого элемента. CAuthItem
getData() Возвращает дополнительные данные, связанные с этим элементом CAuthItem
getDescription() Возвращает описание элемента CAuthItem
getEventHandlers() Возвращает список присоединенных обработчиков событий для события. CComponent
getName() Возвращает имя элемента CAuthItem
getType() Возвращает тип элемента авторизации. Может быть 0 (операция), 1 (задача) или 2 (роль). CAuthItem
hasChild() Возвращает значение, указывающее, существует ли дочерний элемент CAuthItem
hasEvent() Определяет, определено ли событие. CComponent
hasEventHandler() Проверяет, имеет ли указанное событие присоединенные обработчики. CComponent
hasProperty() Определяет, определено ли свойство. CComponent
isAssigned() Возвращает значение, указывающее, назначен ли этот элемент пользователю. CAuthItem
raiseEvent() Вызывает событие. CComponent
removeChild() Удаляет дочерний элемент. CAuthItem
revoke() Отменяет назначение авторизации для пользователя. CAuthItem
setBizRule() Устанавливает правило бизнеса, связанное с этим элементом CAuthItem
setData() Устанавливает дополнительные данные, связанные с этим элементом CAuthItem
setDescription() Устанавливает описание элемента CAuthItem
setName() Устанавливает имя элемента CAuthItem

Подробности свойств

authManager свойство только для чтения

public IAuthManager getAuthManager()

менеджер авторизации

bizRule свойство

public string getBizRule()
public void setBizRule(string $value)

правило бизнеса, связанное с этим элементом

children свойство только для чтения

public array getChildren()

Возвращает дочерние элементы данного элемента.

См. также

  • IAuthManager::getItemChildren

data свойство

public mixed getData()
public void setData(mixed $value)

дополнительные данные, связанные с этим элементом

описание свойство

public string getDescription()
public void setDescription(string $value)

описание элемента

имя свойство

public string getName()
public void setName(string $value)

имя элемента

тип свойство только для чтения

public integer getType()

тип элемента авторизации. Может быть 0 (операция), 1 (задача) или 2 (роль).

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

__construct() метод

public void __construct(IAuthManager $auth, string $name, integer $type, string $description='', string $bizRule=NULL, mixed $data=NULL)
$auth IAuthManager менеджер авторизации
$name string имя элемента авторизации
$type integer тип элемента авторизации. Может быть 0 (операция), 1 (задача) или 2 (роль).
$description string описание
$bizRule string правило бизнес-логики, связанное с этим элементом
$data mixed дополнительные данные для этого элемента
Исходный код: framework/web/auth/CAuthItem.php#53 (показать)
public function __construct($auth,$name,$type,$description='',$bizRule=null,$data=null)
{
    
$this->_type=(int)$type;
    
$this->_auth=$auth;
    
$this->_name=$name;
    
$this->_description=$description;
    
$this->_bizRule=$bizRule;
    
$this->_data=$data;
}

Конструктор.

addChild() метод

public boolean addChild(string $name)
$name string имя дочернего элемента
{return} boolean успешность добавления элемента
Исходный код: framework/web/auth/CAuthItem.php#191 (показать)
public function addChild($name)
{
    return 
$this->_auth->addItemChild($this->_name,$name);
}

Добавляет дочерний элемент.

См. также

  • IAuthManager::addItemChild

assign() метод

public CAuthAssignment assign(mixed $userId, string $bizRule=NULL, mixed $data=NULL)
$userId mixed ID пользователя (см. IWebUser::getId)
$bizRule string правило бизнес-логики, которое будет выполнено при вызове checkAccess для данного элемента авторизации.
$data mixed дополнительные данные, связанные с этим назначением
{return} CAuthAssignment информация о назначении авторизации.
Исходный код: framework/web/auth/CAuthItem.php#239 (показать)
public function assign($userId,$bizRule=null,$data=null)
{
    return 
$this->_auth->assign($this->_name,$userId,$bizRule,$data);
}

Назначает этот элемент пользователю.

См. также

  • IAuthManager::assign

checkAccess() метод

public boolean checkAccess(string $itemName, array $params=array ( ))
$itemName string имя элемента для проверки
$params array параметры для передачи в оценку бизнес-правила
{return} boolean является ли указанный элемент частью иерархии, начинающейся с этого элемента.
Исходный код: framework/web/auth/CAuthItem.php#71 (показать)
public function checkAccess($itemName,$params=array())
{
    
Yii::trace('Checking permission "'.$this->_name.'"','system.web.auth.CAuthItem');
    if(
$this->_auth->executeBizRule($this->_bizRule,$params,$this->_data))
    {
        if(
$this->_name==$itemName)
            return 
true;
        foreach(
$this->_auth->getItemChildren($this->_name) as $item)
        {
            if(
$item->checkAccess($itemName,$params))
                return 
true;
        }
    }
    return 
false;
}

Проверяет, является ли указанный элемент частью иерархии, начинающейся с данного элемента. Ожидается, что этот метод будет использоваться внутренне фактическими реализациями IAuthManager::checkAccess.

getAssignment() метод

public CAuthAssignment getAssignment(mixed $userId)
$userId mixed ID пользователя (см. IWebUser::getId)
{return} CAuthAssignment информация о назначении элемента. Возвращает Null, если этот элемент не назначен пользователю.
Исходный код: framework/web/auth/CAuthItem.php#273 (показать)
public function getAssignment($userId)
{
    return 
$this->_auth->getAuthAssignment($this->_name,$userId);
}

Возвращает информацию о назначении элемента.

См. также

  • IAuthManager::getAuthAssignment

getAuthManager() метод

public IAuthManager getAuthManager()
{return} IAuthManager менеджер авторизации
Исходный код: framework/web/auth/CAuthItem.php#90 (показать)
public function getAuthManager()
{
    return 
$this->_auth;
}

getBizRule() метод

public string getBizRule()
{return} string правило бизнес-логики, связанное с этим элементом
Исходный код: framework/web/auth/CAuthItem.php#147 (показать)
public function getBizRule()
{
    return 
$this->_bizRule;
}

getChildren() метод

public array getChildren()
{return} array все дочерние элементы этого элемента.
Исходный код: framework/web/auth/CAuthItem.php#224 (показать)
public function getChildren()
{
    return 
$this->_auth->getItemChildren($this->_name);
}

Возвращает дочерние элементы этого элемента.

См. также

  • IAuthManager::getItemChildren

getData() метод

public mixed getData()
{return} mixed дополнительные данные, связанные с этим элементом
Исходный код: framework/web/auth/CAuthItem.php#167 (показать)
public function getData()
{
    return 
$this->_data;
}

getDescription() метод

public string getDescription()
{return} string описание элемента
Исходный код: framework/web/auth/CAuthItem.php#127 (показать)
public function getDescription()
{
    return 
$this->_description;
}

getName() метод

public string getName()
{return} string имя элемента
Исходный код: framework/web/auth/CAuthItem.php#106 (показать)
public function getName()
{
    return 
$this->_name;
}

getType() метод

public integer getType()
{return} integer тип элемента авторизации. Может быть 0 (операция), 1 (задача) или 2 (роль).
Исходный код: framework/web/auth/CAuthItem.php#98 (показать)
public function getType()
{
    return 
$this->_type;
}

hasChild() метод

public boolean hasChild(string $name)
$name string имя дочернего элемента
{return} boolean существует ли дочерний элемент
Исходный код: framework/web/auth/CAuthItem.php#214 (показать)
public function hasChild($name)
{
    return 
$this->_auth->hasItemChild($this->_name,$name);
}

Возвращает значение, указывающее, существует ли дочерний элемент.

См. также

  • IAuthManager::hasItemChild

isAssigned() метод

public boolean isAssigned(mixed $userId)
$userId смешанный идентификатор пользователя (см. IWebUser::getId)
{return} логический является ли элемент назначенным пользователю.
Исходный код: framework/web/auth/CAuthItem.php#261 (показать)
public function isAssigned($userId)
{
    return 
$this->_auth->isAssigned($this->_name,$userId);
}

Возвращает значение, указывающее, назначен ли данный элемент пользователю.

См. также

  • IAuthManager::isAssigned

removeChild() метод

public boolean removeChild(string $name)
$name строка имя дочернего элемента
{return} логический успешность удаления
Исходный код: framework/web/auth/CAuthItem.php#203 (показать)
public function removeChild($name)
{
    return 
$this->_auth->removeItemChild($this->_name,$name);
}

Удаляет дочерний элемент. Примечание: дочерний элемент не удаляется. Удаляется только родительско-дочерняя связь.

См. также

  • IAuthManager::removeItemChild

revoke() метод

public boolean revoke(mixed $userId)
$userId смешанный идентификатор пользователя (см. IWebUser::getId)
{return} логический успешность удаления
Исходный код: framework/web/auth/CAuthItem.php#250 (показать)
public function revoke($userId)
{
    return 
$this->_auth->revoke($this->_name,$userId);
}

Отменяет назначение авторизации для пользователя.

См. также

  • IAuthManager::revoke

setBizRule() метод

public void setBizRule(string $value)
$value строка правило бизнес-логики, связанное с этим элементом
Исходный код: framework/web/auth/CAuthItem.php#155 (показать)
public function setBizRule($value)
{
    if(
$this->_bizRule!==$value)
    {
        
$this->_bizRule=$value;
        
$this->_auth->saveAuthItem($this);
    }
}

setData() метод

public void setData(mixed $value)
$value смешанный дополнительные данные, связанные с этим элементом
Исходный код: framework/web/auth/CAuthItem.php#175 (показать)
public function setData($value)
{
    if(
$this->_data!==$value)
    {
        
$this->_data=$value;
        
$this->_auth->saveAuthItem($this);
    }
}

setDescription() метод

public void setDescription(string $value)
$value строка описание элемента
Исходный код: framework/web/auth/CAuthItem.php#135 (показать)
public function setDescription($value)
{
    if(
$this->_description!==$value)
    {
        
$this->_description=$value;
        
$this->_auth->saveAuthItem($this);
    }
}

setName() метод

public void setName(string $value)
$value строка имя элемента
Исходный код: framework/web/auth/CAuthItem.php#114 (показать)
public function setName($value)
{
    if(
$this->_name!==$value)
    {
        
$oldName=$this->_name;
        
$this->_name=$value;
        
$this->_auth->saveAuthItem($this,$oldName);
    }
}

© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc/api/1.1/CAuthItem

Spec-Zone.ru

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