Удалить кеш каталога Cache::cleanDir

Модуль: main — подключать отдельно не нужно

Метод Cache::cleanDir удаляет весь кеш каталога, в том числе вложенных каталогов. Метод нужен после изменения данных, от которых зависит кеш, например после добавления записи.

Сигнатура метода в классе Bitrix\Main\Data\Cache:

public function cleanDir($initDir = false, $baseDir = 'cache')

Параметры

Параметр Тип Описание
initDir string или false Задает каталог кеша, например /units. По умолчанию — false
baseDir string Задает корневой каталог кеша. По умолчанию — cache

Типы в таблице описывают назначение аргументов. Сигнатура PHP не объявляет их.

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

Метод ничего не возвращает.

Особенности

  • Без каталога, то есть с false или пустой строкой, метод удаляет весь кеш в baseDir. Не вызывайте метод без аргумента, если нужно удалить кеш одного раздела.
  • Файловый механизм удаляет каталог отложенно. Метод переименовывает каталог в <каталог>.~<число>, а ядро удаляет его позже. Метод initCache сразу перестает находить кеш.

Примеры

Пример. Код удаляет весь кеш каталога /units после изменения данных:

<?php
use Bitrix\Main\Data\Cache;

require $_SERVER['DOCUMENT_ROOT'] . '/bitrix/modules/main/include/prolog_before.php';

$cache = Cache::createInstance();
$cache->startDataCache(3600, 'units_list', '/units');
$cache->endDataCache(['kg']);

Cache::createInstance()->cleanDir('/units');

var_dump(Cache::createInstance()->initCache(3600, 'units_list', '/units'));

Код выведет bool(false).

Смотрите также