Абстрактный класс: CacheControl

Краткое содержание:

Абстрактный класс для реализации управления кэшированием.

Описание:

Определяет контракт для классов, управляющих различными аспектами кэш-контроля, такими как загрузка конфигурации, миграция или работа с файлами конфигурации.

Может быть дополнен реализацией в наследниках для поддержки специфичных стратегий кэширования.

Свойства

• private $path

Методы

• public clearCache()
• public getCache()
• public getPath()
• public init()
• public setCache()
• public setPath()

Подробности

• Путь: engine/inc/maharder/_includes/classes/CacheControl.php

Свойства

private $path : ?string

Краткое содержание

Определяет путь до кеша.

Описание

Используется для хранения или извлечения пути, где будут сохраняться данные кеша. Значение может быть null, если путь не был задан.

Тип: Текст или null

Подробности:

• Смотри так-же:
  • Для получения текущего пути.
  • Для задания пути.

Tags

Методы

clearCache

static public clearCache(string|array  type = "all") : void

Краткое содержание

Очищает кеш для указанного типа или списка типов.

Описание

Работает по следующему алгоритму:

• Если передан строковый тип и значение "all", очищается вся директория кеша.
• Если передан массив типов, очистка выполняется рекурсивно для каждого типа.
• В случае конкретного типа, очищается соответствующий подкаталог.

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

• \CacheControl::init()
• \DataManager::deleteDir()
• \DataManager::toTranslit()
• \CacheControl::getPath()

Свойства:

Ошибки:

Возвращает:

void

Функция ничего не возвращает.

getCache

static public getCache(string  type, string  name) : false|array|int

Краткое содержание

Получает данные из кеша, преобразуя имена и типы в транслит и извлекая содержимое файла с последующим декодированием данных из JSON.

Описание

Инициализирует путь к кешу, если он не был установлен ранее. Данные извлекаются из файла с учетом типа и имени, которые преобразуются в транслит. Если файл отсутствует или недоступен, функция возвращает false. Если данные присутствуют, они декодируются из формата JSON и в случае ошибки выбрасывается исключение JsonException.

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

• \DataManager::toTranslit()
• \DataManager::normalizePath()
• \LogGenerator::generateLog()

Свойства:

Ошибки:

Возвращает:

false|array|int

Возвращает массив данных, число или false в случае ошибки.

getPath

static public getPath() : string|null

Краткое содержание

Возвращает текущий путь, если он установлен.

Возвращает:

string|null

Возвращает путь как строку, либо null, если путь не установлен.

init

static public init(string|null  path = null) : void

Краткое содержание

Инициализирует систему, устанавливая путь для кэша.

Описание

Функция получает конфигурацию с помощью DataManager::getConfig(), определяет путь для хранения кэша (приоритет отдается переданному аргументу $path, затем значению из конфигурации, в последнюю очередь используется стандартный путь), нормализует его и устанавливает через self::setPath().

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

• \DataManager::normalizePath()
• \DataManager::getConfig()
• \CacheControl::setPath()

Свойства:

Ошибки:

Возвращает:

void

setCache

static public setCache(string  type, string  name, mixed  data) : void

Краткое содержание

Сохраняет данные в кэше путем создания файла с содержимым в JSON-формате.

Описание

Функция выполняет следующие действия:

• Преобразует имя и тип кэша в транслитерацию для формирования имени файла и пути директории.
• Проверяет и создает директорию, если она отсутствует.
• Сериализует переданные данные в JSON и записывает их в файл.
• Логирует возможные ошибки сериализации и записи данных.

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

• \DataManager::toTranslit()
• \DataManager::normalizePath()
• \DataManager::createDir()
• \LogGenerator::generateLog()

Свойства:

Ошибки:

Возвращает:

void

setPath

static public setPath(string  path) : void

Краткое содержание

Устанавливает значение переменной пути.

Описание

Метод задаёт значение для статической переменной $path, которая может быть использована для хранения пути.

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

• \CacheControl::$path

Свойства:

Возвращает:

void