Interface pheme\settings\models\SettingInterface

All Classes | Methods
Implemented bypheme\settings\models\Setting, pheme\settings\models\SettingSearch

Interface SettingInterface

Public Methods

Hide inherited methods

MethodDescriptionDefined 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

activateSetting() public abstract method

Activates a setting

public abstract boolean activateSetting ( $section, $key )
$section
$key
return boolean

True on success, false on error
deactivateSetting() public abstract method

Deactivates a setting

public abstract boolean deactivateSetting ( $section, $key )
$section
$key
return boolean

True on success, false on error
deleteAllSettings() public abstract method

Deletes all settings! Be careful!

public abstract boolean deleteAllSettings ( )
return boolean

True on success, false on error
deleteSetting() public abstract method

Deletes a settings

public abstract boolean deleteSetting ( $section, $key )
$section
$key
return boolean

True on success, false on error
getSettings() public abstract method

Gets all a combined map of all the settings.

public abstract array getSettings ( )
setSetting() public abstract method

Saves a setting

public abstract bool setSetting ( $section, $key, $value, $type )
$section
$key
$value
$type
throws \yii\base\InvalidConfigException