\rex_navigation

Klasse zum Erstellen von Navigationen.

Summary

Methods
Properties
Constants
setFactoryClass()
getFactoryClass()
hasFactoryClass()
__construct()
factory()
get()
show()
getBreadcrumb()
showBreadcrumb()
setClasses()
setLinkClasses()
addFilter()
addCallback()
No public properties found
No constants found
callFactoryClass()
_getNavigation()
getBreadcrumbListTag()
getBreadcrumbListItemTag()
getBreadcrumbLinkTag()
getListTag()
getListItemTag()
getLinkTag()
No protected properties found
N/A
No private methods found
No private properties found
N/A

Methods

setFactoryClass()

setFactoryClass(string  $subclass) : mixed

Sets the class for the factory.

Parameters

string $subclass

Classname

Throws

\InvalidArgumentException

Returns

mixed —

getFactoryClass()

getFactoryClass() : string

Returns the class for the factory.

Returns

string —

hasFactoryClass()

hasFactoryClass() : bool

Returns if the class has a custom factory class.

Returns

bool —

__construct()

__construct() : mixed

Returns

mixed —

factory()

factory() : static

Returns

static —

get()

get(int  $categoryId, int  $depth = 3, bool  $open = false, bool  $ignoreOfflines = false) : string

Generiert eine Navigation.

Parameters

int $categoryId

Id der Wurzelkategorie

int $depth

Anzahl der Ebenen die angezeigt werden sollen

bool $open

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

bool $ignoreOfflines

FALSE, wenn offline Elemente angezeigt werden, sonst TRUE

Returns

string —

show()

show(mixed  $categoryId, mixed  $depth = 3, mixed  $open = false, mixed  $ignoreOfflines = false) : mixed

Parameters

mixed $categoryId
mixed $depth
mixed $open
mixed $ignoreOfflines

Returns

mixed —

getBreadcrumb()

getBreadcrumb(string  $startPageLabel, bool  $includeCurrent = false, int  $categoryId) : string

Generiert eine Breadcrumb-Navigation.

Parameters

string $startPageLabel

Label der Startseite, falls FALSE keine Start-Page anzeigen

bool $includeCurrent

True wenn der aktuelle Artikel enthalten sein soll, sonst FALSE

int $categoryId

Id der Wurzelkategorie

Returns

string —

showBreadcrumb()

showBreadcrumb(mixed  $startPageLabel = false, mixed  $includeCurrent = false, mixed  $categoryId) : mixed

Parameters

mixed $startPageLabel
mixed $includeCurrent
mixed $categoryId

Returns

mixed —

setClasses()

setClasses(mixed  $classes) : mixed

Parameters

mixed $classes

Returns

mixed —

setLinkClasses()

setLinkClasses(mixed  $classes) : mixed

Parameters

mixed $classes

Returns

mixed —

addFilter()

addFilter(string  $metafield = 'id', mixed  $value = '1', string  $type = '=', int|string  $depth = '') : mixed

Fügt einen Filter hinzu.

Parameters

string $metafield

Datenbankfeld der Kategorie

mixed $value

Wert für den Vergleich

string $type

art des Vergleichs =/</

int|string $depth

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

Returns

mixed —

addCallback()

addCallback(callable  $callback, int|string  $depth = '') : $this

Fügt einen Callback hinzu.

Parameters

callable $callback

z.B. myFunc oder myClass::myMethod

int|string $depth

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

Returns

$this —

callFactoryClass()

callFactoryClass(string  $method, array  $arguments) : mixed

Calls the factory class with the given method and arguments.

Parameters

string $method

Method name

array $arguments

Array of arguments

Returns

mixed —

Result of the callback

_getNavigation()

_getNavigation(int  $categoryId, int  $depth = 1) : string

Parameters

int $categoryId
int $depth

Returns

string —

getBreadcrumbListTag()

getBreadcrumbListTag(string[]  $items, array  $attributes) : string

Parameters

string[] $items
array $attributes

Returns

string —

getBreadcrumbListItemTag()

getBreadcrumbListItemTag(string  $item, array  $attributes, int  $depth) : string

Parameters

string $item
array $attributes
int $depth

Returns

string —

getBreadcrumbLinkTag()

getBreadcrumbLinkTag(\rex_category  $category, string  $content, array  $attributes, int  $depth) : string

Parameters

\rex_category $category
string $content
array $attributes
int $depth

Returns

string —

getListTag()

getListTag(string[]  $items, array  $attributes, int  $depth) : string

Parameters

string[] $items
array $attributes
int $depth

Returns

string —

getListItemTag()

getListItemTag(\rex_category  $category, string  $item, array  $attributes, int  $depth) : string

Parameters

\rex_category $category
string $item
array $attributes
int $depth

Returns

string —

getLinkTag()

getLinkTag(\rex_category  $category, string  $content, array  $attributes, int  $depth) : string

Parameters

\rex_category $category
string $content
array $attributes
int $depth

Returns

string —