Cache — кеширование данных и вывода
Пространство имен: Bitrix\Main\Data
Модуль: main — подключать отдельно не нужно
Доступно с версии: 12.0.7
Когда использовать
Класс Cache сохраняет в кеш результат фрагмента кода — данные и HTML-вывод — и возвращает их при следующих запросах, пока не истечет время жизни кеша. Секция cache файла .settings.php задает механизм хранения — файлы, Redis, Memcache или APCu.
Метод createInstance создает объект. Работа с кешем идет в три шага.
- Метод initCache проверяет, есть ли действующий кеш по ключу.
- Если кеш есть, метод getVars возвращает данные, а output выводит сохраненный HTML.
- Если кеша нет, методы startDataCache и endDataCache сохраняют новые данные.
Метод cleanDir удаляет кеш целого каталога, например после изменения данных.
Аналог в классическом API — класс CPHPCache.
Подробнее — в статье Кеширование.
Метод clearCache устарел. Если передать ему true или каталог, метод вызывает cleanDir. Без аргументов метод ничего не удаляет. Для нового кода используйте cleanDir.
Методы класса
| Метод | Описание | С версии |
|---|---|---|
| createInstance | Создает объект кеша с механизмом хранения из настроек | |
| __construct | Создает объект кеша с переданным механизмом хранения | |
| initCache | Проверяет кеш по ключу и читает его | |
| getVars | Возвращает данные из кеша | |
| output | Выводит HTML из кеша | |
| noOutput | Отключает перехват и вывод HTML | |
| startDataCache | Начинает запись кеша или выводит готовый кеш | |
| endDataCache | Сохраняет данные и HTML в кеш | |
| abortDataCache | Отменяет запись кеша | |
| isStarted | Проверяет, идет ли запись кеша | |
| forceRewriting | Включает перезапись кеша без чтения | 14.0.2 |
| clean | Удаляет кеш по ключу | |
| cleanDir | Удаляет кеш каталога | |
| isCacheExpired | Проверяет, истек ли кеш по пути к файлу | |
| getPath | Возвращает путь к файлу кеша по ключу | |
| getSalt | Возвращает часть каталога кеша по имени скрипта | |
| createCacheEngine | Создает механизм хранения из настроек | |
| getCacheEngineType | Возвращает тип механизма хранения | |
| shouldClearCache | Проверяет, нужно ли пропустить чтение кеша | 14.0.2 |
| setClearCache | Пропускает чтение кеша на этом запросе | |
| setClearCacheSession | Пропускает чтение кеша до конца сессии | |
| setShowCacheStat | Включает сбор статистики кеша | |
| getShowCacheStat | Проверяет, включен ли сбор статистики |
Смотрите также
Была ли статья полезна?
Предыдущая
Следующая