Class Module

A module of the framework.

ICanBoogie\Object

┗ ICanBoogie\Module

Namespace: ICanBoogie
Located at Module.php

Methods summary


				
				 protected 
				
				

				get_id( void )
				

				: string

Returns the identifier of the module as defined by its descriptor.


				
				 protected 
				
				

				get_path( void )
				

				: string

Returns the path of the module as defined by its descriptor.


				
				 protected 
				
				

				get_collection( void )
				

				: ICanBoogie\Module\ModuleCollection


				
				 protected 
				
				

				get_descriptor( void )
				

				: array

Returns the descriptor of the module.


				
				 public 
				
				

				__construct( ICanBoogie\Module\ModuleCollection $collection, array $descriptor )

Constructor.


				
				 public 
				
				

				__toString( void )
				

				: string

Returns the identifier of the module.


				
				 protected 
				
				

				get_flat_id( void )
				

				: string

Returns the flat version of the module's identifier.


				
				 protected 
				
				

				get_model( void )
				

				: ActiveRecord\Model

Returns the primary model of the module.


				
				 protected 
				
				

				get_title( void )
				

				: string

Returns the module title, translated to the current language.


				
				 protected 
				
				

				get_parent( void )
				

				: ICanBoogie\Module|null

Returns the parent module.


				
				 public 
				
				

				is_installed( ICanBoogie\Errors $errors )
				

				: mixed

Checks if the module is installed.


				
				 public 
				
				

				install( ICanBoogie\Errors $errors )
				

				: boolean|null

Install the module.

If the module has models they are installed.

Parameters

$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 
				
				

				uninstall( void )
				

				: boolean|null

Uninstall the module.


				
				 public 
				
				

				model( string $which = 'primary' )
				

				: ICanBoogie\ActiveRecord\Model

Get a model from the module.

If the model has not been created yet, it is created on the fly.

Parameters

$which: The identifier of the model to get.

Returns

ICanBoogie\ActiveRecord\Model
The requested model.

Throws

ICanBoogie\ActiveRecord\ModelNotDefined
when the model is not defined by the module.
RuntimeException
when the class of the model does not exists.


				
				 protected 
				
				

				resolve_model_tags(  $tags,  $which )


				
				 public 
				
				

				getBlock( string $name )
				

				: mixed

Get a block.

Parameters

$name: The name of the block to get.

Returns

mixed

Depends on the implementation. Should return a string or an object implementing __toString.

Throws

RuntimeException
if the block is not defined.

Constants summary


				
T_CATEGORY				

                : string

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.

Deprecated

'category'


				
T_CLASS				

                : string

Defines the PHP class of the module.

'class'


				
T_DESCRIPTION				

                : string

Defines a short description of what the module do.

'description'


				
T_DISABLED				

                : boolean

Defines the state of the module.

'disabled'


				
T_EXTENDS				

                : string|ICanBoogie\Module

Defines the module that the module extends.

'extends'


				
T_ID				

                : string

Defines the identifier of the module.

'id'


				
T_REQUIRED				

                : boolean

Defines the state of the module.

'required'


				
T_REQUIRES				

                : array[string]string

Defines the modules that the module requires.

'requires'


				
T_MODELS				

                : array[string]array|string

Defines the models of the module.

'models'


				
T_NAMESPACE				

                : string

Defines the namespace of the module.

'namespace'


				
T_PATH				

                : string

Path to the module's directory.

'path'


				
T_PERMISSION				

                : string|integer

General permission of the module.

'permission'


				
T_PERMISSIONS				

                : array[]string

Defines the permissions added by the module.

'permissions'


				
T_TITLE				

                : string

Defines the title of the module.

'title'


				
T_VERSION				

                : string

Defines the version (and revision) of the module.

'version'


				
T_WEIGHT				

                : integer

Defines the weight of the module.

'weight'


				
PERMISSION_NONE				

                : integer


				
PERMISSION_ACCESS				

                : integer


				
PERMISSION_CREATE				

                : integer


				
PERMISSION_MAINTAIN				

                : integer


				
PERMISSION_MANAGE				

                : integer


				
PERMISSION_ADMINISTER				

                : integer


				
OPERATION_SAVE				

                : string

Defines the name of the operation used to save the records of the module.

'save'


				
OPERATION_DELETE				

                : string

Defines the name of the operation used to delete the records of the module.

'delete'

Properties summary


				
				protected  
				

				
$descriptor				

				: array

The descriptor of the module.


				
				protected  
				

				
$models				

				: ActiveRecord\Model[]

Cache for loaded models.

[]

Magic properties


				
				public  read-only
				

				
$descriptor				

				: array

The descriptor of the module.


				
				public  read-only
				

				
$flat_id				

				: string

Underscored identifier.


				
				public  read-only
				

				
$id				

				: string

The identifier of the module, defined by ICanBoogie\Descriptor::ID.


				
				public  read-only
				

				
$model				

				: ICanBoogie\ActiveRecord\Model

The primary model of the module.


				
				public  read-only
				

				
$parent				

				: ICanBoogie\Module

The parent module, defined by ICanBoogie\Descriptor::INHERITS.


				
				public  read-only
				

				
$path				

				: string

The path to the module, defined by ICanBoogie\Descriptor::PATH.


				
				public  read-only
				

				
$title				

				: string

The localized title of the module.


				
				public  read-only
				

				
$collection				

				: ICanBoogie\Module\ModuleCollection


				
				public  read-only
				

				
$app				

				: Core