CAuthManager

Property Details

defaultRoles property

public array $defaultRoles;

list of role names that are assigned to all users implicitly. These roles do not need to be explicitly assigned to any user. When calling checkAccess, these roles will be checked first. For performance reason, you should minimize the number of such roles. A typical usage of such roles is to define an 'authenticated' role and associate it with a biz rule which checks if the current user is authenticated. And then declare 'authenticated' in this property so that it can be applied to every authenticated user.

operations property read-only

public array getOperations(mixed $userId=NULL)

Returns operations. This is a shortcut method to IAuthManager::getAuthItems.

roles property read-only

public array getRoles(mixed $userId=NULL)

Returns roles. This is a shortcut method to IAuthManager::getAuthItems.

showErrors property (available since v1.1.3)

public boolean $showErrors;

Enable error reporting for bizRules.

tasks property read-only

public array getTasks(mixed $userId=NULL)

Returns tasks. This is a shortcut method to IAuthManager::getAuthItems.

Method Details

checkItemChildType() method

protected void checkItemChildType(integer $parentType, integer $childType)

protected function checkItemChildType($parentType,$childType)
{
    static $types=array('operation','task','role');
    if($parentType < $childType)
        throw new CException(Yii::t('yii','Cannot add an item of type "{child}" to an item of type "{parent}".',
            array('{child}'=>$types[$childType], '{parent}'=>$types[$parentType])));
}

Checks the item types to make sure a child can be added to a parent.

createOperation() method

public CAuthItem createOperation(string $name, string $description='', string $bizRule=NULL, mixed $data=NULL)

public function createOperation($name,$description='',$bizRule=null,$data=null)
{
    return $this->createAuthItem($name,CAuthItem::TYPE_OPERATION,$description,$bizRule,$data);
}

Creates an operation. This is a shortcut method to IAuthManager::createAuthItem.

createRole() method

public CAuthItem createRole(string $name, string $description='', string $bizRule=NULL, mixed $data=NULL)

public function createRole($name,$description='',$bizRule=null,$data=null)
{
    return $this->createAuthItem($name,CAuthItem::TYPE_ROLE,$description,$bizRule,$data);
}

Creates a role. This is a shortcut method to IAuthManager::createAuthItem.

createTask() method

public CAuthItem createTask(string $name, string $description='', string $bizRule=NULL, mixed $data=NULL)

public function createTask($name,$description='',$bizRule=null,$data=null)
{
    return $this->createAuthItem($name,CAuthItem::TYPE_TASK,$description,$bizRule,$data);
}

Creates a task. This is a shortcut method to IAuthManager::createAuthItem.

executeBizRule() method

public boolean executeBizRule(string $bizRule, array $params, mixed $data)

public function executeBizRule($bizRule,$params,$data)
{
    if($bizRule==='' || $bizRule===null)
        return true;
    if ($this->showErrors)
        return eval($bizRule)!=0;
    else
    {
        try
        {
            return @eval($bizRule)!=0;
        }
        catch (ParseError $e)
        {
            return false;
        }
    }
}

Executes the specified business rule.

getOperations() method

public array getOperations(mixed $userId=NULL)

public function getOperations($userId=null)
{
    return $this->getAuthItems(CAuthItem::TYPE_OPERATION,$userId);
}

Returns operations. This is a shortcut method to IAuthManager::getAuthItems.

getRoles() method

public array getRoles(mixed $userId=NULL)

public function getRoles($userId=null)
{
    return $this->getAuthItems(CAuthItem::TYPE_ROLE,$userId);
}

Returns roles. This is a shortcut method to IAuthManager::getAuthItems.

getTasks() method

public array getTasks(mixed $userId=NULL)

public function getTasks($userId=null)
{
    return $this->getAuthItems(CAuthItem::TYPE_TASK,$userId);
}

Returns tasks. This is a shortcut method to IAuthManager::getAuthItems.