Class craft\services\SystemSettings
- Inheritance
- craft\services\SystemSettings » yii\base\Component » yii\base\BaseObject
- Implements
- yii\base\Configurable
- Available since version
- 3.0
- Source Code
- https://github.com/craftcms/cms/blob/master/src/services/SystemSettings.php
System Settings service.
An instance of the System Settings service is globally accessible in Craft via Craft::$app->systemSettings.
| Property | Type | Description | Defined By |
|---|---|---|---|
$defaults |
craft\services\SystemSettings |
| Method | Description | Defined By |
|---|---|---|
__call() |
Calls the named method which is not a class method. | yii\base\BaseObject |
__clone() |
This method is called after the object is created by cloning an existing one. | yii\base\Component |
__construct() |
Constructor. | yii\base\BaseObject |
__get() |
Returns the value of an object property. | yii\base\BaseObject |
__isset() |
Checks if a property is set, i.e. defined and not null. | yii\base\BaseObject |
__set() |
Sets value of an object property. | yii\base\BaseObject |
__unset() |
Sets an object property to null. | yii\base\BaseObject |
attachBehavior() |
Attaches a behavior to this component. | yii\base\Component |
attachBehaviors() |
Attaches a list of behaviors to the component. | yii\base\Component |
behaviors() |
Returns a list of behaviors that this component should behave as. | yii\base\Component |
canGetProperty() |
Returns a value indicating whether a property can be read. | yii\base\BaseObject |
canSetProperty() |
Returns a value indicating whether a property can be set. | yii\base\BaseObject |
className() |
Returns the fully qualified name of this class. | yii\base\BaseObject |
detachBehavior() |
Detaches a behavior from the component. | yii\base\Component |
detachBehaviors() |
Detaches all behaviors from the component. | yii\base\Component |
ensureBehaviors() |
Makes sure that the behaviors declared in behaviors() are attached to this component. | yii\base\Component |
getBehavior() |
Returns the named behavior object. | yii\base\Component |
getBehaviors() |
Returns all behaviors attached to this component. | yii\base\Component |
getEmailSettings() |
Returns the email settings. | craft\services\SystemSettings |
getSetting() |
Returns an individual system setting. | craft\services\SystemSettings |
getSettings() |
Returns the system settings for a category. | craft\services\SystemSettings |
hasEventHandlers() |
Returns a value indicating whether there is any handler attached to the named event. | yii\base\Component |
hasMethod() |
Returns a value indicating whether a method is defined. | yii\base\BaseObject |
hasProperty() |
Returns a value indicating whether a property is defined. | yii\base\BaseObject |
init() |
Initializes the object. | yii\base\BaseObject |
off() |
Detaches an existing event handler from this component. | yii\base\Component |
on() |
Attaches an event handler to an event. | yii\base\Component |
saveSettings() |
Saves the system settings for a category. | craft\services\SystemSettings |
trigger() |
Triggers an event. | yii\base\Component |
Property Details
$defaults
public property
#
public $defaults = nullMethod Details
getEmailSettings()
public method
#
Returns the email settings.
public craft\models\MailSettings getEmailSettings ( )
getSetting()
public method
#
Returns an individual system setting.
public mixed getSetting ( \craft\services\string $category, \craft\services\string $key )$category |
string | |
$key |
string |
getSettings()
public method
#
Returns the system settings for a category.
public array getSettings ( \craft\services\string $category )$category |
string |
saveSettings()
public method
#
Saves the system settings for a category.
public boolean saveSettings ( \craft\services\string $category, array $settings = null )$category |
string | |
$settings |
array, null | |
| return | boolean | Whether the new settings saved |
|---|