Версия: 6.x
burger close
Класс BreadCrumbs

Подробное описание

Класс отвечает за хранение хлемных крошек для текущей страницы

Открытые члены

 __construct ()
 
 mainLink ($bool)
 
 setMainBreadCrumb ($title, $href=null)
 
 getMainBreadCrumb ()
 
 addBreadCrumb ($title, $href=null, $position=null, array $data=[])
 
 removeBreadCrumb ($position=null)
 
 setBreadCrumbs (array $breadcrumbs)
 
 getBreadCrumbs ()
 

Поля данных

 $breadcrumbs = []
 
 $main_breadcrumb
 

Защищенные данные

 $add_main = true
 

Конструктор(ы)

__construct ( )

Методы

addBreadCrumb (   $title,
  $href = null,
  $position = null,
array  $data = [] 
)

Добавляет секцию в хлебные крошки

Аргументы
string$titleНазвание секции
string$hrefСсылка
integer | null$positionПорядковый номер крошки в списке. Если Null, то добавляется в конец
array$dataПроизвольные данные для элемента хлебных крошек
Возвращает
BreadCrumbs
getBreadCrumbs ( )

Возвращает массив с секциями хлебных крошек для текущей страницы

Аргументы
mixed$add_main
Возвращает
array|array[]
getMainBreadCrumb ( )

Возвращает массив с текущим главным элементов хлебных крошек

Возвращает
array
mainLink (   $bool)

Устанавливает, добавлять ли ссылку на главную страницу сайта

Аргументы
bool$bool- если true, то ссылка будет добавлена в начале массива
Возвращает
BreadCrumbs
removeBreadCrumb (   $position = null)

Удаляет секцию из определенной позиции. Если не передан $position, то удалена будет последняя позиция

Аргументы
integer$position
Возвращает
BreadCrumbs
setBreadCrumbs ( array  $breadcrumbs)

Устанавливает все секции хлебныйх крошек

Аргументы
array$breadcrumbsмассив с хлебными
Возвращает
BreadCrumbs
setMainBreadCrumb (   $title,
  $href = null 
)

Устанавливает крошку главной страницы

Аргументы
string$title
string$href

Поля

$add_main = true
protected
$breadcrumbs = []
$main_breadcrumb