PluginStore

Type
Class
Namespace
craft\services
Inherits
craft\services\PluginStore » yii\base\Component » yii\base\BaseObject
Implements
yii\base\Configurable
Since
3.0.0

Plugin Store service.

An instance of the Plugin Store service is globally accessible in Craft via Craft::$app->pluginStore.

View source

# Public Properties

Property Description
behaviors yii\base\Behavior – List of behaviors attached to this component
craftApiEndpoint string – API endpoint
craftIdEndpoint string – Craft ID endpoint
craftIdOauthClientId string – CraftIdOauthClientId
craftOauthEndpoint string – OAuth endpoint
devServerManifestPath string – Dev server manifest path
devServerPublicPath string – Dev server public path
token craft\models\CraftIdToken, null
useDevServer boolean – Enable dev server

# craftApiEndpoint

Type
string

API endpoint

View source

# craftIdEndpoint

Type
string

Craft ID endpoint

View source

# craftIdOauthClientId

Type
string

CraftIdOauthClientId

View source

# craftOauthEndpoint

Type
string

OAuth endpoint

View source

# devServerManifestPath

Type
string

Dev server manifest path

View source

# devServerPublicPath

Type
string

Dev server public path

View source

# token

Type
craft\models\CraftIdToken, null
Access
Read-only

View source

# useDevServer

Type
boolean

Enable dev server

View source

# 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 an object property.
__isset() Checks if a property is set, i.e. defined and not null.
__set() Sets value of an object property.
__unset() Sets an object property to 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.
deleteToken() Deletes an OAuth token.
deleteTokenByUserId() Deletes the token from its user ID.
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.
getToken() Returns the OAuth token.
getTokenByUserId() Returns the token by user ID.
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.
init() Initializes the object.
off() Detaches an existing event handler from this component.
on() Attaches an event handler to an event.
saveToken() Saves the OAuth token.
trigger() Triggers an event.

# deleteToken()

Deletes an OAuth token.

View source

# deleteTokenByUserId()

Deletes the token from its user ID.

View source

Arguments

Returns

boolean

# getToken()

Returns the OAuth token.

View source

Returns

craft\models\CraftIdToken, null

# getTokenByUserId()

Returns the token by user ID.

View source

Arguments

  • $userId

Returns

craft\models\CraftIdToken, null

# saveToken()

Saves the OAuth token.

View source

Arguments