Класс: AdminLink

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

Класс AdminLink реализует функциональность для создания и управления административными ссылками, включая родительские связи, дочерние элементы, типы ссылок и дополнительные параметры.

Описание:

Содержит методы для установки и получения атрибутов ссылки, а также для манипуляции дочерними элементами, такими как добавление, установка и рекурсивное построение иерархии.

Основные свойства включают:

• $parent – идентификатор родительского элемента.
• $name – имя ссылки.
• $link – URL-адрес.
• $type – тип элемента (например, 'link', 'dropdown').
• $extra – дополнительные параметры.
• $children – массив дочерних элементов.

Свойства

• private $children
• private $extra
• private $link
• private $name
• private $parent
• private $type

Методы

• public __construct()
• public addChild()
• public getChildren()
• public getExtra()
• public getLink()
• public getName()
• public getParent()
• public getType()
• public setChildren()
• public setExtra()
• public setLink()
• public setName()
• public setParent()
• public setType()

Подробности

• Путь: engine/inc/maharder/_includes/types/AdminLink.php

Свойства

private $children : array

Тип: Массив

Список дочерних элементов. Устанавливается через метод \AdminLink::setChildren().

private $extra : ?string

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

Дополнительная информация. Устанавливается через метод \AdminLink::setExtra() и фильтруется с помощью FILTER_SANITIZE_FULL_SPECIAL_CHARS.

private $link : ?string

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

URL ссылки. Устанавливается через метод \AdminLink::setLink() и валидируется с помощью FILTER_VALIDATE_URL.

private $name : ?string

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

Имя ссылки. Устанавливается через метод \AdminLink::setName() и фильтруется с помощью FILTER_SANITIZE_FULL_SPECIAL_CHARS.

private $parent : ?string

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

Родительский элемент. Устанавливается через метод \AdminLink::setParent().

private $type : ?string

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

Тип ссылки. Устанавливается через метод \AdminLink::setType(). Ожидаемые значения: 'link', 'dropdown', 'divider', 'data'. По умолчанию: 'link'.

Методы

__construct

1

public __construct(string|null  parent = null, string|null  name = null, string|null  link = null, string|null  type = null, string|null  extra = null, array  children = []) : mixed

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

Конструктор класса AdminLink.

Описание

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

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

• \AdminLink::setParent()
• \AdminLink::setName()
• \AdminLink::setLink()
• \AdminLink::setType()
• \AdminLink::setExtra()
• \AdminLink::setChildren()

Свойства:

Возвращает:

1

mixed

addChild

1

public addChild(\AdminLink  link) : \AdminLink

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

Добавляет дочернюю ссылку к текущему объекту AdminLink.

Описание

Если переданная ссылка имеет родительский идентификатор (parentId), проверяется, существует ли такой дочерний элемент у текущего объекта. В случае его существования вызов метода продолжается рекурсивно для добавления дочерней ссылки. Если дочерний элемент отсутствует, ссылка добавляется как новый дочерний элемент. Если у переданной ссылки нет родительского идентификатора, она добавляется в общий список дочерних элементов.

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

• \AdminLink::getParent()
• \AdminLink::getChildren()

Свойства:

Возвращает:

1

\AdminLink

Возвращает текущий экземпляр AdminLink для возможности дальнейшей цепочки вызовов.

getChildren

1

public getChildren() : array

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

Возвращает массив детей текущего объекта.

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

• \AdminLink::$children
• \AdminLink::setChildren()

Возвращает:

1

array

Список объектов, являющихся потомками текущего объекта.

getExtra

1

public getExtra() : string|null

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

Возвращает значение дополнительного параметра.

Возвращает:

1

string|null

Дополнительный параметр или null, если он не установлен.

getLink

1

public getLink() : string|null

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

Возвращает значение свойства ссылки.

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

• \AdminLink::setLink()

Возвращает:

1

string|null

Вернётся строка с URL или null, если ссылка не установлена.

getName

1

public getName() : ?string

Возвращает:

1

?string

getParent

1

public getParent() : string|null

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

Возвращает идентификатор родителя текущего объекта AdminLink.

Возвращает:

1

string|null

Идентификатор родителя или null, если родитель не установлен.

getType

1

public getType() : string|null

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

Возвращает текущий тип элемента.

Описание

Тип может принимать следующие значения: 'link', 'dropdown', 'divider', 'data', или null, если он не был установлен.

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

• \AdminLink::setType()
• \AdminLink::$type

Возвращает:

1

string|null

Текущий тип элемента или null, если тип не задан.

setChildren

1

public setChildren(array  children) : \AdminLink

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

Устанавливает массив дочерних элементов для текущего объекта.

Описание

Этот метод заменяет существующий массив дочерних элементов переданным массивом.

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

• \AdminLink::getChildren()
• \AdminLink::addChild()

Свойства:

Возвращает:

1

\AdminLink

Возвращает текущий экземпляр класса для возможности цепочки вызовов.

setExtra

1

public setExtra(string|null  extra) : \AdminLink

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

Устанавливает значение дополнительного параметра и применяет фильтрацию.

Свойства:

Возвращает:

1

\AdminLink

Возвращает текущий экземпляр класса для цепочки вызовов.

setLink

1

public setLink(string|null  link) : \AdminLink

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

Устанавливает URL-ссылку для текущего объекта класса AdminLink.

Описание

Метод проверяет переданную строку на соответствие формату URL с использованием фильтрации через {@see}. Если переданное значение не является допустимым URL, оно будет проигнорировано.

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

• \AdminLink::$link
• \AdminLink::getLink()

Свойства:

Возвращает:

1

\AdminLink

Возвращает текущий экземпляр объекта AdminLink для возможности цепочки вызовов.

setName

1

public setName(string|null  name) : \AdminLink

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

Устанавливает название ссылки после фильтрации входного значения.

Свойства:

Возвращает:

1

\AdminLink

Возвращает текущий экземпляр класса AdminLink.

setParent

1

public setParent(string|null  parent) : \AdminLink

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

Устанавливает родительский идентификатор для ссылки.

Свойства:

Возвращает:

1

\AdminLink

Возвращает текущий экземпляр класса для цепочки вызовов.

setType

1

public setType(string|null  type) : \AdminLink

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

Устанавливает тип текущего объекта AdminLink.

Описание

Метод позволяет задать тип ссылки из набора допустимых значений. Если значение передано и соответствует одному из допустимых значений, оно будет установлено в соответствующее свойство объекта.

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

• \AdminLink::$type
• \AdminLink::getType()

Свойства:

Возвращает:

1

\AdminLink

Возвращает текущий экземпляр AdminLink для возможности цепочки вызовов.