Documentation

rex_navigation
in package
Uses rex_factory_trait

Klasse zum Erstellen von Navigationen.

Table of Contents

Methods

__construct()  : mixed
addCallback()  : $this
Fügt einen Callback hinzu.
addFilter()  : void
Fügt einen Filter hinzu.
factory()  : static
get()  : string
Generiert eine Navigation.
getBreadcrumb()  : string
Generiert eine Breadcrumb-Navigation.
setClasses()  : void
setLinkClasses()  : void
show()  : void
showBreadcrumb()  : void
_getNavigation()  : string
getBreadcrumbLinkTag()  : string
getBreadcrumbListItemTag()  : string
getBreadcrumbListTag()  : string
getLinkTag()  : string
getListItemTag()  : string
getListTag()  : string

Methods

addCallback()

Fügt einen Callback hinzu.

public addCallback(callable(rex_category, int, array<int|string, int|string|array<int, string>>, array<int|string, int|string|array<int, string>>, string): bool $callback[, int|"" $depth = '' ]) : $this
Parameters
$callback : callable(rex_category, int, array<int|string, int|string|array<int, string>>, array<int|string, int|string|array<int, string>>, string): bool

z.B. myFunc oder myClass::myMethod

$depth : int|"" = ''

"" wenn auf allen Ebenen, wenn definiert, dann wird der Filter nur auf dieser Ebene angewendet

Return values
$this

addFilter()

Fügt einen Filter hinzu.

public addFilter([string $metafield = 'id' ][, int|string $value = '1' ][, string $type = '=' ][, int|"" $depth = '' ]) : void
Parameters
$metafield : string = 'id'

Datenbankfeld der Kategorie

$value : int|string = '1'

Wert für den Vergleich

$type : string = '='

art des Vergleichs =/</

$depth : int|"" = ''

"" wenn auf allen Ebenen, wenn definiert, dann wird der Filter nur auf dieser Ebene angewendet

factory()

public static factory() : static
Return values
static

get()

Generiert eine Navigation.

public get([int $categoryId = 0 ][, int $depth = 3 ][, bool $open = false ][, bool $ignoreOfflines = false ]) : string
Parameters
$categoryId : int = 0

Id der Wurzelkategorie

$depth : int = 3

Anzahl der Ebenen die angezeigt werden sollen

$open : bool = false

True, wenn nur Elemente der aktiven Kategorie angezeigt werden sollen, sonst FALSE

$ignoreOfflines : bool = false

FALSE, wenn offline Elemente angezeigt werden, sonst TRUE

Return values
string

getBreadcrumb()

Generiert eine Breadcrumb-Navigation.

public getBreadcrumb(string|false $startPageLabel[, bool $includeCurrent = false ][, int $categoryId = 0 ]) : string
Parameters
$startPageLabel : string|false

Label der Startseite, falls FALSE keine Start-Page anzeigen

$includeCurrent : bool = false

True wenn der aktuelle Artikel enthalten sein soll, sonst FALSE

$categoryId : int = 0

Id der Wurzelkategorie

Return values
string

setClasses()

public setClasses(array<int, string> $classes) : void
Parameters
$classes : array<int, string>

setLinkClasses()

public setLinkClasses(array<int, string> $classes) : void
Parameters
$classes : array<int, string>

show()

public show([int $categoryId = 0 ][, int $depth = 3 ][, bool $open = false ][, bool $ignoreOfflines = false ]) : void
Parameters
$categoryId : int = 0
$depth : int = 3
$open : bool = false
$ignoreOfflines : bool = false
Tags
see
get()

showBreadcrumb()

public showBreadcrumb([string|false $startPageLabel = false ][, bool $includeCurrent = false ][, int $categoryId = 0 ]) : void
Parameters
$startPageLabel : string|false = false
$includeCurrent : bool = false
$categoryId : int = 0
Tags
see
getBreadcrumb()

_getNavigation()

protected _getNavigation(int $categoryId[, int $depth = 1 ]) : string
Parameters
$categoryId : int
$depth : int = 1
Return values
string

getBreadcrumbLinkTag()

protected getBreadcrumbLinkTag(rex_category $category, string $content, array<int|string, int|string|array<int, string>> $attributes, int $depth) : string
Parameters
$category : rex_category
$content : string
$attributes : array<int|string, int|string|array<int, string>>
$depth : int
Return values
string

getBreadcrumbListItemTag()

protected getBreadcrumbListItemTag(string $item, array<int|string, int|string|array<int, string>> $attributes, int $depth) : string
Parameters
$item : string
$attributes : array<int|string, int|string|array<int, string>>
$depth : int
Return values
string

getBreadcrumbListTag()

protected getBreadcrumbListTag(array<string|int, string> $items, array<int|string, int|string|array<int, string>> $attributes) : string
Parameters
$items : array<string|int, string>
$attributes : array<int|string, int|string|array<int, string>>
Return values
string

getLinkTag()

protected getLinkTag(rex_category $category, string $content, array<int|string, int|string|array<int, string>> $attributes, int $depth) : string
Parameters
$category : rex_category
$content : string
$attributes : array<int|string, int|string|array<int, string>>
$depth : int
Return values
string

getListItemTag()

protected getListItemTag(rex_category $category, string $item, array<int|string, int|string|array<int, string>> $attributes, int $depth) : string
Parameters
$category : rex_category
$item : string
$attributes : array<int|string, int|string|array<int, string>>
$depth : int
Return values
string

getListTag()

protected getListTag(array<string|int, string> $items, array<int|string, int|string|array<int, string>> $attributes, int $depth) : string
Parameters
$items : array<string|int, string>
$attributes : array<int|string, int|string|array<int, string>>
$depth : int
Return values
string

        
On this page

Search results