alex19pov31 / bitrix-helper

src/functions.php

<?php

use Alex19pov31\BitrixHelper\ComponentHelper;
use Alex19pov31\BitrixHelper\HlBlockHelper;
use Alex19pov31\BitrixHelper\IblockHelper;
use Bitrix\Main\Application;

The type Bitrix\Main\Application was not found. Maybe you did not declare it correctly or list all dependencies?

use Bitrix\Main\Data\Cache;

The type Bitrix\Main\Data\Cache was not found. Maybe you did not declare it correctly or list all dependencies?

use Bitrix\Main\Data\TaggedCache;

The type Bitrix\Main\Data\TaggedCache was not found. Maybe you did not declare it correctly or list all dependencies?

use Bitrix\Main\DB\Exception;

The type Bitrix\Main\DB\Exception was not found. Maybe you did not declare it correctly or list all dependencies?

This use statement conflicts with another class in this namespace, Exception. Consider defining an alias.

use Bitrix\Main\DB\Result;

The type Bitrix\Main\DB\Result was not found. Maybe you did not declare it correctly or list all dependencies?

use Bitrix\Main\Loader;

The type Bitrix\Main\Loader was not found. Maybe you did not declare it correctly or list all dependencies?

use Bitrix\Main\ORM\Data\DataManager;

The type Bitrix\Main\ORM\Data\DataManager was not found. Maybe you did not declare it correctly or list all dependencies?

use Bitrix\Main\HttpRequest;

The type Bitrix\Main\HttpRequest was not found. Maybe you did not declare it correctly or list all dependencies?

This use statement conflicts with another class in this namespace, HttpRequest. Consider defining an alias.

if (!function_exists('bxApp')) {
    /**
     * Entry point bitrix application
     *
     * @return CMain
     */
    function bxApp(): CMain

The type CMain was not found. Maybe you did not declare it correctly or list all dependencies?

    {
        global $APPLICATION;
        return $APPLICATION;
    }
}

if (!function_exists('appInstance')) {
    function appInstance(): Application
    {
        return Application::getInstance();
    }
}

if (!function_exists('sql')) {
    /**
     * Выполнить sql запрос
     *
     * @param string $sql
     * @return Result
     */
    function sql(string $sql): Result
    {
        return appInstance()->getConnection()->query($sql);
    }
}

if (!function_exists('loadModule')) {
    /**
     * Загрузить модуль
     *
     * @param string $moduleName
     * @return boolean
     */
    function loadModule(string $moduleName): bool
    {
        return (bool)Loader::includeModule($moduleName);
    }
}

if (!function_exists('cacheKey')) {
    /**
     * Ключ кеша
     *
     * @param array $data
     * @return string
     */
    function cacheKey(array $data): string
    {
        return md5(
            json_encode($data)
        );
    }
}

if (!function_exists('bxUser')) {
    /**
     * Объект локального пользователя
     *
     * @return CUser
     */
    function bxUser(): CUser

The type CUser was not found. Maybe you did not declare it correctly or list all dependencies?

    {
        global $USER;
        return $USER;
    }
}

if (!function_exists('getIblockId')) {
    /**
     * Идентификатор инфоблока
     *
     * @param string $code
     * @param string|null $iblockType
     * @return integer|null
     */
    function getIblockId(string $code, $iblockType = null, int $minutes = 0)
    {
        IblockHelper::setCacheTime($minutes);
        return IblockHelper::getIblockID($code, $iblockType);
    }
}

if (!function_exists('getHlBlock')) {
    /**
     * Информация о HL блоке
     *
     * @param string $code
     * @param integer $minutes
     * @return array|null
     */
    function getHlBlock(string $code, $minutes = 0)
    {
        HlBlockHelper::setCacheTime($minutes);
        return HlBlockHelper::getHlblock($code);
    }
}

