method public final

GridComponent::startResultCache()

Класс: \Bitrix\Main\Grid\Component\GridComponent

Сигнатура

public final startResultCache([int|bool $cacheTime = false ][, mixed $additionalCacheID = false ][, string|bool $cachePath = false ]) : string

Описание

Функция запускает блок кеширования при выполнении компонента.

Параметры

$cacheTime int|bool = false

$additionalCacheID mixed = false

$cachePath string|bool = false

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

string

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

GridComponent::startResultCache() — метод класса \Bitrix\Main\Grid\Component\GridComponent модуля «Главный модуль».

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

use Bitrix\Main\Grid\Component\GridComponent;

/** @var GridComponent $object */
$result = $object->startResultCache();
// $result: string

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

__prepareComponentParams() Вспомогательная функция для безопасного html-экранирования параметров компонента.
__showError() Функция показывает сообщение о внутренней ошибке.
abortResultCache() Функция прерывает кеш после его старта.
addChildCSS() Функция регистрирует дочерний css-файл для кеширования.
addChildEpilog() Функция регистрирует дочерний файл эпилога для кеширования.
addChildFrame() Регистрирует дочерний фрейм для кеширования.
addChildJS() Функция регистрирует дочерний js-файл для кеширования.
addDeleteAction() Функция добавляет действие удаления в некоторую область внутри компонента.
addEditAction() Функция добавляет действие редактирования в некоторую область внутри компонента.
addEditButton() Функция добавляет кнопку для отображения.
addIncludeAreaIcon() Функция добавляет иконку в область компонента в режиме редактирования.
addIncludeAreaIcons() Функция заменяет иконки, отображаемые для компонента, коллекцией.

startResultCache() есть и у других классов модуля «Главный модуль»: TabletGridComponent.

Исходный файл: source/main/lib/grid/component/gridcomponent.php:904