Interface pheme\settings\models\SettingInterface
Implemented by | pheme\settings\models\Setting, pheme\settings\models\SettingSearch |
---|
Interface SettingInterface
Public Methods
Method | Description | Defined By |
---|---|---|
activateSetting() | Activates a setting | pheme\settings\models\SettingInterface |
deactivateSetting() | Deactivates a setting | pheme\settings\models\SettingInterface |
deleteAllSettings() | Deletes all settings! Be careful! | pheme\settings\models\SettingInterface |
deleteSetting() | Deletes a settings | pheme\settings\models\SettingInterface |
getSettings() | Gets all a combined map of all the settings. | pheme\settings\models\SettingInterface |
setSetting() | Saves a setting | pheme\settings\models\SettingInterface |
Method Details
Activates a setting
public abstract boolean activateSetting ( $section, $key ) | ||
$section | ||
$key | ||
return | boolean | True on success, false on error |
---|
Deactivates a setting
public abstract boolean deactivateSetting ( $section, $key ) | ||
$section | ||
$key | ||
return | boolean | True on success, false on error |
---|
Deletes all settings! Be careful!
public abstract boolean deleteAllSettings ( ) | ||
return | boolean | True on success, false on error |
---|
Deletes a settings
public abstract boolean deleteSetting ( $section, $key ) | ||
$section | ||
$key | ||
return | boolean | True on success, false on error |
---|
Gets all a combined map of all the settings.
public abstract array getSettings ( ) |
Saves a setting
public abstract bool setSetting ( $section, $key, $value, $type ) | ||
$section | ||
$key | ||
$value | ||
$type | ||
throws | \yii\base\InvalidConfigException |
---|