Skip to content

functions.md

Latest commit

 

History

History
98 lines (85 loc) · 4.31 KB

functions.md

File metadata and controls

98 lines (85 loc) · 4.31 KB
Raw

"Плавающие" функции в фрейморке

"Плавающие" функции называются так, поскольку они не привязаны ни к какому классу (в глобальном пространстве имен).

Рассмотрим их назначение.

Отладка

1/ Дампер в браузер (свой "велосипед"), но с проверкой прав.

// проверяет права и выводит только для пользователя по константе IS_BETA_TESTER или админа:
// также проверяет доступность d() - в этом случае использует их
// либо использует \Bitrix\Main\Diag\Debug::dump()
my_print_r($var);

// вывести также и debug_backtrace
my_print_r($var,  backtrace: true);

2/ Тут же идет функция для формирования backtrace для скрипта ошибки: Можно ее менять от проекта к проекту в зависимости от задачи отлова ошибок скриптом показа ошибки.

string debug_string_backtrace();

Для работы с HL-блоками

В фреймоврке идет две используемые функции для работы с HL-блоками:

1/ Получение DataManager для работы с данными HL-блока, кеширующие "обряд создания DataManager для HL-блоков":

$list = __getHl('CustomSettings')::getList(['select' => '*'])->fetchAll();
// можно и по числовому ID HL-блока
$item = __getHl(3)->getById(1)->fetch();

2/ Реестр различных не-структурированных настроек по сайту. Удобно создать для такого реестра настроек отдельный HL-блок, дернуть один раз в PHP-консоли:

// Создание HL-блока для хранения настроек. Запускается 1 раз для создания нужного блока.
\Hipot\BitrixUtils\HiBlockApps::installCustomSettingsHiBlock();

и затем в любых местах сайта (в шаблоне, компонентах, событиях..) использовать получение настройки с "ленивой инициализацией" и кешем:

// hi - фирменный префикс, Cs - CustomSettings - различные настройки.
// default_value - если значения в HL-блоке настроек нет, по аналогии use-case Bitrix\Main\ConOption::get():
// Bitrix\Main\Config\Option::get('my_module', 'my_param', 'default_value');
echo __hiCs('my_param', 'default_value');

Другие для mixed-типов

1/ Удаляет из массива пустые элементы с пустыми значениями рекурсивно. Удобно при работе с массивами, пришедшими из json.

$ar = [
    'a' => '  ',
    'e' => [
        'f',
        null
    ]
];
$ar = array_trim_r($ar);
/*
$ar = [
    'e' => [
        'f',
    ]
];
*/

2/ Получить элемент через точечную нотацию. Свой "велосипед". Лучше использовать сторонние библиотеки.

$data = [
    'user' => [
        'profile' => [
            'id' => 625,
            'pic' => '625.png',
        ],
    ],
];
$defaultUserId = 0;
$userId = array_get_dot($data, 'user.profile.id', $defaultUserId);

3/ Функция кодирования email для вывода на сайт (напр. страница контактов или подвал сайта). Используется совместно с jquery-плагином $.mailme

// info AT hipot-studio DOT com
$hideEmail = mailHideWithMailme('info@hipot-studio.com');
<span class="mailme"><?=$hideEmail?></span>
<script>
$(function(){
    // transform with browser to a mailto link
    $(".mailme").mailme();
});
</script>