Получить первое непустое значение Collection::firstNotEmpty
Модуль: main — подключать отдельно не нужно
Доступно с версии: 14.0.4
Метод Collection::firstNotEmpty перебирает пары аргументов «массив — ключ» по порядку и возвращает первое непустое значение. Метод подходит, когда значение может прийти из нескольких источников, например из параметров компонента и из настроек по умолчанию.
Сигнатура метода в классе Bitrix\Main\Type\Collection:
public static function firstNotEmpty()
Параметры
Обязательные параметры обозначены *
Метод принимает любое число пар аргументов.
| Параметр | Тип | Описание |
|---|---|---|
| array* | array |
Задает массив пары. Нечетные аргументы — массивы |
| key* | string, int, array |
Задает ключ пары. Четные аргументы — ключи. Массив ключей задает путь во вложенный массив |
Сигнатура PHP не объявляет параметры. Метод читает их через func_get_arg.
Возвращаемое значение
Метод возвращает первое значение, которое не равно пустой строке при нестрогом сравнении. Массив или объект метод возвращает всегда, даже пустой массив.
Метод считает пустыми значения null, false и пустую строку. Число 0 и строку '0' метод пустыми не считает. Если непустого значения нет, метод возвращает пустую строку.
При нечетном числе аргументов PHP выбрасывает ValueError в функции func_get_arg, если до последней пары метод не нашел значение.
Примеры
Пример. Код берет единицу измерения из параметров, а если значение пустое, — из настроек по умолчанию:
<?php
use Bitrix\Main\Type\Collection;
require $_SERVER['DOCUMENT_ROOT'] . '/bitrix/modules/main/include/prolog_before.php';
$params = ['UNIT' => ''];
$defaults = ['units' => ['weight' => 'kg']];
echo Collection::firstNotEmpty($params, 'UNIT', $defaults, ['units', 'weight']);
Код выведет kg.