Class Module

A module of the framework.

ICanBoogie\Object implements ICanBoogie\ToArrayRecursive uses ICanBoogie\ToArrayRecursiveTrait, ICanBoogie\PrototypeTrait

ICanBoogie\Module

Direct known subclasses

ICanBoogie\Modules\Thumbnailer\Module, Icybee\Module, Icybee\Modules\Registry\Module, Icybee\Modules\Users\NonceLogin\Module

Indirect known subclasses

Namespace: ICanBoogie
Located at vendor/icanboogie/module/lib/module.php

Methods summary

`protected string`	# `get_id( )` Returns the identifier of the module as defined by its descriptor. Returns the identifier of the module as defined by its descriptor. This method is the getter for the $id magic property. Returns `string`
`protected string`	# `get_path( )` Returns the path of the module as defined by its descriptor. Returns the path of the module as defined by its descriptor. This method is the getter for the $path magic property. Returns `string`
`protected array[string]mixed`	# `get_descriptor( )` Returns the descriptor of the module. Returns the descriptor of the module. This method is the getter for the `ICanBoogie\Module::$descriptor` magic property. Returns `array[string]mixed`
`public`	# `__construct( array $descriptor )` Constructor. Constructor. Initializes the `ICanBoogie\Module::$descriptor` property. Parameters `$descriptor` `array` $descriptor
`public string`	# `__toString( )` Returns the identifier of the module. Returns the identifier of the module. Returns `string`
`protected string`	# `get_flat_id( )` Returns the _flat_ version of the module's identifier. Returns the _flat_ version of the module's identifier. This method is the getter for the $flat_id magic property. Returns `string`
`protected ICanBoogie\ActiveRecord\Model`	# `get_model( )` Returns the primary model of the module. Returns the primary model of the module. This is the getter for the $model magic property. Returns `ICanBoogie\ActiveRecord\Model`
`protected string`	# `get_title( )` Returns the module title, translated to the current language. Returns the module title, translated to the current language. Returns `string`
`protected ICanBoogie\Module\|null`	# `get_parent( )` Returns the parent module. Returns the parent module. Returns `ICanBoogie\Module\|null`
`public mixed`	# `is_installed( ICanBoogie\Errors $errors )` Checks if the module is installed. Checks if the module is installed. Parameters `$errors` `ICanBoogie\Errors` $errors Error collection. Returns `mixed` `true` if the module is installed, `false` if the module (or parts of) is not installed, `null` if the module has no installation.
`public boolean\|null`	# `install( ICanBoogie\Errors $errors )` Install the module. Install the module. If the module has models they are installed. Parameters `$errors` `ICanBoogie\Errors` $errors Error collection. Returns `boolean\|null` true if the module has successfully been installed, false if the module (or parts of the module) fails to install or null if the module has no installation process.
`public boolean\|null`	# `uninstall( )` Uninstall the module. Uninstall the module. Basically it uninstall the models installed by the module. Returns `boolean\|null` `true` if the module was successfully uninstalled. `false` if the module (or parts of the module) failed to uninstall. `null` if there is no uninstall process.
`public ICanBoogie\ActiveRecord\Model`	# `model( string $which = 'primary' )` Get a model from the module. Get a model from the module. If the model has not been created yet, it is created on the fly. Parameters `$which` `string` $which The identifier of the model to get. Returns `ICanBoogie\ActiveRecord\Model` The requested model. Throws `ICanBoogie\Exception` if the model does not exists.
`protected`	# `resolve_model_tags( mixed $tags, mixed $which )`
`public mixed`	# `getBlock( string $name )` Get a block. Get a block. Parameters `$name` `string` $name The name of the block to get. Returns `mixed` Depends on the implementation. Should return a string or object that can be stringified. Throws `ICanBoogie\Exception` if the block is not defined.

Magic methods summary

Constants summary

