AdminNavigation
extends EntityBase
in package
Class for the Admin CP navigation
This will be replaced by using the same mechanism as in frontend
Tags
Table of Contents
Properties
- $database : CustomAdodbPdo
- $localeCodes : array<string|int, mixed>
- List of locale codes ordered by translation fallback order per Cx instance
- $menuGroups : array<string|int, mixed>
- $menuItems : array<string|int, mixed>
- $nestingCount : int
- Counts the nesting level of __call()
- $stringRepresentationBlank : bool
- Whether blank string representations are valid
- $stringRepresentationFields : array<string|int, mixed>
- List of fields that should be available in the string representation
- $stringRepresentationFormat : string
- Sprintf format for the string representation
- $validators : array<string|int, mixed>
- Initialize this array as follows: array( 'columName' => Zend_Validate )
- $virtual : bool
- Defines if an entity is virtual and therefore not persistable.
Methods
- __call() : mixed
- Route methods like getName(), getType(), getDirectory(), etc.
- __construct() : mixed
- Creates a new instance of admin navigation
- __get() : mixed
- This is an ugly solution to allow $this->cx to be available in all entity classes Since the entity's constructor is not called when an entity is loaded from DB this cannot be assigned there.
- __toString() : string
- Returns this entity's identifying value
- getAdminNavbar() : void
- Creates the administration navigation
- getComponentController() : SystemComponent
- Returns the component controller for this component
- getKeyAsString() : string
- Returns this entity's key
- getTranslatedFieldValue() : mixed
- Returns the value of a translatable field using fallback mechanisms
- initializeValidators() : mixed
- Set $this->validators
- isComponentItsOwnNavPoint() : bool
- Tells whether a given component has its own level 1 navigation point
- isVirtual() : bool
- Returns the virtuality of the entity
- setVirtual() : mixed
- Set the virtuality of the entity
- validate() : mixed
- getFallbackLocaleCodes() : array<string|int, mixed>
- Returns a list of all locale codes ordered by fallback order
- getStringRepresentationBlank() : bool
- Whether blank string representations are valid
- getStringRepresentationFields() : array<string|int, mixed>
- Returns a list of fields available in the string representation
- getStringRepresentationFormat() : string
- Returns the sprintf() format for the string representation
- init() : void
- Merges hardcoded legacy entries with modern ones into $this->menuItems and $this->menuGroups
- moduleExists() : bool
- Tests whether the component with the given name is installed
Properties
$database
protected
CustomAdodbPdo
$database
$localeCodes
List of locale codes ordered by translation fallback order per Cx instance
protected
static array<string|int, mixed>
$localeCodes
= array()
Array in the form: array(<instanceId> => array(<localeCode>, ...))
Tags
$menuGroups
protected
array<string|int, mixed>
$menuGroups
= array()
List of translated group names indexed by ID
$menuItems
protected
array<string|int, mixed>
$menuItems
= array()
Flat list of all (sub / non-group) menu items indexed by ID
Items are an array with the following structure: 0 => <parentId> 1 => <translatedName> 2 => <targetUrl> 3 => <targetWindow> 4 => <moduleName> 5 => <orderId> 6 => <accessId> 7 => <alternateCmds> (optional)
$nestingCount
Counts the nesting level of __call()
protected
static int
$nestingCount
= 0
$stringRepresentationBlank
Whether blank string representations are valid
protected
bool
$stringRepresentationBlank
= false
Whether blank string representations are valid
Tags
$stringRepresentationFields
List of fields that should be available in the string representation
protected
array<string|int, mixed>
$stringRepresentationFields
= array()
List of field names
Tags
$stringRepresentationFormat
Sprintf format for the string representation
protected
string
$stringRepresentationFormat
= ''
Sprintf format string
Tags
$validators
Initialize this array as follows: array( 'columName' => Zend_Validate )
protected
array<string|int, mixed>
$validators
= array()
$virtual
Defines if an entity is virtual and therefore not persistable.
protected
bool
$virtual
= false
Defaults to FALSE - not virtual.
Methods
__call()
Route methods like getName(), getType(), getDirectory(), etc.
public
__call(string $methodName, array<string|int, mixed> $arguments) : mixed
Parameters
- $methodName : string
-
Name of method to call
- $arguments : array<string|int, mixed>
-
List of arguments for the method to call
Tags
Attributes
- #[ReturnTypeWillChange]
Return values
mixed —Return value of the method to call
__construct()
Creates a new instance of admin navigation
public
__construct(CustomAdodbPdo $database) : mixed
Parameters
- $database : CustomAdodbPdo
-
Database connection to use
__get()
This is an ugly solution to allow $this->cx to be available in all entity classes Since the entity's constructor is not called when an entity is loaded from DB this cannot be assigned there.
public
__get(mixed $name) : mixed
Parameters
- $name : mixed
Attributes
- #[ReturnTypeWillChange]
__toString()
Returns this entity's identifying value
public
__toString() : string
By default this returns the same as getKeyAsString(), but this method might get overridden by subclasses.
Return values
string —Identifying value for this entity
getAdminNavbar()
Creates the administration navigation
public
getAdminNavbar(HTML_Template_Sigma $template, string $activeCmd, string $activeAct, string $activeTpl) : void
Parameters
- $template : HTML_Template_Sigma
-
Template to parse admin nav into
- $activeCmd : string
-
Current CMD Considers the users' rights and only shows what they're allowed to see
- $activeAct : string
- $activeTpl : string
Tags
getComponentController()
Returns the component controller for this component
public
getComponentController() : SystemComponent
Return values
SystemComponentgetKeyAsString()
Returns this entity's key
public
final getKeyAsString([string $separator = '/' ]) : string
If this entity has a composite key, the fields are separated by $separator.
Parameters
- $separator : string = '/'
-
(optional) Separator for composite key fields, default "/"
Return values
string —Entity key as string
getTranslatedFieldValue()
Returns the value of a translatable field using fallback mechanisms
public
getTranslatedFieldValue(string $fieldName) : mixed
If the field is not translatable its value is returned anyway. Tries to return the value in the following locales (if non-empty):
- Current locale
- Default locale
- All other locales
Parameters
- $fieldName : string
-
Name of a translatable field
initializeValidators()
Set $this->validators
public
initializeValidators() : mixed
Validators can be found in lib/FRAMEWORK/Validator.class.php These will be executed if validate() is called
isComponentItsOwnNavPoint()
Tells whether a given component has its own level 1 navigation point
public
isComponentItsOwnNavPoint(string $componentName) : bool
Parameters
- $componentName : string
-
Name of the component name to check
Return values
bool —True If $componentName has its own level 1 navigation point
isVirtual()
Returns the virtuality of the entity
public
isVirtual() : bool
Return values
bool —TRUE if the entity is virtual, otherwise FALSE
setVirtual()
Set the virtuality of the entity
public
setVirtual(bool $virtual) : mixed
Parameters
- $virtual : bool
-
TRUE to set the entity as virtual or otherwise to FALSE
validate()
public
validate() : mixed
Tags
getFallbackLocaleCodes()
Returns a list of all locale codes ordered by fallback order
protected
getFallbackLocaleCodes() : array<string|int, mixed>
- First entry is the current locale
- Second entry is the default locale (if different from current, it's omitted otherwise)
- Then all other locales follow (in no particular order)
Tags
Return values
array<string|int, mixed> —List of locale codes
getStringRepresentationBlank()
Whether blank string representations are valid
protected
getStringRepresentationBlank() : bool
Return values
bool —Whether blank string representations are valid
getStringRepresentationFields()
Returns a list of fields available in the string representation
protected
getStringRepresentationFields() : array<string|int, mixed>
Return values
array<string|int, mixed> —List of field names
getStringRepresentationFormat()
Returns the sprintf() format for the string representation
protected
getStringRepresentationFormat() : string
Return values
string —sprintf() format string
init()
Merges hardcoded legacy entries with modern ones into $this->menuItems and $this->menuGroups
protected
init() : void
Depends on the following external resources:
- FWUser
- Init object
moduleExists()
Tests whether the component with the given name is installed
protected
moduleExists(string $component) : bool
Parameters
- $component : string
Return values
bool —True if component is installed or component name is empty