StoreSettings ​
- Type
- Class
- Namespace
- craft\commerce\services
- Inherits
- craft\commerce\services\StoreSettings » yii\base\Component » yii\base\BaseObject
- Implements
- yii\base\Configurable
- Since
- 5.0
Store Settings service.
Public Properties ​
| Property | Description |
|---|---|
| allStoreSettings | \Illuminate\Support\Collection |
| behaviors | yii\base\Behavior – List of behaviors attached to this component. |
| store | craft\commerce\models\StoreSettings |
allStoreSettings ​
- Type
\Illuminate\Support\Collection- Default value
null- Access
- Read-only
store ​
- Type
- craft\commerce\models\StoreSettings
- Default value
null
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. |
| authorizeStoreLocationEdit() | |
| authorizeStoreLocationView() | |
| 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. |
| getAllStoreSettings() | |
| getBehavior() | Returns the named behavior object. |
| getBehaviors() | Returns all behaviors attached to this component. |
| getStoreSettingsById() | Returns the store record. |
| 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. |
| saveStoreSettings() | Saves the store |
| trigger() | Triggers an event. |
authorizeStoreLocationEdit() ​
Arguments ​
$event(craft\events\AuthorizationCheckEvent)
Returns ​
void
authorizeStoreLocationView() ​
Arguments ​
$event(craft\events\AuthorizationCheckEvent)
Returns ​
void
getAllStoreSettings() ​
Returns ​
\Illuminate\Support\Collection
Throws ​
getStoreSettingsById() ​
Returns the store record.
Arguments ​
$id(integer)
Returns ​
craft\commerce\models\StoreSettings
saveStoreSettings() ​
Saves the store
Arguments ​
$storeSettings(craft\commerce\models\StoreSettings)