Class lispa\amos\admin\base\ConfigurationManager
| Inheritance | lispa\amos\admin\base\ConfigurationManager » yii\base\Object |
|---|---|
| Implements | yii\base\Configurable |
Class ConfigurationManager
Public Properties
| Property | Type | Description | Defined By |
|---|---|---|---|
| $fieldsConfigurations | array | This array contains all configurations for boxes and fields. | lispa\amos\admin\base\ConfigurationManager |
| $formFields | array | lispa\amos\admin\base\ConfigurationManager | |
| $viewFields | array | lispa\amos\admin\base\ConfigurationManager |
Public Methods
| Method | Description | Defined By |
|---|---|---|
| __call() | Calls the named method which is not a class method. | yii\base\Object |
| __construct() | Constructor. | yii\base\Object |
| __get() | Returns the value of an object property. | yii\base\Object |
| __isset() | Checks if a property is set, i.e. defined and not null. | yii\base\Object |
| __set() | Sets value of an object property. | yii\base\Object |
| __unset() | Sets an object property to null. | yii\base\Object |
| canGetProperty() | Returns a value indicating whether a property can be read. | yii\base\Object |
| canSetProperty() | Returns a value indicating whether a property can be set. | yii\base\Object |
| checkFieldsConfigurationsStructure() | lispa\amos\admin\base\ConfigurationManager | |
| className() | Returns the fully qualified name of this class. | yii\base\Object |
| getFormFields() | This method return all fields visible in the form. It checks if a field is in a box. | lispa\amos\admin\base\ConfigurationManager |
| getViewFields() | This method return all fields visible in the view. It checks if a field is in a box. | lispa\amos\admin\base\ConfigurationManager |
| hasMethod() | Returns a value indicating whether a method is defined. | yii\base\Object |
| hasProperty() | Returns a value indicating whether a property is defined. | yii\base\Object |
| init() | Initializes the object. | yii\base\Object |
| isVisibleBox() | This method check if a box is visible in form or view. | lispa\amos\admin\base\ConfigurationManager |
| isVisibleField() | This method check if a field is visible in form or view. | lispa\amos\admin\base\ConfigurationManager |
Constants
| Constant | Value | Description | Defined By |
|---|---|---|---|
| CONF_TYPE_BOXES | 'boxes' | lispa\amos\admin\base\ConfigurationManager | |
| CONF_TYPE_FIELDS | 'fields' | lispa\amos\admin\base\ConfigurationManager | |
| VIEW_TYPE_FORM | 'form' | lispa\amos\admin\base\ConfigurationManager | |
| VIEW_TYPE_VIEW | 'view' | lispa\amos\admin\base\ConfigurationManager |
Property Details
This array contains all configurations for boxes and fields.
Method Details
| public void checkFieldsConfigurationsStructure ( ) | ||
| throws | lispa\amos\admin\exceptions\AdminException | |
|---|---|---|
This method return all fields visible in the form. It checks if a field is in a box.
If it's of a box, it checks if the box is also visible. In case a field is visible but the box is not visible, the method don't add the field in the form fields array because a field is visible only if is visible also the container box. In case a field is not in a box, the method checks only the field visibility.
| public array getFormFields ( ) |
This method return all fields visible in the view. It checks if a field is in a box.
If it's of a box, it checks if the box is also visible. In case a field is visible but the box is not visible, the method don't add the field in the view fields array because a field is visible only if is visible also the container box. In case a field is not in a box, the method checks only the field visibility.
| public array getViewFields ( ) |
This method check if a box is visible in form or view.
| public boolean isVisibleBox ( $name, $viewType ) | ||
| $name | string | |
| $viewType | string | |
This method check if a field is visible in form or view.
| public boolean isVisibleField ( $name, $viewType ) | ||
| $name | string | |
| $viewType | string | |