Class craft\services\PluginStore
- Inheritance
- craft\services\PluginStore » yii\base\Component » yii\base\BaseObject
- Implements
- yii\base\Configurable
- Available since version
- 3.0
- Source Code
- https://github.com/craftcms/cms/blob/master/src/services/PluginStore.php
Plugin Store service.
An instance of the Plugin Store service is globally accessible in Craft via Craft::$app->pluginStore.
| Property | Type | Description | Defined By |
|---|---|---|---|
$craftApiEndpoint |
string | API endpoint | craft\services\PluginStore |
$craftIdEndpoint |
string | Craft ID endpoint | craft\services\PluginStore |
$craftIdOauthClientId |
string | CraftIdOauthClientId | craft\services\PluginStore |
$craftOauthEndpoint |
string | OAuth endpoint | craft\services\PluginStore |
$enableCraftId |
boolean | Enabled Craft ID | craft\services\PluginStore |
$stripeApiKey |
string | Stripe API key | craft\services\PluginStore |
| Method | Description | Defined By |
|---|---|---|
__call() |
Calls the named method which is not a class method. | yii\base\BaseObject |
__clone() |
This method is called after the object is created by cloning an existing one. | yii\base\Component |
__construct() |
Constructor. | yii\base\BaseObject |
__get() |
Returns the value of an object property. | yii\base\BaseObject |
__isset() |
Checks if a property is set, i.e. defined and not null. | yii\base\BaseObject |
__set() |
Sets value of an object property. | yii\base\BaseObject |
__unset() |
Sets an object property to null. | yii\base\BaseObject |
attachBehavior() |
Attaches a behavior to this component. | yii\base\Component |
attachBehaviors() |
Attaches a list of behaviors to the component. | yii\base\Component |
behaviors() |
Returns a list of behaviors that this component should behave as. | yii\base\Component |
canGetProperty() |
Returns a value indicating whether a property can be read. | yii\base\BaseObject |
canSetProperty() |
Returns a value indicating whether a property can be set. | yii\base\BaseObject |
className() |
Returns the fully qualified name of this class. | yii\base\BaseObject |
deleteToken() |
Delete OAuth token. | craft\services\PluginStore |
deleteTokenByUserId() |
Delete token from its user ID. | craft\services\PluginStore |
detachBehavior() |
Detaches a behavior from the component. | yii\base\Component |
detachBehaviors() |
Detaches all behaviors from the component. | yii\base\Component |
ensureBehaviors() |
Makes sure that the behaviors declared in behaviors() are attached to this component. | yii\base\Component |
getBehavior() |
Returns the named behavior object. | yii\base\Component |
getBehaviors() |
Returns all behaviors attached to this component. | yii\base\Component |
getClient() |
Get authenticated client. | craft\services\PluginStore |
getCraftIdAccount() |
Returns the Craft ID account. | craft\services\PluginStore |
getToken() |
Get OAuth token. | craft\services\PluginStore |
getTokenByUserId() |
Get token by user ID. | craft\services\PluginStore |
hasEventHandlers() |
Returns a value indicating whether there is any handler attached to the named event. | yii\base\Component |
hasMethod() |
Returns a value indicating whether a method is defined. | yii\base\BaseObject |
hasProperty() |
Returns a value indicating whether a property is defined. | yii\base\BaseObject |
init() |
Initializes the object. | yii\base\BaseObject |
off() |
Detaches an existing event handler from this component. | yii\base\Component |
on() |
Attaches an event handler to an event. | yii\base\Component |
saveToken() |
Save OAuth token. | craft\services\PluginStore |
trigger() |
Triggers an event. | yii\base\Component |
Property Details
$craftApiEndpoint
public property
#
API endpoint
public string $craftApiEndpoint = 'https://api.craftcms.com/v1'
$craftIdEndpoint
public property
#
Craft ID endpoint
public string $craftIdEndpoint = 'https://id.craftcms.com'
$craftIdOauthClientId
public property
#
CraftIdOauthClientId
public string $craftIdOauthClientId = '6DvEra7eqRKLYic9fovyD2FWFjYxRwZn'
$craftOauthEndpoint
public property
#
OAuth endpoint
public string $craftOauthEndpoint = 'https://id.craftcms.com/oauth'
$enableCraftId
public property
#
Enabled Craft ID
public boolean $enableCraftId = false
$stripeApiKey
public property
#
Stripe API key
public string $stripeApiKey = nullMethod Details
deleteToken()
public method
#
Delete OAuth token.
public void deleteToken ( )
deleteTokenByUserId()
public method
#
Delete token from its user ID.
public boolean deleteTokenByUserId ( \craft\services\int $userId )$userId |
integer |
getClient()
public method
#
Get authenticated client.
public \GuzzleHttp\Client getClient ( )
getCraftIdAccount()
public method
#
Returns the Craft ID account.
public array, null getCraftIdAccount ( )
getToken()
public method
#
Get OAuth token.
public mixed getToken ( )
getTokenByUserId()
public method
#
Get token by user ID.
public craft\models\CraftIdToken, null getTokenByUserId ( $userId )$userId |
saveToken()
public method
#
Save OAuth token.
public void saveToken ( array $tokenArray )$tokenArray |
array |