if (!function_exists('getHlBlockClass')) {
    /**
     * Класс для работы с HL блоком
     *
     * @param string $code
     * @param integer $minutes
     * @return DataManager|null
     */
    function getHlBlockClass(string $code, $minutes = 0)
    {
        HlBlockHelper::setCacheTime($minutes);
        return HlBlockHelper::getHlblockClass($code);
    }
}

if (!function_exists('taggedCache')) {
    /**
     * Тэггированный кеш
     *
     * @return TaggedCache
     */
    function taggedCache(): TaggedCache
    {
        return appInstance()->getTaggedCache();
    }
}

if (!function_exists('initTagCache')) {
    /**
     * Инициализация тэггированного кеша
     *
     * @param array $tags
     * @param string $cacheDir
     * @return void
     */
    function initTagCache(array $tags, string $cacheDir = '/')
    {
        taggedCache()->startTagCache($cacheDir);
        foreach ($tags as $tag) {
            taggedCache()->registerTag($tag);
        }
        taggedCache()->endTagCache();
    }
}

if (!function_exists('cache')) {
    /**
     * Кеширование
     *
     * @param integer $minutes
     * @param string $key
     * @param string $initDir
     * @param string $baseDir
     * @param callable $func
     * @return mixed
     */
    function cache(int $minutes, string $key, $initDir = '/', string $baseDir = 'cache', callable $func)
    {
        $data = null;
        $ttl = $minutes * 60;
        $cache = Cache::createInstance();
        if ($cache->initCache($ttl, $key, $initDir, $baseDir)) {
            $data = $cache->getVars();
        } elseif ($cache->startDataCache($ttl, $key, $initDir, [], $baseDir)) {
            try {
                $data = $func();
                $cache->endDataCache($data);
            } catch (Exception $e) {
                $cache->abortDataCache();
                taggedCache()->abortTagCache();
            }
        }

        return $data;
    }
}

if (!function_exists('cleanCache')) {
    /**
     * Отчистка кеша
     *
     * @param string $key
     * @param string $initDir
     * @param string $baseDir
     * @return void
     */
    function cleanCache(string $key, $initDir = '/', string $baseDir = 'cache')
    {
        $cache = Cache::createInstance();
        $cache->clean($key, $initDir, $baseDir);
    }
}

if (!function_exists('setCacheData')) {
    /**
     * Зписать данные в кеш (с предварительной отчисткой)
     *
     * @param integer $minutes
     * @param string $key
     * @param string $initDir
     * @param string $baseDir
     * @param [type] $data

The doc comment [type] at position 0 could not be parsed: Unknown type name '[' at position 0 in [type].

     * @return void
     */
    function setCacheData(int $minutes, string $key, $initDir = '/', string $baseDir = 'cache', $data)
    {
        cleanCache($key, $initDir, $baseDir);
        cache($minutes, $key, $initDir, $baseDir, function () use ($data) {
            return $data;
        });
    }
}

if (!function_exists('initEditIblockElement')) {
    /**
     * Область редактирования элемента инфоблока
     *
     * @param CBitrixComponentTemplate $tpl
     * @param integer $elementId
     * @param integer $iblockId
     * @param string $iblockType
     * @param string $description
     * @return string
     */
    function initEditIblockElement(CBitrixComponentTemplate $tpl, int $elementId, int $iblockId, string $iblockType, string $description = null): string

The type CBitrixComponentTemplate was not found. Maybe you did not declare it correctly or list all dependencies?

    {
        $link = '/bitrix/admin/iblock_element_edit.php?IBLOCK_ID=' . $iblockId . '&type=' . $iblockType . '&ID=' . $elementId . '&lang=ru&force_catalog=&filter_section=0&bxpublic=Y&from_module=iblock';
        if (is_null($description)) {
            $description = "Редактировать элемент";
        }

        $tpl->AddEditAction($elementId, $link, $description);

        return (string)$tpl->GetEditAreaId($elementId);
    }
}

