method public

AccessFilter::getFilter()

Класс: \Bitrix\Main\Access\Filter\AccessFilter

Сигнатура

public getFilter(string $entity[, array<string|int, mixed> $params = [] ]) : array<string|int, mixed>

Описание

Один экземпляр фильтра доступа может обрабатывать несколько сущностей (рекомендуется использовать 1 фильтр для сущностей, которые
сходны по смыслу и назначению). Чтобы получить фильтр для конкретной сущности, необходимо передать параметр entity.

Если у пользователя есть полный доступ, то можно вернуть пустой массив (то есть фильтрация отсутствует).
Если у пользователя нет доступа вообще, то можно вернуть заведомо ложный фильтр, который
не вернёт записей (например, `ID IS NULL').

Параметры

$entity string

$params array<string|int, mixed> = []

Возвращаемое значение

array<string|int, mixed>

Как применяется в AccessFilter

AccessFilter::getFilter() — метод интерфейса \Bitrix\Main\Access\Filter\AccessFilter модуля «Главный модуль». AccessFilter: Фильтр для получения элементов согласно правам пользователя.

Метод объекта: сначала нужен объект, реализующий AccessFilter.

use Bitrix\Main\Access\Filter\AccessFilter;

/** @var AccessFilter $object */
$entity = '';
$result = $object->getFilter($entity);
// $result: array<string|int, mixed>

Другие методы AccessFilter

__construct()

getFilter() есть и у других классов модуля «Главный модуль»: AbstractAccessFilter, Event, Event, Event, Grid, Options, Query, TabletGrid.

Исходный файл: source/main/lib/access/filter/accessfilter.php:34