method
public
CacheEngineInterface::clean()
Сигнатура
public clean(string $baseDir[, string $initDir = false ][, string $filename = false ]) : voidОписание
Очищает (удаляет) значение из кеша по ключу (каталог или файл).
Параметры
$baseDir
string
Базовый каталог кеша (обычно /bitrix/cache).
$initDir
string
= false
Каталог внутри базового.
$filename
string
= false
Имя файла.
Возвращаемое значение
void
Как применяется в CacheEngineInterface
CacheEngineInterface::clean() — метод интерфейса \Bitrix\Main\Data\CacheEngineInterface модуля «Главный модуль».
Метод объекта: сначала нужен объект, реализующий CacheEngineInterface.
use Bitrix\Main\Data\CacheEngineInterface;
/** @var CacheEngineInterface $object */
$baseDir = '';
$object->clean($baseDir);Другие методы CacheEngineInterface
isAvailable()Возвращает true, если кеш может быть прочитан или записан.isCacheExpired()Возвращает true, если срок действия файла кеша истёк.read()Читает значение из кеша. Возвращает true, если значение существует, не истекло и успешно прочитано.write()Записывает значение в кеш по ключу.
clean() есть и у других классов модуля «Главный модуль»: Cache, CacheEngineApc, CacheEngineFiles, CacheEngineMemcache, CacheEngineMemcached, CacheEngineNone, CacheEngineRedis, CacheEngineRedisLight.
Исходный файл: source/main/lib/data/cacheengineinterface.php:22
