PluginStore
- Type
- Class
- Namespace
- craft\services
- Inherits
- craft\services\PluginStore » yii\base\Component (opens new window) » yii\base\BaseObject (opens new window)
- Implements
- yii\base\Configurable (opens new window)
- Since
- 3.0.0
Plugin Store service.
An instance of the service is available via Craft::$app->pluginStore
.
View source (opens new window)
# Public Properties
Property | Description |
---|---|
behaviors (opens new window) | yii\base\Behavior (opens new window) – List of behaviors attached to this component. |
craftApiEndpoint | string (opens new window) – API endpoint |
craftIdEndpoint | string (opens new window) – Craft Console endpoint |
craftIdOauthClientId | string (opens new window) – CraftIdOauthClientId |
craftOauthEndpoint | string (opens new window) – OAuth endpoint |
devServerManifestPath | string (opens new window) – Dev server manifest path |
devServerPublicPath | string (opens new window) – Dev server public path |
token | craft\models\CraftIdToken, null (opens new window) |
useDevServer | boolean (opens new window) – Enable dev server |
# craftApiEndpoint
- Type
- string (opens new window)
- Default value
'https://api.craftcms.com/v1'
API endpoint
View source (opens new window)
# craftIdEndpoint
- Type
- string (opens new window)
- Default value
'https://console.craftcms.com'
Craft Console endpoint
View source (opens new window)
# craftIdOauthClientId
- Type
- string (opens new window)
- Default value
'6DvEra7eqRKLYic9fovyD2FWFjYxRwZn'
CraftIdOauthClientId
View source (opens new window)
# craftOauthEndpoint
- Type
- string (opens new window)
- Default value
'https://console.craftcms.com/oauth'
OAuth endpoint
View source (opens new window)
# devServerManifestPath
- Type
- string (opens new window)
- Default value
'https://localhost:8082/'
Dev server manifest path
View source (opens new window)
# devServerPublicPath
- Type
- string (opens new window)
- Default value
'https://localhost:8082/'
Dev server public path
View source (opens new window)
# token
- Type
- craft\models\CraftIdToken, null (opens new window)
- Default value
null
- Access
- Read-only
View source (opens new window)
# useDevServer
- Type
- boolean (opens new window)
- Default value
false
Enable dev server
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 a component property. |
__isset() (opens new window) | Checks if a property is set, i.e. defined and not null. |
__set() (opens new window) | Sets the value of a component property. |
__unset() (opens new window) | Sets a component property to be 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. |
deleteToken() | Deletes an OAuth token. |
deleteTokenByUserId() | Deletes the token from its user ID. |
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. |
getToken() | Returns the OAuth token. |
getTokenByUserId() | Returns the token by user ID. |
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 for this component. |
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. |
saveToken() | Saves the OAuth token. |
trigger() (opens new window) | Triggers an event. |
# deleteToken()
Deletes an OAuth token.
View source (opens new window)
# deleteTokenByUserId()
Deletes the token from its user ID.
View source (opens new window)
Arguments
$userId
(integer (opens new window))
Returns
# getToken()
Returns the OAuth token.
View source (opens new window)
Returns
craft\models\CraftIdToken, null (opens new window)
# getTokenByUserId()
Returns the token by user ID.
View source (opens new window)
Arguments
$userId
(integer (opens new window))
Returns
craft\models\CraftIdToken, null (opens new window)
# saveToken()
Saves the OAuth token.
View source (opens new window)
Arguments
$tokenArray
(array (opens new window))