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

Сигнатура

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

Описание

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

Параметры

$vars mixed

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

$baseDir mixed

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

$initDir mixed

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

$filename mixed

Имя файла.

$ttl mixed

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

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

bool

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

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

Метод объекта: сначала нужен экземпляр CacheEngineFiles.

use Bitrix\Main\Data\CacheEngineFiles;

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

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

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

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