Api

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

The API service provides APIs for calling the Craft API (api.craftcms.com).

An instance of the API service is globally accessible in Craft via Craft::$app->api.

View source

Public Properties

PropertyDescription
$behaviorsyii\base\Behavior – List of behaviors attached to this component
$client\GuzzleHttp\Client
$cmsEditionsarray
$countriesarray
$licenseInfoarray
$pluginStoreDataarray
$updatesarray

$client

Type
\GuzzleHttp\Client

View source

Signature

public \GuzzleHttp\Client $client = null

$cmsEditions

Type
array
Access
Read-only

View source

Signature

public array getCmsEditions ( )

$countries

Type
array
Access
Read-only

View source

Signature

public array getCountries ( )

$licenseInfo

Type
array
Access
Read-only

View source

Signature

public array getLicenseInfo ( array $include = [] )

$pluginStoreData

Type
array
Access
Read-only

View source

Signature

public array getPluginStoreData ( )

$updates

Type
array
Access
Read-only

View source

Signature

public array getUpdates ( )

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.
checkout()Order checkout.
className()Returns the fully qualified name of this class.
createCart()Create a cart.
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.
getCart()Get a cart by its order number.
getCmsEditions()Returns all CMS editions
getCountries()Returns all country data.
getDeveloper()Returns the developer details.
getLicenseInfo()Returns info about the current Craft license.
getOptimizedComposerRequirements()Returns optimized Composer requirements based on what’s currently installed, and the package requirements that should be installed.
getPluginDetails()Returns the plugin details.
getPluginStoreData()Returns plugins data for the Plugin Store.
getUpdates()Checks for Craft and plugin updates.
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.
request()
trigger()Triggers an event.
updateCart()Update a cart.

checkout()

Order checkout.

View source

Arguments

Returns

array

Throws

  • \GuzzleHttp\Exception\RequestException
    if the API gave a non-2xx response

Signature

public array checkout ( array $data )

createCart()

Create a cart.

View source

Arguments

Returns

array

Signature

public array createCart ( array $data )

getCart()

Get a cart by its order number.

View source

Arguments

Returns

array

Signature

public array getCart ( \craft\services\string $orderNumber )

getCmsEditions()

Returns all CMS editions

View source

Returns

array

Throws

  • \GuzzleHttp\Exception\RequestException
    if the API gave a non-2xx response

Signature

public array getCmsEditions ( )

getCountries()

Returns all country data.

View source

Returns

array

Throws

  • \GuzzleHttp\Exception\RequestException
    if the API gave a non-2xx response

Signature

public array getCountries ( )

getDeveloper()

Returns the developer details.

View source

Arguments

Returns

array

Throws

  • \GuzzleHttp\Exception\RequestException
    if the API gave a non-2xx response

Signature

public array getDeveloper ( \craft\services\int $developerId )

getLicenseInfo()

Returns info about the current Craft license.

View source

Arguments

Returns

array

Throws

  • \GuzzleHttp\Exception\RequestException
    if the API gave a non-2xx response

Signature

public array getLicenseInfo ( array $include = [] )

getOptimizedComposerRequirements()

Returns optimized Composer requirements based on what’s currently installed, and the package requirements that should be installed.

View source

Arguments

  • $install (array) – Package name/version pairs to be installed

Returns

array

Throws

  • \GuzzleHttp\Exception\RequestException
    if the API gave a non-2xx response
  • yii\base\Exception
    if composer.json can't be located

Signature

public array getOptimizedComposerRequirements ( array $install )

getPluginDetails()

Returns the plugin details.

View source

Arguments

Returns

array

Throws

  • \GuzzleHttp\Exception\RequestException
    if the API gave a non-2xx response

Signature

public array getPluginDetails ( \craft\services\int $pluginId )

getPluginStoreData()

Returns plugins data for the Plugin Store.

View source

Returns

array

Throws

  • \GuzzleHttp\Exception\RequestException
    if the API gave a non-2xx response

Signature

public array getPluginStoreData ( )

getUpdates()

Checks for Craft and plugin updates.

View source

Returns

array

Throws

  • \GuzzleHttp\Exception\RequestException
    if the API gave a non-2xx response

Signature

public array getUpdates ( )

init()

Initializes the object.

This method is invoked at the end of the constructor after the object is initialized with the given configuration.

View source

Signature

public void init ( )

request()

View source

Arguments

Returns

\Psr\Http\Message\ResponseInterface

Throws

  • \GuzzleHttp\Exception\RequestException

Signature

public \Psr\Http\Message\ResponseInterface request ( \craft\services\string $method, \craft\services\string $uri, array $options = [] )

updateCart()

Update a cart.

View source

Arguments

Returns

array

Signature

public array updateCart ( \craft\services\string $orderNumber, array $data )

Protected Methods

MethodDescription
headers()Returns the headers that should be sent with API requests.
platformVersions()Returns platform info.

headers()

Returns the headers that should be sent with API requests.

View source

Returns

array

Signature

protected array headers ( )

platformVersions()

Returns platform info.

View source

Arguments

  • $useComposerOverrides (boolean) – Whether to factor in any config.platform overrides

Returns

array

Signature

protected array platformVersions ( \craft\services\bool $useComposerOverrides = false )