Skip to content

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 service is available via Craft::$app->pluginStore.

View source

Public Properties

PropertyDescription
behaviorsyii\base\Behavior – List of behaviors attached to this component.
craftApiEndpointstring – API endpoint
craftIdEndpointstring – Craft Console endpoint
craftIdOauthClientIdstring – CraftIdOauthClientId
craftOauthEndpointstring – OAuth endpoint
devServerManifestPathstring – Dev server manifest path
devServerPublicPathstring – Dev server public path
tokencraft\models\CraftIdToken, null
useDevServerboolean – Enable dev server

craftApiEndpoint

Type
string
Default value
'https://api.craftcms.com/v1'

API endpoint

View source

craftIdEndpoint

Type
string
Default value
'https://console.craftcms.com'

Craft Console endpoint

View source

craftIdOauthClientId

Type
string
Default value
'6DvEra7eqRKLYic9fovyD2FWFjYxRwZn'

CraftIdOauthClientId

View source

craftOauthEndpoint

Type
string
Default value
'https://console.craftcms.com/oauth'

OAuth endpoint

View source

devServerManifestPath

Type
string
Default value
'https://localhost:8082/'

Dev server manifest path

View source

devServerPublicPath

Type
string
Default value
'https://localhost:8082/'

Dev server public path

View source

token

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

View source

useDevServer

Type
boolean
Default value
false

Enable dev server

View source

Public Methods

MethodDescription
__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.
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 for this component.
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 (mixed)

Returns

craft\models\CraftIdToken, null

saveToken()

Saves the OAuth token.

View source

Arguments