Spec-Zone.ru › Yii 1.1
CAuthItem 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
Подробности свойств public IAuthManager getAuthManager () менеджер авторизации
public string getBizRule () public void setBizRule (string $value) правило бизнеса, связанное с этим элементом
public array getChildren () Возвращает дочерние элементы данного элемента.
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 (роль).
Подробное описание методов 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 ; } Конструктор.
public boolean addChild (string $name) $name string имя дочернего элемента {return} boolean успешность добавления элемента
Добавляет дочерний элемент.
public CAuthAssignment assign (mixed $userId, string $bizRule=NULL, mixed $data=NULL) $userId mixed ID пользователя (см. IWebUser::getId ) $bizRule string правило бизнес-логики, которое будет выполнено при вызове checkAccess для данного элемента авторизации. $data mixed дополнительные данные, связанные с этим назначением {return} CAuthAssignment информация о назначении авторизации.
Назначает этот элемент пользователю.
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 .
Возвращает информацию о назначении элемента.
public string getBizRule () {return} string правило бизнес-логики, связанное с этим элементом
public array getChildren () {return} array все дочерние элементы этого элемента.
Возвращает дочерние элементы этого элемента.
public mixed getData () {return} mixed дополнительные данные, связанные с этим элементом
public string getDescription () {return} string описание элемента
public string getName () {return} string имя элемента
public integer getType () {return} integer тип элемента авторизации. Может быть 0 (операция), 1 (задача) или 2 (роль).
public boolean hasChild (string $name) $name string имя дочернего элемента {return} boolean существует ли дочерний элемент
Возвращает значение, указывающее, существует ли дочерний элемент.
public boolean isAssigned (mixed $userId) $userId смешанный идентификатор пользователя (см. IWebUser::getId ) {return} логический является ли элемент назначенным пользователю.
Возвращает значение, указывающее, назначен ли данный элемент пользователю.
public boolean removeChild (string $name) $name строка имя дочернего элемента {return} логический успешность удаления
Удаляет дочерний элемент. Примечание: дочерний элемент не удаляется. Удаляется только родительско-дочерняя связь.
public boolean revoke (mixed $userId) $userId смешанный идентификатор пользователя (см. IWebUser::getId ) {return} логический успешность удаления
Отменяет назначение авторизации для пользователя.
public void setBizRule (string $value) $value строка правило бизнес-логики, связанное с этим элементом
public void setData (mixed $value) $value смешанный дополнительные данные, связанные с этим элементом
public void setDescription (string $value) $value строка описание элемента
public void setName (string $value) $value строка имя элемента