Class ModuleCollection

A module collection.

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

Namespace: ICanBoogie\Module
Located at ModuleCollection.php

Methods summary

`public static string`	# `format_model_name( string $module_id, string $model_id = 'primary' )` Formats a SQL table name given the module id and the model id. Formats a SQL table name given the module id and the model id. Parameters `$module_id` `$model_id` Returns string
`public`	# `__construct( array $paths, ICanBoogie\Storage\Storage $cache = null )` The index for the available modules is created with the accessor object. The index for the available modules is created with the accessor object. Parameters `$paths` The paths to look for modules. `$cache` The cache to use for the module indexes.
`protected`	# `revoke_constructions( )` Revokes constructions. Revokes constructions. The following properties are revoked: $enabled_modules_descriptors $disabled_modules_descriptors $catalog_paths $config_paths The method is usually invoked when modules state changes, in order to reflect these changes.
`public`	# `enable( string $id )` Enables a module. Enables a module. Parameters `$id` Identifier of the module.
`public`	# `disable( string $id )` Disables a module. Disables a module. Parameters `$id` Identifier of the module.
`public`	# `offsetSet( mixed $id, mixed $enable )` Used to enable or disable a module using the specified offset as the module's id. Used to enable or disable a module using the specified offset as the module's id. The module is enabled or disabled by modifying the value of the Descriptor::DISABLED key of the module's descriptor. Parameters `$id` Identifier of the module. `$enable` Status of the module: `true` for enabled, `false` for disabled. Implementation of `ArrayAccess::offsetSet()`
`public boolean`	# `offsetExists( string $id )` Checks the availability of a module. 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 `$id` Identifier of the module. Returns boolean Whether or not the module is available. Implementation of `ArrayAccess::offsetExists()`
`public`	# `offsetUnset( string $id )` Disables a module by setting the Descriptor::DISABLED key of its descriptor to `true`. Disables a module by setting the Descriptor::DISABLED key of its descriptor to `true`. The method also dismisses the enabled_modules_descriptors and disabled_modules_descriptors properties. Parameters `$id` Identifier of the module. Implementation of `ArrayAccess::offsetUnset()`
`public ICanBoogie\Module`	# `offsetGet( string $id )` Returns a module object. 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 `$id` The identifier of the module. 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 ArrayIterator`	# `getIterator( )` Returns an iterator for the modules. Returns an iterator for the modules. Returns ArrayIterator Implementation of `IteratorAggregate::getIterator()`
`protected array`	# `lazy_get_index( )` Indexes the modules found in the paths specified during construct. 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 array`	# `index_construct( )` Construct the index for the modules. 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 array[string]array`	# `index_descriptors( array $paths )` Indexes descriptors. 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[string]array
`protected`	# `collect_descriptors( array $paths )`
`protected array`	# `read_descriptor( string $id, string $path )` Reads the descriptor file. Reads the descriptor file. The descriptor file is extended with private values and default values. Parameters `$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 array`	# `alter_descriptor( array $descriptor )` Alters the module descriptor. Alters the module descriptor. Parameters `$descriptor` Descriptor of the module to index. Returns array The altered descriptor.
`protected array`	# `lazy_get_disabled_modules_descriptors( )` Returns the descriptors of the disabled modules. Returns the descriptors of the disabled modules. This method is the getter for the $disabled_modules_descriptors magic property. Returns array
`protected array`	# `lazy_get_enabled_modules_descriptors( )` Returns the descriptors of the enabled modules. Returns the descriptors of the enabled modules. This method is the getter for the $enabled_modules_descriptors magic property. Returns array
`protected array[]string`	# `lazy_get_locale_paths( )` Returns the paths of the enabled modules which have a `locale` folder. Returns the paths of the enabled modules which have a `locale` folder. Returns array[]string
`protected array[]string`	# `lazy_get_config_paths( )` Returns the paths of the enabled modules which have a `config` folder. Returns the paths of the enabled modules which have a `config` folder. Returns array[]string
`public array`	# `order_ids( array $ids, array $descriptors = null )` Orders the module ids provided according to module inheritance and weight. Orders the module ids provided according to module inheritance and weight. Parameters `$ids` The module ids to order. `$descriptors` Module descriptors. Returns array
`public array`	# `filter_descriptors_by_users( string $module_id, boolean $all = self::ONLY_ENABLED_MODULES )` Returns the modules using a module. Returns the modules using a module. Parameters `$module_id` Used module identifier. `$all` One of `ICanBoogie\Module\ModuleCollection::ONLY_ENABLED_MODULES` or `ICanBoogie\Module\ModuleCollection::ALL_MODULES`. Default: `ICanBoogie\Module\ModuleCollection::ONLY_ENABLED_MODULES`. Returns array A array of filtered descriptors.
`public integer`	# `usage( string $module_id, boolean $all = self::ONLY_ENABLED_MODULES )` Returns the usage of a module by other modules. Returns the usage of a module by other modules. Parameters `$module_id` The identifier of the module. `$all` One of `ICanBoogie\Module\ModuleCollection::ONLY_ENABLED_MODULES` or `ICanBoogie\Module\ModuleCollection::ALL_MODULES`. Default: `ICanBoogie\Module\ModuleCollection::ONLY_ENABLED_MODULES`. Returns integer
`public boolean`	# `is_inheriting( string $module_id, string $parent_id )` Checks if a module inherits from another. Checks if a module inherits from another. Parameters `$module_id` Module identifier. `$parent_id` Identifier of the parent module. Returns boolean `true` if the module inherits from the other.
`public ICanBoogie\Errors`	# `install( ICanBoogie\Errors $errors = null )` Install all the enabled modules. Install all the enabled modules. Parameters `$errors` Returns ICanBoogie\Errors Throws `ICanBoogie\Module\ModuleCollectionInstallFailed` if an error occurs.
`public string\|false`	# `resolve_classname( string $unqualified_classname, string\|ICanBoogie\Module $module )` Resolves a class name using module inheritance. 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` 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.

