Class ModulesConfig

__construct()

__construct() 

Constructs a AbstractConfigData object

• Inherited from \AbstractConfigData

Tags

None found

synchronize()

synchronize() 

This method is not used in the configuration context.

{@inheritdoc}

final

• Inherited from \AbstractConfigData

Tags

None found

set_default_values()

set_default_values() 

Redefine this method if you want to avoid getting errors while asking values.

If some entries doesn't exist, they can be created here.

• Inherited from \AbstractConfigData

Tags

None found

get_property()

get_property(string $name) : string

Reads a property's value.

Parameters

string

$name

Name of the property to read

Returns

string —

the read value

• Inherited from \AbstractConfigData

Tags

None found

set_property()

set_property(string $name, string $value) 

Sets a property value. If the property exists, it overrides its value, otherwise, it creates an entry for this property.

Parameters

string	$name	Name of the property
string	$value	Value of the property

• Inherited from \AbstractConfigData

Tags

None found

get_default_values()

get_default_values() : \string[mixed]

Returns a map associating to each property name the corresponding default value

Returns

\string[mixed]

• Inherited from \ModulesConfig

Tags

None found

get_modules()

get_modules() : array

Returns the list of the modules

Returns

array —

id_module => module properties (map)

• Inherited from \ModulesConfig

Tags

None found

get_module()

get_module( $module_id) : \Module

Returns the requested module

Parameters

$module_id

the id of the module

Returns

\Module —

the requested module

• Inherited from \ModulesConfig

Tags

None found

set_modules()

set_modules(array $modules) 

Sets the modules list

Parameters

array

$modules

• Inherited from \ModulesConfig

Tags

None found

add_module()

add_module(\Module $module) 

Install a new module

Parameters

\Module

$module

• Inherited from \ModulesConfig

Tags

None found

remove_module()

remove_module(\Module $module) 

Parameters

\Module

$module

• Inherited from \ModulesConfig

Tags

None found

remove_module_by_id()

remove_module_by_id( $module_id) 

Parameters

$module_id

• Inherited from \ModulesConfig

Tags

None found

update()

update(\Module $module) 

Parameters

\Module

$module

• Inherited from \ModulesConfig

Tags

None found

load()

load() : \ModulesConfig

Loads and returns the modules cached data.

Returns

\ModulesConfig —

The cached data

static

• Inherited from \ModulesConfig

Tags

None found

save()

save() 

Invalidates the current modules cached data.

static

• Inherited from \ModulesConfig

Tags

None found

get_default_value()

get_default_value( $property) 

Parameters

$property

• Inherited from \AbstractConfigData

Tags

None found