CAccessRule

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

actions свойство

public array $actions;

список идентификаторов действий, к которым относится это правило. Сравнение нечувствительно к регистру. Если действия не указаны, правило применяется ко всем действиям.

allow свойство

public boolean $allow;

является ли это правилом «разрешить» или «запретить».

controllers свойство

public array $controllers;

список идентификаторов контроллеров, к которым относится это правило. Сравнение нечувствительно к регистру.

deniedCallback свойство (доступно с версии v1.1.11)

public mixed $deniedCallback;

обратный вызов метода отказа, который будет вызван, когда доступ запрещен. Он заменяет поведение, отображающее сообщение об ошибке. Может быть допустимым PHP обратным вызовом, включая имя метода класса (array(ClassName/Object, MethodName)), или анонимной функцией (PHP 5.3.0+). Для получения дополнительной информации об различных вариантах, см.

expression свойство

public string $expression;

PHP выражение, значение которого указывает, должно ли применяться это правило. В этом выражении можно использовать $user , которое относится к Yii::app()->user. Выражение также может быть допустимым PHP обратным вызовом, включая имя метода класса (array(ClassName/Object, MethodName)) или анонимную функцию (PHP 5.3.0+). Подпись функции/метода должна быть следующей:

function foo($user, $rule) { ... }

ips свойство

public array $ips;

Шаблоны IP-адресов.

свойство message (доступно начиная с v1.1.1)

public string $message;

сообщение об ошибке, которое будет отображаться, когда авторизация запрещена этой политикой. Если не задано, будет отображено сообщение об ошибке по умолчанию.

свойство roles

public array $roles;

список ролей, к которым применяется данное правило. Для каждой роли вызывается метод CWebUser::checkAccess текущего пользователя. Если один из вызовов вернёт true, правило будет применено. Обратите внимание, что роли следует использовать в основном в правилах «разрешить», потому что роль, по определению, представляет собой набор разрешений.

свойство users

public array $users;

список имён пользователей, к которым применяется это правило. Сравнение регистронезависимое. Если имена пользователей не указаны, правило применяется ко всем пользователям.

свойство verbs

public array $verbs;

список типов запросов (например, GET, POST), к которым применяется данное правило.

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

isActionMatched() метод

protected boolean isActionMatched(CAction $action)

protected function isActionMatched($action)
{
    return empty($this->actions) || in_array(strtolower($action->getId()),$this->actions);
}

isControllerMatched() метод

protected boolean isControllerMatched(CController $controller)

protected function isControllerMatched($controller)
{
    return empty($this->controllers) || in_array(strtolower($controller->getUniqueId()),$this->controllers);
}

isExpressionMatched() метод

protected boolean isExpressionMatched(IWebUser $user)

protected function isExpressionMatched($user)
{
    if($this->expression===null)
        return true;
    else
        return $this->evaluateExpression($this->expression, array('user'=>$user));
}

isIpMatched() метод

protected boolean isIpMatched(string $ip)

protected function isIpMatched($ip)
{
    if(empty($this->ips))
        return true;
    foreach($this->ips as $rule)
    {
        if($rule==='*' || $rule===$ip || (($pos=strpos($rule,'*'))!==false && !strncmp($ip,$rule,$pos)))
            return true;
    }
    return false;
}

isRoleMatched() метод

protected boolean isRoleMatched(IWebUser $user)

protected function isRoleMatched($user)
{
    if(empty($this->roles))
        return true;
    foreach($this->roles as $key=>$role)
    {
        if(is_numeric($key))
        {
            if($user->checkAccess($role))
                return true;
        }
        else
        {
            if($user->checkAccess($key,$role))
                return true;
        }
    }
    return false;
}

isUserAllowed() метод

public integer isUserAllowed(CWebUser $user, CController $controller, CAction $action, string $ip, string $verb)

public function isUserAllowed($user,$controller,$action,$ip,$verb)
{
    if($this->isActionMatched($action)
        && $this->isUserMatched($user)
        && $this->isRoleMatched($user)
        && $this->isIpMatched($ip)
        && $this->isVerbMatched($verb)
        && $this->isControllerMatched($controller)
        && $this->isExpressionMatched($user))
        return $this->allow ? 1 : -1;
    else
        return 0;
}

Проверяет, разрешено ли веб-пользователю выполнить указанное действие.

isUserMatched() метод

protected boolean isUserMatched(IWebUser $user)

protected function isUserMatched($user)
{
    if(empty($this->users))
        return true;
    foreach($this->users as $u)
    {
        if($u==='*')
            return true;
        elseif($u==='?' && $user->getIsGuest())
            return true;
        elseif($u==='@' && !$user->getIsGuest())
            return true;
        elseif(!strcasecmp($u,$user->getName()))
            return true;
    }
    return false;
}

isVerbMatched() метод

protected boolean isVerbMatched(string $verb)

protected function isVerbMatched($verb)
{
    return empty($this->verbs) || in_array(strtolower($verb),$this->verbs);
}