navigationItem
extends staticModel
in package
implements
Stringable
ACP navigation item object
Tags
Interfaces, Classes, Traits and Enums
- Stringable
Table of Contents
- AREA_ADDNEWS = 'addnews'
- AREA_AFTER = 'after'
- AREA_COMMENTS = 'comments'
- AREA_DASHBOARD = 'dashboard'
- AREA_EDITNEWS = 'editnews'
- AREA_FILEMANAGER = 'filemanager'
- AREA_MODULES = 'modules'
- AREA_OPTIONS = 'options'
- AREA_TRASH = 'trashes'
- $accessible : bool
- Permissions flag for access
- $cache : cache
- Cache object
- $cacheModule : string
- Cache Modul
- $cacheName : string
- Cache name
- $class : string
- allgemeine CSS-Klassen
- $config : config
- Config object
- $data : array<string|int, mixed>
- Data array
- $description : string
- im Navigation angezeigte Beschreibung
- $events : events
- Event list
- $icon : string
- CSS-Klassen für Icon
- $id : string
- Item-ID
- $language : language
- Sprachobjekt
- $notifications : notifications
- Notifications
- $parent : string
- Eltern-Bereich des Menü-Eintrages
- $permissions : permissions
- Permissions
- $session : session
- Session objekt
- $spacer : bool
- Status, ob auf Element Platzhalter folgt
- $submenu : array<string|int, mixed>
- Untermenü, array mit Elementen vom Typ navigationItem
- $url : string
- Zielurl
- $wrapperClass : string
- Wrapper-CSS-Klassen
- $activeSetModule : string
- Module to check/merk as active
- $currentModule : string
- aktuell ausgewähltes Modul
- $submenuItem : bool
- has parent, so it's a submenu item
- __construct() : void
- Konstruktor
- getCacheName() : string
- Cache-Name zurückgeben
- getClass() : string
- allgemeine CSS-Klassen zurückgeben
- getDefaultCss() : string
- Get navigation item css string
- getDescription() : string
- Beschreibung zurückgeben
- getFullUrl() : string
- Zielurl zurückgeben
- getIcon() : string
- CSS-Klassen für Icon zurückgeben
- getId() : string
- Item-ID zurückgeben
- getParent() : string
- Eltern-Bereich zurückgeben
- getPermission() : array<string|int, mixed>
- Berechtigungen zurückgeben
- getSubmenu() : array<string|int, mixed>
- Untermenü-Elemente zurückgegen
- getUrl() : string
- Zielurl zurückgeben
- getWrapperClass() : string
- allgemeine Wrapper-CSS-Klassen zurückgeben
- hasSpacer() : bool
- Status, ob Spacer nach Element angezeigt werden soll
- hasSubmenu() : bool
- Status, Untermenü-Einträge existieren
- isAccessible() : bool
- Returns true, is navigation is is accessible
- isActive() : bool
- Status zurückgeben, ob Ziel aktiv ist
- setAccessible() : $this
- Set accessible mode
- setClass() : mixed
- allgemeine CSS-Klassen setzen
- setDescription() : mixed
- Beschreibung setzen
- setIcon() : $this
- CSS-Klassen für Icon setzen
- setId() : mixed
- Item-ID setzen
- setIsSubmenuItem() : $this
- Is submenu item
- setParent() : mixed
- Eltern-Bereich setzen
- setSpacer() : mixed
- Status, dass Spacer nach Element angezeigt werden soll
- setSubmenu() : mixed
- Untermenü-Array füllen
- setUrl() : mixed
- Zielurl setzen
- setWrapperClass() : mixed
- allgemeine WrapperCSS-Klassen setzen
- getLinkString() : string
- Return Link string
- getSubmenuString() : string
- Returns submenu string
- hasActiveSubmenuItem() : bool
- Check if submenu has active item
Constants
AREA_ADDNEWS
public
mixed
AREA_ADDNEWS
= 'addnews'
AREA_AFTER
public
mixed
AREA_AFTER
= 'after'
AREA_COMMENTS
public
mixed
AREA_COMMENTS
= 'comments'
AREA_DASHBOARD
public
mixed
AREA_DASHBOARD
= 'dashboard'
AREA_EDITNEWS
public
mixed
AREA_EDITNEWS
= 'editnews'
AREA_FILEMANAGER
public
mixed
AREA_FILEMANAGER
= 'filemanager'
AREA_MODULES
public
mixed
AREA_MODULES
= 'modules'
AREA_OPTIONS
public
mixed
AREA_OPTIONS
= 'options'
AREA_TRASH
public
mixed
AREA_TRASH
= 'trashes'
Properties
$accessible
Permissions flag for access
protected
bool
$accessible
= null
$cache
Cache object
protected
cache
$cache
$cacheModule
Cache Modul
protected
string
$cacheModule
= ''
Tags
$cacheName
Cache name
protected
string
$cacheName
= false
$class
allgemeine CSS-Klassen
protected
string
$class
= ''
$config
Config object
protected
config
$config
$data
Data array
protected
array<string|int, mixed>
$data
$description
im Navigation angezeigte Beschreibung
protected
string
$description
= ''
$events
Event list
protected
events
$events
$icon
CSS-Klassen für Icon
protected
string
$icon
= ''
$id
Item-ID
protected
string
$id
= ''
$language
Sprachobjekt
protected
language
$language
$notifications
Notifications
protected
notifications
$notifications
Tags
$parent
Eltern-Bereich des Menü-Eintrages
protected
string
$parent
= 'after'
$permissions
Permissions
protected
permissions
$permissions
Tags
$session
Session objekt
protected
session
$session
$spacer
Status, ob auf Element Platzhalter folgt
protected
bool
$spacer
= false
$submenu
Untermenü, array mit Elementen vom Typ navigationItem
protected
array<string|int, mixed>
$submenu
= []
$url
Zielurl
protected
string
$url
= ''
$wrapperClass
Wrapper-CSS-Klassen
protected
string
$wrapperClass
= ''
$activeSetModule
Module to check/merk as active
private
string
$activeSetModule
= ''
$currentModule
aktuell ausgewähltes Modul
private
string
$currentModule
= ''
$submenuItem
has parent, so it's a submenu item
private
bool
$submenuItem
= false
Methods
__construct()
Konstruktor
public
__construct() : void
Return values
void —getCacheName()
Cache-Name zurückgeben
public
getCacheName([string $addName = '' ]) : string
Parameters
- $addName : string = ''
Return values
string —getClass()
allgemeine CSS-Klassen zurückgeben
public
getClass() : string
Return values
string —getDefaultCss()
Get navigation item css string
public
getDefaultCss([type $active = '' ]) : string
Parameters
- $active : type = ''
Tags
Return values
string —getDescription()
Beschreibung zurückgeben
public
getDescription() : string
Return values
string —getFullUrl()
Zielurl zurückgeben
public
getFullUrl() : string
Return values
string —getIcon()
CSS-Klassen für Icon zurückgeben
public
getIcon() : string
Return values
string —getId()
Item-ID zurückgeben
public
getId() : string
Return values
string —getParent()
Eltern-Bereich zurückgeben
public
getParent() : string
Return values
string —getPermission()
Berechtigungen zurückgeben
public
getPermission() : array<string|int, mixed>
Return values
array<string|int, mixed> —getSubmenu()
Untermenü-Elemente zurückgegen
public
getSubmenu() : array<string|int, mixed>
Return values
array<string|int, mixed> —getUrl()
Zielurl zurückgeben
public
getUrl() : string
Return values
string —getWrapperClass()
allgemeine Wrapper-CSS-Klassen zurückgeben
public
getWrapperClass() : string
Return values
string —hasSpacer()
Status, ob Spacer nach Element angezeigt werden soll
public
hasSpacer() : bool
Return values
bool —hasSubmenu()
Status, Untermenü-Einträge existieren
public
hasSubmenu() : bool
Return values
bool —isAccessible()
Returns true, is navigation is is accessible
public
isAccessible() : bool
Return values
bool —isActive()
Status zurückgeben, ob Ziel aktiv ist
public
isActive([string $id = '' ]) : bool
Parameters
- $id : string = ''
Return values
bool —setAccessible()
Set accessible mode
public
setAccessible(bool $accessible) : $this
Parameters
- $accessible : bool
Return values
$this —setClass()
allgemeine CSS-Klassen setzen
public
setClass(string $class) : mixed
Parameters
- $class : string
Return values
mixed —setDescription()
Beschreibung setzen
public
setDescription(string $description) : mixed
Parameters
- $description : string
Return values
mixed —setIcon()
CSS-Klassen für Icon setzen
public
setIcon(string $icon[, string $prefix = 'fa' ][, bool $useFa = true ]) : $this
Parameters
- $icon : string
- $prefix : string = 'fa'
- $useFa : bool = true
Return values
$this —setId()
Item-ID setzen
public
setId(string $id) : mixed
Parameters
- $id : string
Return values
mixed —setIsSubmenuItem()
Is submenu item
public
setIsSubmenuItem(bool $submenuItem) : $this
Parameters
- $submenuItem : bool
Tags
Return values
$this —setParent()
Eltern-Bereich setzen
public
setParent(string $parent) : mixed
Parameters
- $parent : string
Return values
mixed —setSpacer()
Status, dass Spacer nach Element angezeigt werden soll
public
setSpacer([bool $spacer = true ]) : mixed
Parameters
- $spacer : bool = true
Return values
mixed —setSubmenu()
Untermenü-Array füllen
public
setSubmenu(array<string|int, mixed> $submenu) : mixed
Parameters
- $submenu : array<string|int, mixed>
Return values
mixed —setUrl()
Zielurl setzen
public
setUrl(string $url) : mixed
Parameters
- $url : string
Return values
mixed —setWrapperClass()
allgemeine WrapperCSS-Klassen setzen
public
setWrapperClass(string $wrapperClass) : mixed
Parameters
- $wrapperClass : string
Return values
mixed —getLinkString()
Return Link string
private
getLinkString() : string
Return values
string —getSubmenuString()
Returns submenu string
private
getSubmenuString(string $str) : string
Parameters
- $str : string
Return values
string —hasActiveSubmenuItem()
Check if submenu has active item
private
hasActiveSubmenuItem() : bool