SystemSettings ​
- Type
- Class
- Namespace
- craft\services
- Inherits
- craft\services\SystemSettings » yii\base\Component » yii\base\BaseObject
- Implements
- yii\base\Configurable
- Since
- 3.0.0
- Deprecated in
- in 3.1.0. Use [[\craft\services\ProjectConfig]] instead.
System Settings service.
An instance of the service is available via Craft::$app->systemSettings.
Public Properties ​
| Property | Description |
|---|---|
| behaviors | yii\base\Behavior – List of behaviors attached to this component. |
| defaults | array |
| emailSettings | craft\models\MailSettings |
defaults ​
DEPRECATED
Deprecated in 3.1.0
- Type
- array
- Default value
null
emailSettings ​
- Type
- craft\models\MailSettings
- Default value
null- Access
- Read-only
Public Methods ​
| Method | Description |
|---|---|
| __call() | Calls the named method which is not a class method. |
| __clone() | This method is called after the object is created by cloning an existing one. |
| __construct() | Constructor. |
| __get() | Returns the value of a component property. |
| __isset() | Checks if a property is set, i.e. defined and not null. |
| __set() | Sets the value of a component property. |
| __unset() | Sets a component property to be null. |
| attachBehavior() | Attaches a behavior to this component. |
| attachBehaviors() | Attaches a list of behaviors to the component. |
| behaviors() | Returns a list of behaviors that this component should behave as. |
| canGetProperty() | Returns a value indicating whether a property can be read. |
| canSetProperty() | Returns a value indicating whether a property can be set. |
| className() | Returns the fully qualified name of this class. |
| detachBehavior() | Detaches a behavior from the component. |
| detachBehaviors() | Detaches all behaviors from the component. |
| ensureBehaviors() | Makes sure that the behaviors declared in behaviors() are attached to this component. |
| getBehavior() | Returns the named behavior object. |
| getBehaviors() | Returns all behaviors attached to this component. |
| getEmailSettings() | Returns the email settings. |
| getSetting() | Returns an individual system setting. |
| getSettings() | Returns the system settings for a category. |
| hasEventHandlers() | Returns a value indicating whether there is any handler attached to the named event. |
| hasMethod() | Returns a value indicating whether a method is defined. |
| hasProperty() | Returns a value indicating whether a property is defined for this component. |
| init() | Initializes the object. |
| off() | Detaches an existing event handler from this component. |
| on() | Attaches an event handler to an event. |
| saveSettings() | Saves the system settings for a category. |
| trigger() | Triggers an event. |
getEmailSettings() ​
DEPRECATED
Deprecated in 3.1.0. Use craft\helpers\App::mailSettings() instead.
Returns the email settings.
Returns ​
getSetting() ​
DEPRECATED
Deprecated in 3.1.0. Use craft\services\ProjectConfig::get() instead.
Returns an individual system setting.
Arguments ​
Returns ​
mixed
getSettings() ​
DEPRECATED
Deprecated in 3.1.0. Use craft\services\ProjectConfig::get() instead.
Returns the system settings for a category.
Arguments ​
$category(string)
Returns ​
saveSettings() ​
DEPRECATED
Deprecated in 3.1.0. Use craft\services\ProjectConfig::set() instead.
Saves the system settings for a category.
Arguments ​
Returns ​
boolean – Whether the new settings saved