CacheEngineInterface::write() — параметры и описание

Сигнатура

public write(mixed $vars, string $baseDir, string $initDir, string $filename, int $ttl) : void

Описание

Записывает значение в кеш по ключу.

Параметры

$vars mixed

Кешированный результат.

$baseDir string

Базовый каталог кеша (обычно /bitrix/cache).

$initDir string

Каталог внутри базового.

$filename string

Имя файла.

$ttl int

Период истечения срока действия в секундах.

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

void

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

CacheEngineInterface::write() — метод интерфейса \Bitrix\Main\Data\CacheEngineInterface модуля «Главный модуль».

Метод объекта: сначала нужен объект, реализующий CacheEngineInterface.

use Bitrix\Main\Data\CacheEngineInterface;

/** @var CacheEngineInterface $object */
$vars = null;
$baseDir = '';
$initDir = '';
$filename = '';
$ttl = 1;
$object->write($vars, $baseDir, $initDir, $filename, $ttl);

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

clean() Очищает (удаляет) значение из кеша по ключу (каталог или файл).
isAvailable() Возвращает true, если кеш может быть прочитан или записан.
isCacheExpired() Возвращает true, если срок действия файла кеша истёк.
read() Читает значение из кеша. Возвращает true, если значение существует, не истекло и успешно прочитано.

write() есть и у других классов модуля «Главный модуль»: Asset, CacheEngineApc, CacheEngineFiles, CacheEngineInterface, CacheEngineMemcache, CacheEngineMemcached, CacheEngineNone, CacheEngineRedis.