method public

LeadIdle::prepareEntityListFilter()

Сигнатура

public prepareEntityListFilter(array<string|int, mixed> $filterParams) : array<string|int, mixed>

Описание

Подготовить фильтр списка сущностей.

Параметры

$filterParams array<string|int, mixed>

Параметры фильтра.

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

array<string|int, mixed>

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

LeadIdle::prepareEntityListFilter() — метод класса \Bitrix\Crm\Widget\Data\LeadIdle модуля «CRM».

Метод объекта: сначала нужен экземпляр LeadIdle.

use Bitrix\Main\Loader;
use Bitrix\Crm\Widget\Data\LeadIdle;

Loader::includeModule('crm');

/** @var LeadIdle $object */
$filterParams = [];
$result = $object->prepareEntityListFilter($filterParams);
// $result: array<string|int, mixed>

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

applyFilterContext() Подготовить дополнительные параметры фильтра в соответствии с данными контекста.
enablePermissionCheck() Включить или отключить контроль прав доступа
extractDetailsPageUrlParams() Извлечь параметры URL страницы детального просмотра из запроса.
getAttributes() Возвращает специальные настройки для источника.
getCacheData()
getDataContext() Получить текущий контекст данных
getDetailsPageUrl() Получить URL страницы детального просмотра.
getFilterContextData() Получить словарь параметров контекста фильтрации
getFirst() Получить первую сущность из списка.
getFirstValue() Получить значение поля первой сущности из списка.
getList() Получить список сущностей.
getPresetFullName() Получить полное имя пресета данных (имя источника данных + имя пресета)

prepareEntityListFilter() есть и у других классов модуля «CRM»: ActivityMarkStatistics, ActivityMarkStatistics, ActivityStatistics, ActivityStatistics, ActivityStatusStatistics, ActivityStatusStatistics, ActivityStreamStatistics, ActivityStreamStatistics.

Исходный файл: source/crm/lib/widget/data/leadidle.php:302