PluginStore

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

Plugin Store service.

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

View source

Public Properties

PropertyDescription
$apiRequestOptionsarray
$behaviorsyii\base\Behavior – List of behaviors attached to this component
$craftApiEndpointstring – API endpoint
$craftIdAccountarray, null
$craftIdEndpointstring – Craft ID endpoint
$craftIdOauthClientIdstring – CraftIdOauthClientId
$craftOauthEndpointstring – OAuth endpoint
$tokencraft\models\CraftIdToken, null

$apiRequestOptions

Type
array
Access
Read-only

View source

Signature

public array getApiRequestOptions ( )

$craftApiEndpoint

Type
string

API endpoint

View source

Signature

public string $craftApiEndpoint = 'https://api.craftcms.com/v1'

$craftIdAccount

Type
array, null
Access
Read-only

View source

Signature

public array, null getCraftIdAccount ( )

$craftIdEndpoint

Type
string

Craft ID endpoint

View source

Signature

public string $craftIdEndpoint = 'https://id.craftcms.com'

$craftIdOauthClientId

Type
string

CraftIdOauthClientId

View source

Signature

public string $craftIdOauthClientId = '6DvEra7eqRKLYic9fovyD2FWFjYxRwZn'

$craftOauthEndpoint

Type
string

OAuth endpoint

View source

Signature

public string $craftOauthEndpoint = 'https://id.craftcms.com/oauth'

$token

Signature

public craft\models\CraftIdToken, null getToken ( )

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 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.
getApiRequestOptions()Returns the options for authenticated API requests.
getBehavior()Returns the named behavior object.
getBehaviors()Returns all behaviors attached to this component.
getCraftIdAccount()Returns the Craft ID account.
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

Signature

public void deleteToken ( )

deleteTokenByUserId()

Deletes the token from its user ID.

View source

Arguments

Returns

boolean

Signature

public boolean deleteTokenByUserId ( \craft\services\int $userId )

getApiRequestOptions()

Returns the options for authenticated API requests.

View source

Returns

array

Signature

public array getApiRequestOptions ( )

getCraftIdAccount()

Returns the Craft ID account.

View source

Returns

array, null

Throws

Signature

public array, null getCraftIdAccount ( )

getToken()

Returns the OAuth token.

View source

Returns

craft\models\CraftIdToken, null

Signature

public craft\models\CraftIdToken, null getToken ( )

getTokenByUserId()

Returns the token by user ID.

View source

Arguments

  • $userId

Returns

craft\models\CraftIdToken, null

Signature

public craft\models\CraftIdToken, null getTokenByUserId ( $userId )

saveToken()

Saves the OAuth token.

View source

Arguments

Signature

public void saveToken ( array $tokenArray )