DataSource::getFirstValue() — параметры и описание

Сигнатура

public getFirstValue(array<string|int, mixed> $params, string $fieldName[, string $defaultValue = '' ]) : array<string|int, mixed>

Описание

Получить значение поля первой сущности из списка.

Параметры

$params array<string|int, mixed>

Параметры списка.

$fieldName string

Имя поля.

$defaultValue string = ''

Значение поля по умолчанию.

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

array<string|int, mixed>

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

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

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

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

Loader::includeModule('crm');

/** @var DataSource $object */
$params = [];
$fieldName = '';
$result = $object->getFirstValue($params, $fieldName);
// $result: array<string|int, mixed>

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

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

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