Constants summary

`boolean`	`ONLY_ENABLED_MODULES` May be used with the `ICanBoogie\Module\ModuleCollection::filter_descriptors_by_users()` method to filter the descriptors of enabled modules. May be used with the `ICanBoogie\Module\ModuleCollection::filter_descriptors_by_users()` method to filter the descriptors of enabled modules.	# `false`
`boolean`	`ALL_MODULES` May be used with the `ICanBoogie\Module\ModuleCollection::filter_descriptors_by_users()` method to filter the descriptors of all modules, enabled or not. 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 array`	`$descriptors` The descriptors for the modules. The descriptors for the modules.	# `[]`
`protected array`	`$paths` The paths where modules can be found. The paths where modules can be found.	# `[]`
`protected ICanBoogie\Storage\Storage`	`$cache` A cache for the modules index. A cache for the modules index.	#
`protected ICanBoogie\Module[]`	`$modules` Instantiated modules. Instantiated modules.	# `[]`

Magic properties

`public read-only array`	`$config_paths` Paths of the enabled modules having a `config` directory.
`public read-only array`	`$locale_paths` Paths of the enabled modules having a `locale` directory.
`public read-only array`	`$disabled_modules_descriptors` Descriptors of the disabled modules.
`public read-only array`	`$enabled_modules_descriptors` Descriptors of the enabled modules.
`public read-only array`	`$index` Index for the modules.

Namespaces

Classes

Traits

Exceptions

Class ModuleCollection

Methods summary

Parameters

Returns

Parameters

Parameters

Parameters

Parameters

Implementation of

Parameters

Returns

Implementation of

Parameters

Implementation of

Parameters

Returns

Throws

Implementation of

Returns

Implementation of

Returns

Returns

Parameters

Returns

Parameters

Returns

Throws

Parameters

Returns

Returns

Returns

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Throws

Parameters

Returns

Throws

Constants summary

Properties summary

Magic properties