CAuthItem

所有包 | 属性 | 方法

包	system.web.auth
继承	class CAuthItem » CComponent
可用自	1.0
版本	$Id$

CAuthItem represents an authorization item. An authorization item can be an operation, a task or a role. They form an authorization hierarchy. Items on higher levels of the hierarchy inherit the permissions represented by items on lower levels. A user may be assigned one or several authorization items (called assignments. He can perform an operation only when it is among his assigned items.

公共属性

隐藏继承的属性

属性	类型	描述	被定义在
authManager	IAuthManager	the authorization manager	CAuthItem
bizRule	string	the business rule associated with this item	CAuthItem
children	array	Returns the children of this item.	CAuthItem
data	string	the additional data associated with this item	CAuthItem
description	string	the item description	CAuthItem
name	string	the item name	CAuthItem
type	integer	the authorization item type.	CAuthItem

公共方法

隐藏继承的方法

方法	描述	被定义在
__call()	Calls the named method which is not a class method.	CComponent
__construct()	Constructor.	CAuthItem
__get()	Returns a property value, an event handler list or a behavior based on its name.	CComponent
__isset()	Checks if a property value is null.	CComponent
__set()	Sets value of a component property.	CComponent
__unset()	Sets a component property to be null.	CComponent
addChild()	Adds a child item.	CAuthItem
asa()	Returns the named behavior object.	CComponent
assign()	Assigns this item to a user.	CAuthItem
attachBehavior()	Attaches a behavior to this component.	CComponent
attachBehaviors()	Attaches a list of behaviors to the component.	CComponent
attachEventHandler()	Attaches an event handler to an event.	CComponent
canGetProperty()	Determines whether a property can be read.	CComponent
canSetProperty()	Determines whether a property can be set.	CComponent
checkAccess()	Checks to see if the specified item is within the hierarchy starting from this item.	CAuthItem
detachBehavior()	Detaches a behavior from the component.	CComponent
detachBehaviors()	Detaches all behaviors from the component.	CComponent
detachEventHandler()	Detaches an existing event handler.	CComponent
disableBehavior()	Disables an attached behavior.	CComponent
disableBehaviors()	Disables all behaviors attached to this component.	CComponent
enableBehavior()	Enables an attached behavior.	CComponent
enableBehaviors()	Enables all behaviors attached to this component.	CComponent
getAssignment()	Returns the item assignment information.	CAuthItem
getAuthManager()		CAuthItem
getBizRule()		CAuthItem
getChildren()	Returns the children of this item.	CAuthItem
getData()		CAuthItem
getDescription()		CAuthItem
getEventHandlers()	Returns the list of attached event handlers for an event.	CComponent
getName()		CAuthItem
getType()		CAuthItem
hasChild()	Returns a value indicating whether a child exists	CAuthItem
hasEvent()	Determines whether an event is defined.	CComponent
hasEventHandler()	Checks whether the named event has attached handlers.	CComponent
hasProperty()	Determines whether a property is defined.	CComponent
isAssigned()	Returns a value indicating whether this item has been assigned to the user.	CAuthItem
raiseEvent()	Raises an event.	CComponent
removeChild()	Removes a child item.	CAuthItem
revoke()	Revokes an authorization assignment from a user.	CAuthItem
setBizRule()		CAuthItem
setData()		CAuthItem
setDescription()		CAuthItem
setName()		CAuthItem

属性详情

authManager 属性只读

public IAuthManager getAuthManager()

the authorization manager

bizRule 属性

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

the business rule associated with this item

children 属性只读

public array getChildren()

Returns the children of this item.

参见

IAuthManager::getItemChildren

data 属性

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

the additional data associated with this item

description 属性

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

the item description

name 属性

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

the item name

type 属性只读

public integer getType()

the authorization item type. This could be 0 (operation), 1 (task) or 2 (role).

方法详情

__construct() 方法

public void __construct(IAuthManager $auth, string $name, integer $type, description $description='', string $bizRule=NULL, mixed $data=NULL)
$auth	IAuthManager	authorization manager
$name	string	authorization item name
$type	integer	authorization item type. This can be 0 (operation), 1 (task) or 2 (role).
$description	description	the description
$bizRule	string	the business rule associated with this item
$data	mixed	additional data for this item

Constructor.

addChild() 方法

public boolean addChild(string $name)
$name	string	the name of the child item
{return}	boolean	whether the item is added successfully

Adds a child item.

参见

IAuthManager::addItemChild

assign() 方法

public CAuthAssignment assign(mixed $userId, string $bizRule=NULL, mixed $data=NULL)
$userId	mixed	the user ID (see IWebUser::getId)
$bizRule	string	the business rule to be executed when checkAccess is called for this particular authorization item.
$data	mixed	additional data associated with this assignment
{return}	CAuthAssignment	the authorization assignment information.

Assigns this item to a user.

参见

IAuthManager::assign

checkAccess() 方法

public boolean checkAccess(string $itemName, array $params=array ( ))
$itemName	string	the name of the item to be checked
$params	array	the parameters to be passed to business rule evaluation
{return}	boolean	whether the specified item is within the hierarchy starting from this item.

Checks to see if the specified item is within the hierarchy starting from this item. This method is internally used by IAuthManager::checkAccess.

getAssignment() 方法

public CAuthAssignment getAssignment(mixed $userId)
$userId	mixed	the user ID (see IWebUser::getId)
{return}	CAuthAssignment	the item assignment information. Null is returned if this item is not assigned to the user.

Returns the item assignment information.

参见

IAuthManager::getAuthAssignment

getAuthManager() 方法

public IAuthManager getAuthManager()
{return}	IAuthManager	the authorization manager

getBizRule() 方法

public string getBizRule()
{return}	string	the business rule associated with this item

getChildren() 方法

public array getChildren()
{return}	array	all child items of this item.

Returns the children of this item.

参见

IAuthManager::getItemChildren

getData() 方法

public string getData()
{return}	string	the additional data associated with this item

getDescription() 方法

public string getDescription()
{return}	string	the item description

getName() 方法

public string getName()
{return}	string	the item name

getType() 方法

public integer getType()
{return}	integer	the authorization item type. This could be 0 (operation), 1 (task) or 2 (role).

hasChild() 方法

public boolean hasChild(string $name)
$name	string	the child item name
{return}	boolean	whether the child exists

Returns a value indicating whether a child exists

参见

IAuthManager::hasItemChild

isAssigned() 方法

public boolean isAssigned(mixed $userId)
$userId	mixed	the user ID (see IWebUser::getId)
{return}	boolean	whether the item has been assigned to the user.

Returns a value indicating whether this item has been assigned to the user.

参见

IAuthManager::isAssigned

removeChild() 方法

public boolean removeChild(string $name)
$name	string	the child item name
{return}	boolean	whether the removal is successful

Removes a child item. Note, the child item is not deleted. Only the parent-child relationship is removed.

参见

IAuthManager::removeItemChild

revoke() 方法

public boolean revoke(mixed $userId)
$userId	mixed	the user ID (see IWebUser::getId)
{return}	boolean	whether removal is successful

Revokes an authorization assignment from a user.

参见

IAuthManager::revoke

setBizRule() 方法

public void setBizRule(string $value)
$value	string	the business rule associated with this item

setData() 方法

public void setData(string $value)
$value	string	the business rule associated with this item

setDescription() 方法

public void setDescription(string $value)
$value	string	the item description

setName() 方法

public void setName(string $value)
$value	string	the item name