`string`	`T_CATEGORY`	`'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.
`string`	`T_CLASS`	`'class'`	# 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::T_NAMESPACE` tag and the following pattern : `<namespace>\Module`.
`string`	`T_DESCRIPTION`	`'description'`	# Defines a short description of what the module do. Defines a short description of what the module do.
`boolean`	`T_DISABLED`	`'disabled'`	# Defines the state of the module. Defines the state of the module.
`string\|ICanBoogie\Module`	`T_EXTENDS`	`'extends'`	# Defines the module that the module extends. Defines the module that the module extends.
`string`	`T_ID`	`'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.
`boolean`	`T_REQUIRED`	`'required'`	# Defines the state of the module. Defines the state of the module. Required modules are always enabled.
`array[string]string`	`T_REQUIRES`	`'requires'`	# Defines the modules that the module requires. 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.
`array[string]array\|string`	`T_MODELS`	`'models'`	# Defines the models of the module. Defines the models of the module.
`string`	`T_NAMESPACE`	`'namespace'`	# Defines the namespace of the module. Defines the namespace of the module. This attribute must be defined at construct time.
`string`	`T_PATH`	`'path'`	# Path to the module's directory. Path to the module's directory. This tag is resolved when the module is indexed.
`string\|integer`	`T_PERMISSION`	`'permission'`	# General permission of the module. General permission of the module.
`array[]string`	`T_PERMISSIONS`	`'permissions'`	# Defines the permissions added by the module. Defines the permissions added by the module.
`string`	`T_TITLE`	`'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.
`string`	`T_VERSION`	`'version'`	# Defines the version (and revision) of the module. Defines the version (and revision) of the module.
`integer`	`T_WEIGHT`	`'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 `ICanBoogie\Module::T_EXTENDS` and `ICanBoogie\Module::T_REQUIRES` tags.
`integer`	`PERMISSION_NONE`	`0`	#
`integer`	`PERMISSION_ACCESS`	`1`	#
`integer`	`PERMISSION_CREATE`	`2`	#
`integer`	`PERMISSION_MAINTAIN`	`3`	#
`integer`	`PERMISSION_MANAGE`	`4`	#
`integer`	`PERMISSION_ADMINISTER`	`5`	#
`string`	`OPERATION_SAVE`	`'save'`	# Defines the name of the operation used to save the records of the module. Defines the name of the operation used to save the records of the module.
`string`	`OPERATION_DELETE`	`'delete'`	# Defines the name of the operation used to delete the records of the module. Defines the name of the operation used to delete the records of the module.

Properties summary

`protected array[string]mixed`	`$descriptor`	# The descriptor of the module. The descriptor of the module.
`protected array[string]ActiveRecord\Model`	`$models`	# Cache for loaded models. Cache for loaded models.

Magic properties

`public read-only array`	`$description`	# The description of the module. The description of the module.
`public read-only string`	`$flat_id`	# Underscored identifier. Underscored identifier.
`public read-only string`	`$id`	# The identifier of the module, defined by `ICanBoogie\Module::T_ID`. The identifier of the module, defined by `ICanBoogie\Module::T_ID`.
`public read-only ICanBoogie\ActiveRecord\Model`	`$model`	# The primary model of the module. The primary model of the module.
`public read-only ICanBoogie\Module`	`$parent`	# The parent module, defined by `ICanBoogie\Module::T_EXTENDS`. The parent module, defined by `ICanBoogie\Module::T_EXTENDS`.
`public read-only string`	`$path`	# The path to the module, defined by `ICanBoogie\Module::T_PATH`. The path to the module, defined by `ICanBoogie\Module::T_PATH`.
`public read-only string`	`$title`	# The localized title of the module. The localized title of the module.

Magic properties inherited from ICanBoogie\Object

$prototype

Namespaces

Classes

Interfaces

Traits

Exceptions

Constants

Functions

Class Module

Direct known subclasses

Indirect known subclasses

Methods summary

Returns

Returns

Returns

Parameters

Returns

Returns

Returns

Returns

Returns

Parameters

Returns

Parameters

Returns

Returns

Parameters

Returns

Throws

Parameters

Returns

Throws

Methods inherited from ICanBoogie\Object

Methods inherited from ICanBoogie\ToArrayRecursive

Methods used from ICanBoogie\ToArrayRecursiveTrait

Methods used from ICanBoogie\PrototypeTrait

Magic methods summary

Constants summary

Properties summary

Magic properties

Magic properties inherited from ICanBoogie\Object