SystemSettings

Type
Class
Namespace
craft\services
Inherits
craft\services\SystemSettings » yii\base\Component (opens new window) » yii\base\BaseObject (opens new window)
Implements
yii\base\Configurable (opens new window)
Since
3.0.0
Deprecated in
in 3.1.0. Use [[\craft\services\ProjectConfig]] instead.

System Settings service.

An instance of the System Settings service is globally accessible in Craft via Craft::$app->systemSettings.

View source (opens new window)

# Public Properties

# defaults

DEPRECATED

Deprecated in 3.1.0

Type
array (opens new window)
Default value
null

View source (opens new window)

# emailSettings

Type
craft\models\MailSettings
Default value
null
Access
Read-only

View source (opens new window)

# Public Methods

Method Description
__call() (opens new window) Calls the named method which is not a class method.
__clone() (opens new window) This method is called after the object is created by cloning an existing one.
__construct() (opens new window) Constructor.
__get() (opens new window) Returns the value of an object property.
__isset() (opens new window) Checks if a property is set, i.e. defined and not null.
__set() (opens new window) Sets value of an object property.
__unset() (opens new window) Sets an object property to null.
attachBehavior() (opens new window) Attaches a behavior to this component.
attachBehaviors() (opens new window) Attaches a list of behaviors to the component.
behaviors() (opens new window) Returns a list of behaviors that this component should behave as.
canGetProperty() (opens new window) Returns a value indicating whether a property can be read.
canSetProperty() (opens new window) Returns a value indicating whether a property can be set.
className() (opens new window) Returns the fully qualified name of this class.
detachBehavior() (opens new window) Detaches a behavior from the component.
detachBehaviors() (opens new window) Detaches all behaviors from the component.
ensureBehaviors() (opens new window) Makes sure that the behaviors declared in behaviors() (opens new window) are attached to this component.
getBehavior() (opens new window) Returns the named behavior object.
getBehaviors() (opens new window) 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() (opens new window) Returns a value indicating whether there is any handler attached to the named event.
hasMethod() (opens new window) Returns a value indicating whether a method is defined.
hasProperty() (opens new window) Returns a value indicating whether a property is defined.
init() (opens new window) Initializes the object.
off() (opens new window) Detaches an existing event handler from this component.
on() (opens new window) Attaches an event handler to an event.
saveSettings() Saves the system settings for a category.
trigger() (opens new window) Triggers an event.

# getEmailSettings()

DEPRECATED

Deprecated in 3.1.0. Use craft\helpers\App::mailSettings() instead.

Returns the email settings.

View source (opens new window)

Returns

craft\models\MailSettings

# getSetting()

DEPRECATED

Deprecated in 3.1.0. Use craft\services\ProjectConfig::get() instead.

Returns an individual system setting.

View source (opens new window)

Arguments

Returns

mixed

# getSettings()

DEPRECATED

Deprecated in 3.1.0. Use craft\services\ProjectConfig::get() instead.

Returns the system settings for a category.

View source (opens new window)

Arguments

Returns

array (opens new window)

# saveSettings()

DEPRECATED

Deprecated in 3.1.0. Use craft\services\ProjectConfig::set() instead.

Saves the system settings for a category.

View source (opens new window)

Arguments

Returns

boolean (opens new window) – Whether the new settings saved