Класс yii\filters\AccessRule

Этот класс представляет правило доступа, определённое фильтром действия yii\filters\AccessControl

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

Публичные методы

Защищённые методы

Свойства

$actions общественное свойство

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

public array $actions = null

$allow общественное свойство

Является ли это правилом разрешения или запрета.

public boolean $allow = null

$controllers общественное свойство

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

Сравнение использует yii\base\Controller::$uniqueId, поэтому каждый идентификатор контроллера предваряется идентификатором модуля (если он есть). Для контроллера product в приложении вы бы указали это свойство как ['product'] , а если этот контроллер находится в модуле shop, это будет ['shop/product'].

Сравнение регистрозависимое.

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

Начиная с версии 2.0.12, идентификаторы контроллеров могут быть указаны как шаблоны, например module/*.

public array $controllers = null

$denyCallback общественное свойство

Обратный вызов, который будет вызван, если это правило определит, что доступ к текущему действию должен быть запрещен. Если не задано, поведение будет определяться yii\filters\AccessControl.

Подпись обратного вызова должна быть следующей:

function ($rule, $action)

где $rule это правило, а $action — текущий объект действия.

public callable $denyCallback = null

$ips общественное свойство

Список IP-адресов пользователей, к которым применяется это правило. IP-адрес может содержать подстановочный символ * в конце, чтобы он соответствовал IP-адресам с тем же префиксом. Например, '192.168.*' соответствует всем IP-адресам в сегменте '192.168.'. Если свойство не задано или пустое, это означает, что правило применяется ко всем IP-адресам.

См. также yii\web\Request::$userIP.

public array $ips = null

$matchCallback общественное свойство

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

function ($rule, $action)

где $rule это правило, а $action — текущий объект действия. Обратный вызов должен вернуть логическое значение, указывающее, следует ли применять это правило.

public callable $matchCallback = null

$roleParams общественное свойство (доступно начиная с версии 2.0.12)

Параметры, передаваемые в функцию yii\web\User::can() для оценки разрешений пользователя в $roles.

Если это массив, он будет передан непосредственно в yii\web\User::can(). Например, для передачи идентификатора из текущего запроса, вы можете использовать следующее:

['postId' => Yii::$app->request->get('id')]

Вы также можете указать замыкание, которое возвращает массив. Это можно использовать для оценки значений массива только в том случае, если они нужны, например, когда модель необходимо загрузить, как в следующем коде:

'rules' => [
    [
        'allow' => true,
        'actions' => ['update'],
        'roles' => ['updatePost'],
        'roleParams' => function($rule) {
            return ['post' => Post::findOne(Yii::$app->request->get('id'))];
        },
    ],
],

Ссылка на экземпляр yii\filters\AccessRule будет передана в замыкание в качестве первого параметра.

См. также $roles.

public array|Closure $roleParams = []

$roles общественное свойство

Список ролей, к которым применяется это правило (требует должной настройки компонента User). Распознаются две специальные роли, которые проверяются через yii\web\User::$isGuest:

• ?: соответствует гостевому пользователю (еще не авторизован)
• @: соответствует авторизованному пользователю

Если вы используете RBAC (контроль доступа на основе ролей), вы также можете указать имена ролей или разрешений. В этом случае будет вызван yii\web\User::can() для проверки доступа.

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

См. также $roleParams.

public array $roles = null

$verbs общественное свойство

Список методов запроса (например, GET, POST), к которым применяется это правило. Если свойство не задано или пустое, это означает, что правило применяется ко всем методам запроса.

См. также yii\web\Request::$method.

public array $verbs = null

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