Class ModuleCollection

A module collection.

ICanBoogie\Module\ModuleCollection implements ArrayAccess, IteratorAggregate uses ICanBoogie\Accessor\AccessorTrait (not available)

Namespace: ICanBoogie\Module
Located at Module/ModuleCollection.php

Methods summary


				
				 public static
				
				

				format_model_name( string $module_id, string $model_id = 'primary' )
				

				: string

Formats a SQL table name given the module id and the model id.


				
				 public 
				
				

				__construct( array $paths, ICanBoogie\Storage\Storage $cache = null )

The index for the available modules is created with the accessor object.


				
				 protected 
				
				

				revoke_constructions( void )

Revokes constructions.


				
				 public 
				
				

				enable( string $module_id )

Enables a module.


				
				 public 
				
				

				disable( string $module_id )

Disables a module.


				
				 public 
				
				

				offsetSet( string $module_id, boolean $enable )

Used to enable or disable a module using the specified offset as a module identifier.

Parameters

$module_id: Identifier of the module.
$enable: Status of the module: true for enabled, false for disabled.

Implementation of

ArrayAccess::offsetSet()


				
				 public 
				
				

				offsetUnset( string $module_id )

Disables a module by setting the Descriptor::DISABLED key of its descriptor to true.


				
				 public 
				
				

				offsetExists( string $module_id )
				

				: boolean

Checks the availability of a module.

A module is considered available when its descriptor is defined, and the Descriptor::DISABLED key of its descriptor is empty.

Note: empty() will call ICanBoogie\Module\ModuleCollection::offsetGet() to check if the value is not empty. So, unless you want to use the module you check, better check using !isset(), otherwise the module you check is loaded too.

Parameters

$module_id: Module identifier.

Returns

boolean
Whether or not the module is available.

Implementation of

ArrayAccess::offsetExists()


				
				 public 
				
				

				offsetGet( string $module_id )
				

				: ICanBoogie\Module

Returns a module object.

If the autorun property is true, the ICanBoogie\Module\Module::run() method of the module is invoked upon its first loading.

Parameters

$module_id: Module identifier.

Returns

ICanBoogie\Module

Throws

ICanBoogie\Module\ModuleNotDefined
when the requested module is not defined.
ICanBoogie\Module\ModuleIsDisabled
when the module is disabled.
ICanBoogie\Module\ModuleConstructorMissing

when the class that should be used to create its instance is not defined.

Implementation of

ArrayAccess::offsetGet()


				
				 public 
				
				

				getIterator( void )
				

				: ArrayIterator

Returns an iterator for instantiated modules.


				
				 public 
				
				

				filter_descriptors( callable $filter )
				

				: array

Filter descriptors.


				
				 public 
				
				

				filter_descriptors_by_users( string $module_id, boolean $all = self::ONLY_ENABLED_MODULES )
				

				: array

Returns the modules using a module.


				
				 protected 
				
				

				lazy_get_index( void )
				

				: array

Indexes the modules found in the paths specified during construct.

The index is made of an array of descriptors, an array of catalogs paths, an array of configs path, and finally an array of configs constructors.

The method also creates a DIR constant for each module. The constant is defined in the namespace of the module e.g. Icybee\ModuleCollection\Nodes\DIR.

Returns

array


				
				 protected 
				
				

				index_modules( void )
				

				: array

Construct the index for the modules.

The index contains the following values:

(array) descriptors: The descriptors of the modules, ordered by weight.
(array) catalogs: Absolute paths to locale catalog directories.
(array) configs: Absolute paths to config directories.
(array) classes aliases: An array of key/value pairs where key is the alias of a class and value if the real class.

Returns

array


				
				 protected 
				
				

				index_descriptors( array $paths )
				

				: array

Indexes descriptors.

The descriptors are extended with the following default values:

(string) category: null.
(string) class: ModuleCollection\
(string) description: null.
(bool) disabled: false if required, true otherwise.
(string) extends: null.
(string) id: The module's identifier.
(array) models: Empty array.
(string) path: The absolute path to the module directory.
(string) permission: null.
(array) permissions: Empty array.
(bool) startup: false.
(bool) required: false.
(array) requires: Empty array.
(string) weight: 0.

The descriptors are ordered according to their inheritance and weight.

Parameters

$paths

Returns

array


				
				 protected 
				
				

				collect_descriptors( array $paths )
				

				: array

