DevCraft Документации
УстаревшееMH Admin (Legacy)Back-EndClasses

Класс: DleData

Документация по плагину класс: dledata для DLE.

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

Трейт DleData предоставляет методы для работы с дополнительными данными (xfields), пользователями, группами, категориями и другими сущностями в контексте системы управления данными.

Описание:

Основные функции:

  • Загрузка, получение и обработка дополнительных полей (xfields) для постов и пользователей.
  • Управление данными пользователей, групп, категорий и их настройками.
  • Интеграция с кешированием для повышения производительности. Преимущества:
  • Использование кеша для уменьшения количества запросов к базе данных.
  • Гибкость в управлении динамическими полями и других данных. Применения:
  • Подходит для случаев, где требуется работать с различными сущностями (статьи, пользователи и т.д.) с поддержкой дополнительных параметров. Свойства:
  • $postXfieldKeys: Список ключей конфигурации для дополнительных полей новостей (настраиваемых полей).
  • $userXfieldKeys: Список ключей конфигурации для дополнительных полей пользователей. Методы:
  • load_data: Универсальный метод для выполнения SQL-запросов к базе данных с поддержкой кеширования.
  • get_used_xfields: Извлекает и возвращает дополнительные поля объекта (поста или пользователя).
  • loadXfields: Загружает дополнительные поля из конфигурационных файлов.
  • getXfieldInfo: Предоставляет информацию о конкретном поле на основе его имени.
  • Другие методы позволяют управлять пользователями, группами и категориями.

Свойства


Методы


Подробности

  • Путь: engine/inc/maharder/_includes/traits/DleData.php

Свойства

protected $postXfieldKeys : array


Тип: Массив

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

КлючПозиция в массивеОписание
name0системное имя поля
description1описание поля
category2Разрешённые категории
type3тип поля
default4Значения по умолчанию
is_required5обязательное поле (1 или 0)
is_link6Перекрёстные ссылки (1 или 0)
use_editor7Подключать редактор при добавлении или редактировании публикаций для данного поля
is_safe8Безопасный режим поля (отключение BB тегов и HTML)
image_max_size9Максимальные размеры оригинального изображения
image_max_file_size10Максимальный вес изображения
use_watermark11Наложить водяные знаки
image_create_min12Создать уменьшенную копию
image_min_size13Размеры уменьшенной копии
file_ext14Расширения файлов, допустимых к загрузке
file_max_file_size15Максимальный размер файла допустимый к загрузке на сервер (в килобайтах)
gallery_max_images16Максимальное кол-во изображений
yesno_enabled17Значение по умолчанию для поля да/нет
hint18Подсказка
groups_allow_add19Разрешить добавление для групп
groups_allow_view20Разрешить просмотр для групп
separator21Разделитель
image_min_file_size22Минимальные размеры изображения для загрузки
datetime_type23Формат заполнения
datetime_format24Формат вывода даты
datetime_localize25Локализовывать дату при выводе на сайте
datetime_decline26Склонять дату при выводе на сайте
is_public27Загружать файл как публичный
allow_template28Разрешить вставку тега вывода данного поля в текст новостей
use_opengraph29Использовать изображение в разметке Open Graph
lazy_load30Отложенная загрузка изображений
video_max_files31Количество загружаемых файлов
video_max_file_size32Максимальный размер файла допустимый к загрузке на сервер (в килобайтах)
storage33Хранилище загрузок
select_multiple34Разрешить выбор нескольких значений
select_separator35разделитель для поля "Список"
min_chars36Минимальное количество символов в поле
max_chars37Максимальное количество символов в поле
image_max_size_side38По которой стороне определять максимальный размер оригинального изображения
image_min_size_side39По которой стороне определять размер уменьшенной копии изображения

protected $userXfieldKeys : array


Тип: Массив

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

КлючПозиция в массивеОписание
name0системное имя поля
description1описание поля
registration_page2отображать на странице регистрации
type3тип поля
allow_change4Поле может быть изменено пользователем
is_private5Личное поле
default_value6Значение по умолчанию
is_save7Безопасный режим поля (отключение BB тегов и HTML)

Методы

get_used_xfields

public get_used_xfields(int  id, string  type = "post") : array|bool
Краткое содержание

