Class Descriptor

Module descriptor options.

Final
Namespace: ICanBoogie\Module
Package: ICanBoogie\Module
Located at Module/Descriptor.php

Methods summary

`public static array`	# `normalize( array $descriptor )` Normalizes a descriptor array. Normalizes a descriptor array. Parameters `$descriptor` Returns array

Constants summary

`string`	`CATEGORY` 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'`
`string`	`CLASSNAME` 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'`
`string`	`DESCRIPTION` Defines a short description of what the module do. Defines a short description of what the module do.	# `'description'`
`string`	`DISABLED` Defines the state of the module. Defines the state of the module.	# `'disabled'`
`string`	`EXTRA` Defines extra values. Defines extra values.	# `'extra'`
`string`	`INHERITS` Defines the parent module the module inherits from. Defines the parent module the module inherits from.	# `'inherits'`
`string`	`ID` 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'`
`string`	`REQUIRED` Defines the state of the module. Defines the state of the module. Required modules are always enabled.	# `'required'`
`string`	`REQUIRES` 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'`
`string`	`MODELS` Defines the models of the module. Defines the models of the module.	# `'models'`
`string`	`NS` Defines the namespace of the module. Defines the namespace of the module. This attribute must be defined at construct time.	# `'namespace'`
`string`	`PATH` Path to the module's directory. Path to the module's directory. This tag is resolved when the module is indexed.	# `'path'`
`string`	`PERMISSION` General permission of the module. General permission of the module.	# `'permission'`
`string`	`PERMISSIONS` Defines the permissions added by the module. Defines the permissions added by the module.	# `'permissions'`
`string`	`TITLE` 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'`
`string`	`WEIGHT` Defines the weight of the module. Defines the weight of the module. The weight of the module is resolved during modules indexing according to the EXTENDS and `ICanBoogie\Module\Descriptor::REQUIRES` tags.	# `'weight'`