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

Сигнатура

public read(mixed &$vars, string $baseDir, string $initDir, string $filename, int $ttl) : bool

Описание

Читает значение из кеша. Возвращает true, если значение существует, не истекло и успешно прочитано.

Параметры

$vars mixed

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

$baseDir string

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

$initDir string

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

$filename string

Имя файла.

$ttl int

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

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

bool

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

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

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

use Bitrix\Main\Data\CacheEngineInterface;

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

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

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

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