Collects descriptors from paths.


				
				 protected 
				
				

				read_descriptor( string $module_id, string $path )
				

				: array

Reads the descriptor file.

The descriptor file is extended with private values and default values.

Parameters

$module_id: The identifier of the module.
$path: The path to the directory where the descriptor is located.

Returns

array

Throws

InvalidArgumentException

in the following situations: - The descriptor is not an array - The Descriptor::TITLE key is empty. - The Descriptor::NS key is empty.


				
				 protected 
				
				

				alter_descriptor( array $descriptor )
				

				: array

Alters the module descriptor.


				
				 protected 
				
				

				lazy_get_disabled_modules_descriptors( void )
				

				: array

Returns the descriptors of the disabled modules.


				
				 protected 
				
				

				lazy_get_enabled_modules_descriptors( void )
				

				: array

Returns the descriptors of the enabled modules.


				
				 protected 
				
				

				lazy_get_locale_paths( void )
				

				: array

Returns the paths of the enabled modules which have a locale folder.


				
				 protected 
				
				

				lazy_get_config_paths( void )
				

				: array

Returns the paths of the enabled modules which have a config folder.


				
				 public 
				
				

				order_ids( array $ids, array $descriptors = null )
				

				: array

Orders the module ids provided according to module inheritance and weight.


				
				 public 
				
				

				usage( string $module_id, boolean $all = self::ONLY_ENABLED_MODULES )
				

				: integer

Returns the usage of a module by other modules.


				
				 public 
				
				

				is_inheriting( string $module_id, string $parent_id )
				

				: boolean

Checks if a module inherits from another.


				
				 public 
				
				

				install( ICanBoogie\ErrorCollection $errors = null )
				

				: ICanBoogie\ErrorCollection

Install all the enabled modules.


				
				 public 
				
				

				resolve_classname( string $unqualified_classname, string|ICanBoogie\Module $module_id, array & $tried = [] )
				

				: string|false

Resolves a class name using module inheritance.

To resolve a given class name, the method checks in each module namespace—starting from the specified module—if the class exists. If it does, it returns its fully qualified name.

Parameters

$unqualified_classname
$module_id
$tried

Returns

string|false
The resolved file name, or false if it could not be resolved.

Throws

ICanBoogie\Module\ModuleNotDefined

if the specified module, or the module specified by Descriptor::INHERITS is not defined.


				
				 protected 
				
				

				change_module_availability( string $module_id, boolean $available )

Changes a module availability.


				
				 protected 
				
				

				ensure_modules_are_indexed( void )

Ensures that modules are indexed, index them if not.


				
				 protected 
				
				

				assert_module_is_defined( string $module_id )

Asserts that a module is defined.


				
				 protected 
				
				

				assert_module_is_enabled( string $module_id )

Asserts that a module is enabled.


				
				 protected 
				
				

				assert_constructor_exists( string $module_id, string $class )

Asserts that a module constructor exists.


				
				 protected 
				
				

				instantiate_module( string $module_id )
				

				: ICanBoogie\Module

Instantiate a module.


				
				 protected 
				
				

				define_constants( array $descriptors )

Defines module constants.

Constants summary


				
ONLY_ENABLED_MODULES				

                : boolean

May be used with the ICanBoogie\Module\ModuleCollection::filter_descriptors_by_users() method to filter the descriptors of enabled modules.

false


				
ALL_MODULES				

                : boolean

May be used with the ICanBoogie\Module\ModuleCollection::filter_descriptors_by_users() method to filter the descriptors of all modules, enabled or not.

true

Properties summary


				
				public  
				

				
$descriptors				

				: array

The descriptors for the modules.

[]


				
				protected  
				

				
$paths				

				: array

The paths where modules can be found.

[]


				
				protected  
				

				
$cache				

				: ICanBoogie\Storage\Storage

A cache for the modules index.


				
				protected  
				

				
$modules				

				: ICanBoogie\Module[]

Instantiated modules.

[]

Magic properties


				
				public  read-only
				

				
$config_paths				

				: array

Paths of the enabled modules having a config directory.


				
				public  read-only
				

				
$locale_paths				

				: array

Paths of the enabled modules having a locale directory.


				
				public  read-only
				

				
$disabled_modules_descriptors				

				: array

Descriptors of the disabled modules.


				
				public  read-only
				

				
$enabled_modules_descriptors				

				: array

Descriptors of the enabled modules.


				
				public  read-only
				

				
$index				

				: array

Index for the modules.