Возвращает массив с дополнительными полями, использованными в объекте, либо false, если данные отсутствуют.

Описание

Метод извлекает данные из базы данных для указанного объекта (поста или пользователя) и преобразует строку с дополнительными полями в массив с ключами и их значениями.

Смотри так-же:
Свойства:
НазваниеТипПо умолчанию
$idint
$typestring"post"
Ошибки:
ТипОписание
\JsonExceptionИсключение выбрасывается, если произошла ошибка при работе с JSON.
Возвращает:
array|bool

Возвращает массив дополнительных полей объекта в формате ключ => значение, либо false, если данные отсутствуют.


getCats

public getCats() : array
Краткое содержание

Возвращает список категорий в виде ассоциативного массива, где ключом является ID категории, а значением — её название.

Описание

Метод загружает данные из базы данных, используя метод load_data, и сортирует их по названию категории в алфавитном порядке. В результате возвращается массив с ID категорий в качестве ключей и названиями категорий в качестве значений.

Смотри так-же:
Ошибки:
ТипОписание
\JsonException
Возвращает:
array

Ассоциативный массив категорий, где ключ — ID категории, а значение — её название.


getUser

public getUser(int|null  id = null, string|null  uname = null) : array|false
Краткое содержание

Получает данные пользователя по ID или имени пользователя.

Описание

Если ни идентификатор пользователя, ни имя пользователя не переданы, метод возвращает false. В противном случае выполняется поиск данных в таблице users с использованием указанного критерия.

Смотри так-же:
Свойства:
НазваниеТипПо умолчанию
$idint | nullnull
$unamestring | nullnull
Ошибки:
ТипОписание
\JsonException
Возвращает:
array|false

Ассоциативный массив с данными о пользователе, если пользователь найден. Возвращает false, если пользователь не найден или если критерии поиска не заданы.


getUserGroups

public getUserGroups() : array
Краткое содержание

Получает список групп пользователей в формате массива с идентификаторами и именами групп.

Описание

Метод обращается к функции load_data для загрузки данных о группах пользователей из таблицы "usergroups" с выборкой полей id и group_name, затем преобразует результат в ассоциативный массив с ключами — идентификаторами групп, и значениями — именами групп, отсортированными по названию группы в алфавитном порядке (ASC).

Смотри так-же:
Ошибки:
ТипОписание
\JsonException
Возвращает:
array

Ассоциативный массив, где ключ — идентификатор группы, значение — имя группы.


getUsers

public getUsers() : array
Краткое содержание

Возвращает список пользователей из базы данных.

Описание

Метод загружает данные о пользователях, используя метод load_data, и возвращает массив, где ключами являются идентификаторы пользователей, а значениями — их имена, отсортированные в алфавитном порядке.

Смотри так-же:
Ошибки:
ТипОписание
\JsonException
Возвращает:
array

Ассоциативный массив пользователей, где ключи — идентификаторы пользователей (user_id), а значения — их имена.


getXfieldInfo

public getXfieldInfo(string  name, string  type = "post") : array|null
Краткое содержание

Возвращает информацию о дополнительном поле (xfield) на основании его имени и типа.

Смотри так-же:
Свойства:
НазваниеТипПо умолчанию
$namestring
$typestring"post"
Возвращает:
array|null

Возвращает информацию о поле в виде ассоциативного массива, либо null, если поле не найдено.


loadXfields

public loadXfields(string  type = "post") : array|false
Краткое содержание

Загружает дополнительные поля для новостей или профилей пользователей.

Описание

Метод извлекает данные из кэша, либо, при его отсутствии, читает данные из файла конфигурации. Возвращает ассоциативный массив, где ключами являются названия дополнительных полей, а значениями - их параметры. Данные загружаются в зависимости от значения параметра $type:

  • "post": данные загружаются из файла xfields.txt.
  • "user": данные загружаются из файла xprofile.txt. Ключи массива, формируемого из файла конфигурации, соответствуют предопределённым ключам, указанным в свойствах userXfieldKeys или postXfieldKeys.
Смотри так-же:
Свойства:
НазваниеТипПо умолчанию
$typestring"post"
Возвращает:
array|false

Ассоциативный массив дополнительных полей, где ключ - название поля, значение - его параметры. Возвращает false в случае невозможности прочитать файл.

On this page