Class Descriptor

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.

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.

Defines a short description of what the module do.

Defines the state of the module.

Defines extra values.

Defines the parent module the module inherits from.

Defines the identifier of the module.

If the identifier is not defined the name of the module directory is used instead.

Defines the state of the module.

Required modules are always enabled.

Defines the modules that the module requires.

The required modules are defined using an array where each key/value pair is the identifier of the module and the minimum version required.

Defines the models of the module.

Defines the namespace of the module.

This attribute must be defined at construct time.

Path to the module's directory.

This tag is resolved when the module is indexed.

General permission of the module.

Defines the permissions added by the module.

Defines the title of the module.

The title of the module is translated within the module_title scope.

Defines the version (and revision) 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.