Interface for working with settings.
| Methods | |
|---|---|
|
public
|
Returns the current settings context. |
|
public
|
Returns the value of a settings parameter. |
|
public
|
Returns the validator for the settings. |
|
public
|
Initializes the settings manager with parameters. |
|
public
|
Loads the settings from the persistence source. |
|
public
|
Saves the settings from to the persistence target. |
|
public
|
Sets the settings context. |
|
public
|
Sets a settings parameter. |
|
public
|
Sets settings parameters from an array. |
|
public
|
Sets the validator for the settings. |
|
public
|
Validates the current settings values. |
Returns the current settings context.
Settings might be edited not in one dialog, There can be several masks for different type of settings, or the settings can be configured in a wizard. In this case, only a subset of settings has to be saved and validated. To be able to write a flexible validator for the subsets, the $context is used. It can be - step1, step1, server_settings, db_connection_settings etc.
Returns the current settings context.
Returns the value of a settings parameter.
| Name | Pass type | Value type | Default value | Description |
|---|---|---|---|---|
| $name | by value | string |
The name of the settings parameter. |
|
| $default | by value | mixed|null | null |
The default value of the settings parameter if it is not set yet. The parameter is a conformable way to pre-set a parameter to a default value if its value is not set yet. However, if the status of the data is dirty and the unsaved last entered value is requested, then always the actual last entered value is returned and this parameter is ignored. |
Returns the value of the settings parameter.
Returns the validator for the settings.
Returns the validator for the settings or null if none is defined.
Initializes the settings manager with parameters.
| Name | Pass type | Value type | Default value | Description |
|---|---|---|---|---|
| $parameters | by value | array |
The parameters may vary for each settings manager. |
It might throw an exception in the case of any system errors.
Loads the settings from the persistence source.
It might throw an exception in the case of any errors.
Saves the settings from to the persistence target.
It might throw an exception in the case of any errors.
Sets the settings context.
Settings might be edited not in one dialog, There can be several masks for different type of settings, or the settings can be configured in a wizard. In this case, only a subset of settings has to be saved and validated. To be able to write a flexible validator for the subsets, the $context is used. It can be - step1, step1, server_settings, db_connection_settings etc.
| Name | Pass type | Value type | Default value | Description |
|---|---|---|---|---|
| $context | by value | string | "default" |
The settings context. |
Sets a settings parameter.
| Name | Pass type | Value type | Default value | Description |
|---|---|---|---|---|
| $name | by value | string |
The name of the settings parameter. |
|
| $value | by value | mixed |
The value of the settings parameter. |
Sets settings parameters from an array.
| Name | Pass type | Value type | Default value | Description |
|---|---|---|---|---|
| $parameters | by value | array |
Array of parameters in the form key => value. |
|
| $force_creation | by value | bool | false |
Flag which defines whether the parameter should be created if not exists. If false, only existing parameters are updated. |
Sets the validator for the settings.
| Name | Pass type | Value type | Default value | Description |
|---|---|---|---|---|
| $validator | by value | \SmartFactory\Interfaces\ISettingsValidator |
The settings validator. |
Validates the current settings values.
It should be called after settings the new values of the parameters and before their saving.
It might throw an exception if the content type oк JSON data is invalid.