Class Descriptor
Module descriptor options.
Final
Namespace: ICanBoogie\
Module
Package: ICanBoogie\Module
Located at Module/Descriptor.php
Methods summary
public static
normalize( array $descriptor )
: array
Normalizes a descriptor array.
Normalizes a descriptor array.
Parameters
Returns
array
Constants summary
CATEGORY
: string
Defines the category for the module.
Defines the category for the module.
When modules are listed they are usually grouped by category. The category is also often
used to create the main navigation menu of the admin interface.
The category of the module is translated within the module_category scope.
'category'
CLASSNAME
: string
Defines the PHP class of the module.
Defines the PHP class of the module.
If the class is not defined it is resolved during indexing using the ICanBoogie\Module\Descriptor::NS
tag and the following pattern : <namespace>\Module.
'class'
DESCRIPTION
: string
Defines a short description of what the module do.
Defines a short description of what the module do.
'description'
DISABLED
: string
Defines the state of the module.
Defines the state of the module.
'disabled'
INHERITS
: string
Defines the parent module the module inherits from.
Defines the parent module the module inherits from.
'inherits'
ID
: string
Defines the identifier of the module.
Defines the identifier of the module.
If the identifier is not defined the name of the module directory is used instead.
'id'
REQUIRED
: string
Defines the state of the module.
Defines the state of the module.
Required modules are always enabled.
'required'
REQUIRES
: string
Defines the modules that the module requires.
Defines the modules that the module requires.
The required modules are defined using an array of identifiers.
'requires'
MODELS
: string
Defines the models of the module.
Defines the models of the module.
'models'
NS
: string
Defines the namespace of the module.
Defines the namespace of the module.
This attribute must be defined at construct time.
'namespace'
PATH
: string
Path to the module's directory.
Path to the module's directory.
This tag is resolved when the module is indexed.
'path'
PERMISSION
: string
General permission of the module.
General permission of the module.
'permission'
PERMISSIONS
: string
Defines the permissions added by the module.
Defines the permissions added by the module.
'permissions'
TITLE
: string
Defines the title of the module.
Defines the title of the module.
The title of the module is translated within the module_title scope.
'title'
WEIGHT
: string
Defines the weight of the module.
'weight'