Два разных вида кеширования в компонентах
В большинстве стандартных компонентов битрикс используется одновременно кеширование массива $arResult и html-кода. Однако при написании собственных компонентов это не всегда бывает удобным, часто бывает, что в шаблоне необходимо выполнять какой-то код на каждом хите, поэтому кешировать лучше только данные в $arResult. Ниже я привел 2 примера кеширования (для component.php) - с кешированием html-кода и без. Обратите внимание, во втором варианте подключение шаблона производится после блока кеширования, а его место занимает $this->EndResultCache().
[spoiler]
Кеширование $arResult и html-кода шаблона:
if($this->startResultCache(false, array(($arParams["CACHE_GROUPS"]==="N"? false: $USER->GetGroups()))))
{
if(!Loader::includeModule("iblock"))
{
$this->abortResultCache();
ShowError("Iblock module not installed");
return;
}
$this->includeComponentTemplate();
}
|
if($this->startResultCache(false, array(($arParams["CACHE_GROUPS"]==="N"? false: $USER->GetGroups()))))
{
if(!Loader::includeModule("iblock"))
{
$this->abortResultCache();
ShowError("Iblock module not installed");
return;
}
$this->EndResultCache();
}
$this->includeComponentTemplate();
|
Добавляем данные к кешу из шаблона для использования в component_epilog.php
Component_epilog.php - это файл, который запускается после вывода шаблона, и не кешируется, т.е. он запускается независимо от того, был показан только что созданный html-код из шаблона или вывод из кеша. Соответственно мы можем использовать этот файл для выполнения каких-то действий на каждом хите, даже, например, выводить html-код выше на странице, используя отложенные функции. Но данные, доступные в component_epilog.php, как правило весьма ограничены в компонентах, использующих html-кеширование. В данном примере я покажу, как расширить перечень этих данных, для этого мы вставим следующий код в файл result_modifier.php в шаблоне компонета (Для примера используется ключ «ITEMS" в массиве $arResult, содержащий в компоненте "bitrix:news.list" основной массив данных):
if (is_object($this->__component))
{
$this->__component->SetResultCacheKeys(array('ITEMS'));
if (!isset($arResult['ITEMS']))
$arResult['ITEMS'] = $this->__component->arResult['ITEMS'];
}
|
Иногда в файлах шаблона комплексного компонента (которые не имеют своего кеша) удобно иметь некоторые данные из используемых в них обычных (некомлексных) компонентов. Пример: после подключения компонента catalog.section.list нам в соответствии со структурой html-кода, предоставленного верстальщиком, требуется доступ к некоторым полям раздела именно в шаблоне комплексного компонента. Чтобы избежать дополнительных запросов к базе и связанного с этим неизбежного кеширования, или повторного подключения компонента catalog.section.list, сделаем так:
Добавим к кешу компонента все необходимые данные, например, используем файл result_modifier.php чтобы добавить массив $arResult["SECTION"]
if (is_object($this->__component))
{
$this->__component->SetResultCacheKeys(array('SECTION'));
if (!isset($arResult['SECTION']))
$arResult['SECTION'] = $this->__component->arResult['SECTION'];
}
|
В файле component_epilog.php получим объект родительского компонента, если он доступен, и воспользуемся его свойством arResult для записи значения
if(is_object($this->__parent))
if($this->__parent->arResult)
$this->__parent->arResult["SECTION_DEPTH_LEVEL"] = $arResult["SECTION"]["DEPTH_LEVEL"];
|
В шаблоне комплексного компонента значение будет доступно в переменной $arResult
$arResult["SECTION_DEPTH_LEVEL"]
|
Если требуется произвести какие-то манипуляции с данными уже после создания кеша (пример - сортировка списка офисов по удаленности от текущего местоположения), то обычное кеширование html-кода в компоненте news.list не подойдет. Чтобы кешировались данные в $arResult, а не созданный html-код, можно поступить следующим образом:
Используем файл result_modifier.php чтобы добавить массив $arResult["ITEMS"]
if (is_object($this->__component))
{
$this->__component->SetResultCacheKeys(array('ITEMS'));
if (!isset($arResult['ITEMS']))
$arResult['ITEMS'] = $this->__component->arResult['ITEMS'];
}
|
Сам вывод шаблона разместим не в template.php, а в component_epilog.php (при этом даже после создания кеша нам будет доступен массив $arResult["ITEMS"] ).
Избавляемся от сообщения "Cannot find '' template with page ''"
Это загадочное сообщение возникает, если указанный шаблон при подключении компонента не найден. Однако, бывают случаи (правда, достаточно экзотические), когда это сообщение может быть неуместным. Чтобы при отсутствии шаблона компонент не выдавал данное сообщение, а возвращал false, подключим внутри компонента шаблон вместо стандартного «$this->IncludeComponentTemplate();» следующим образом
if (!$this->__bInited)
return false;
if ($this->InitComponentTemplate("", $this->siteTemplateId, ""))
{
$this->showComponentTemplate();
if($this->__component_epilog)
$this->includeComponentEpilog($this->__component_epilog);
return true;
}
else
{
return false;
}
|
Очень частый случай. Далеко не у всех компонентов полезно разрешать править их параметры, особенно если вызов компонента находится в файлах header.php, footer.php и пр. Для запрещения редактирования параметров компонента в режиме правки, в пятом параметре функции «$APPLICATION->IncludeComponent» нужно вставить следующий массив:
Узнаем папку шаблона Внутри шаблона
Внутри resullt_modifier.php
$component = $this->__component;
if(is_object($component)) {
$template = &$component->GetTemplate();
$template_folder = $template->GetFolder();
}
|
Внутри компонента (только после «$this->IncludeComponentTemplate();» или «$this->InitComponentTemplate();»)
$template = &$this->GetTemplate();
$resource_path = $template->GetFolder();
|
09.09.201515:5209.09.2015 15:52:42