if (!function_exists('initEditIblockSection')) {
    /**
     * Область редактирования раздела инфоблока
     *
     * @param CBitrixComponentTemplate $tpl
     * @param integer $sectionId
     * @param integer $iblockId
     * @param string $iblockType
     * @param string $description
     * @return string
     */
    function initEditIblockSection(CBitrixComponentTemplate $tpl, int $sectionId, int $iblockId, string $iblockType, string $description = null): string
    {
        $link = '/bitrix/admin/iblock_section_edit.php?IBLOCK_ID=' . $iblockId . '&type=' . $iblockType . '&ID=' . $sectionId . '&lang=ru&find_section_section=0&bxpublic=Y&from_module=iblock';
        if (is_null($description)) {
            $description = "Редактировать раздел";
        }

        $tpl->AddEditAction($sectionId, $link, $description);

        return (string)$tpl->GetEditAreaId($sectionId);
    }
}

if (!function_exists('initEditHLBlockElement')) {
    /**
     * Область редактирования элемента HL блока
     *
     * @param CBitrixComponentTemplate $tpl
     * @param integer $elementId
     * @param string $hlBlockName
     * @param string $description
     * @return string
     */
    function initEditHLBlockElement(CBitrixComponentTemplate $tpl, int $elementId, string $hlBlockName, string $description = null): string
    {
        $hlBlock = getHlBlock($hlBlockName);
        if (empty($hlBlock)) {
            return '';
        }

        $link = '/bitrix/admin/highloadblock_row_edit.php?ENTITY_ID=' . $hlBlock['ID'] . '&ID=' . $elementId . '&bxpublic=Y';
        if (is_null($description)) {
            $description = "Редактировать элемент";
        }

        $tpl->AddEditAction($elementId, $link, $description);

        return (string)$tpl->GetEditAreaId($elementId);
    }
}

if (!function_exists('initComponent')) {
    /**
     * Инициализация компонента
     *
     * @param string $name
     * @param string $template
     * @param array $params
     * @param mixed $parentComponent
     * @param array $functionParams
     * @return ComponentHelper
     */
    function initComponent(string $name, string $template = '', array $params = [], $parentComponent = null, $functionParams = []): ComponentHelper
    {
        return new ComponentHelper($name, $template, $params, $parentComponent, $functionParams);
    }
}

if (!function_exists('includeArea')) {
    /**
     * Включаемая область
     *
     * @param string $path
     * @param string|null $folder
     * @return void
     */
    function includeArea(string $path, $basePath = null)
    {
        if (is_null($basePath)) {
            $basePath = bxApp()->GetTemplatePath('') . 'include';
        }

        initComponent('bitrix:main.include')
            ->setTemplate('.default')
            ->setParams([
                "AREA_FILE_SHOW" => "file",
                "AREA_FILE_SUFFIX" => "inc",
                "AREA_FILE_RECURSIVE" => "Y",
                "EDIT_TEMPLATE" => "",
                "COMPONENT_TEMPLATE" => ".default",
                "PATH" => "{$basePath}/{$path}",
            ])
            ->show();
    }
}

if (!function_exists('sendJsonResponse')) {
    /**
     * Ответ в формате json
     *
     * @param array $data
     * @param integer $statusCode
     * @return void
     */
    function sendJsonResponse(array $data, int $statusCode)
    {
        bxApp()->RestartBuffer();
        http_response_code($statusCode);
        header('Content-Type: application/json');
        echo json_encode($data);
        die();
    }
}

/**
 * Инициализация констант с идентификаторами инфоблоков
 *
 * @param integer $caheMinutes
 * @return void
 */
function initIBConstantList(int $caheMinutes)
{
    IblockHelper::setCacheTime($caheMinutes);
    $list = IblockHelper::getListIblock();
    foreach ($list as $iblock) {
        define('IBLOCK_' . strtoupper($iblock['CODE']), $iblock['ID']);
    }
}

/**
 * Объект запроса
 *
 * @return HttpRequest
 */
function bxRequest(): HttpRequest
{
    return appInstance()->getContext()->getRequest();
}