Класс: DataLoader
Документация по плагину класс: dataloader для DLE.
Краткое содержание:
Трейт для загрузки данных с использованием кеша или базы данных.
Описание:
Обеспечивает базовые операции с данными, такие как загрузка, сохранение или обновление с интеграцией в систему кеширования и базу данных. Использование: Подключите этот трейт к классу для получения базовой функциональности работы с данными.
Свойства
- private $cache_folder
- private $prefix
Методы
- public clear_cache()
- public get_cache()
- public getCacheFolder()
- public getPrefix()
- public load_data()
- public setCacheFolder()
- public setPrefix()
- private set_cache()
Подробности
- Путь: engine/inc/maharder/_includes/traits/DataLoader.php
Свойства
private $cache_folder : string
Краткое содержание
Папка кеша
Тип: Текст
private $prefix : ?string
Тип: Текст или null
Методы
clear_cache
public clear_cache(string type = "all") : voidКраткое содержание
Очищает кеш указанного типа.
Описание
Метод позволяет очистить кеш для переданного типа или полностью, если тип "all". Использует внутренний метод CacheControl::clearCache для выполнения операции очистки.
Смотри так-же:
Свойства:
| Название | Тип | По умолчанию |
|---|---|---|
| $type | string | 'all' |
Возвращает:
voidget_cache
public get_cache(string type, string name) : array|falseКраткое содержание
Получает кешированные данные для заданного типа и имени.
Описание
Метод использует статический метод CacheControl::getCache(), чтобы получить данные из файловой системы.
Смотри так-же:
Свойства:
| Название | Тип | По умолчанию |
|---|---|---|
| $type | string | |
| $name | string |
Ошибки:
| Тип | Описание |
|---|---|
| \JsonException |
Возвращает:
array|falseВозвращает массив декодированных данных, если файл кеша успешно найден и данные корректны,
или false, если произошла ошибка (например, файл не найден или данные некорректны).
getCacheFolder
public getCacheFolder() : stringВозвращает:
stringgetPrefix
public getPrefix() : stringКраткое содержание
Возвращает префикс для использования в SQL-запросах.
Описание
Метод проверяет, установлен ли префикс. Если префикс не задан, он вызывает метод setPrefix(),
чтобы установить его значение. Затем возвращает установившийся префикс.
Смотри так-же:
Возвращает:
stringПрефикс, используемый для построения SQL-запросов.
load_data
public load_data(string name, mixed ..._vars) : arrayКраткое содержание
Метод загружает данные из базы данных с использованием механизма кеширования.
Описание
Если данные уже закешированы, то они возвращаются из кеша, иначе выполняется запрос к базе данных, формируется кеш и результат сохраняется на диск.
Смотри так-же:
- \DataManager::getDb()
- \DataManager::nameArgs()
- \DataManager::getComparer()
- \DataManager::getConfig()
Свойства:
| Название | Тип | По умолчанию |
|---|---|---|
| $name | string | |
| $_vars | mixed |
Ошибки:
| Тип | Описание |
|---|---|
| \JsonException | В случае JSON-ошибок при работе с кешем. |
Возвращает:
arrayРезультат выборки из базы данных, либо из кеша.
setCacheFolder
public setCacheFolder(string cache_folder) : voidСвойства:
| Название | Тип | По умолчанию |
|---|---|---|
| $cache_folder | string |
Возвращает:
voidsetPrefix
public setPrefix(string|null name = null) : voidКраткое содержание
Устанавливает префикс для использования в загрузке данных.
Описание
Если переданное имя соответствует значениям "users" или "usergroup",
то префикс устанавливается в значение константы USERPREFIX.
В противном случае используется значение по умолчанию из константы PREFIX.
Свойства:
| Название | Тип | По умолчанию |
|---|---|---|
| $name | string|null | null |
Возвращает:
voidset_cache
private set_cache(string type, string name, mixed data) : voidКраткое содержание
Сохраняет данные в кеш.
Описание
Метод записывает данные в кеш, используя указанный тип и имя.
Для сохранения данных вызывается метод CacheControl::setCache, который
обрабатывает директорию и имя файла, записывает данные в формате JSON
и устанавливает необходимые права доступа к файлу.
Смотри так-же:
Свойства:
| Название | Тип | По умолчанию |
|---|---|---|
| $type | string | |
| $name | string | |
| $data | mixed |
Ошибки:
| Тип | Описание |
|---|---|
| \JsonException |
Возвращает:
void