Api

Type
Class
Namespace
craft\services
Inherits
craft\services\Api » yii\base\Component » yii\base\BaseObject
Implements
yii\base\Configurable
Since
3.0.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
countriesarray
licenseInfoarray
updatesarray

client

Type
\GuzzleHttp\Client

View source

countries

Type
array
Access
Read-only

View source

licenseInfo

Type
array
Access
Read-only

View source

updates

Type
array
Access
Read-only

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 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.
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.
getComposerWhitelist()Returns a list of package names that Composer should be allowed to update when installing/updating packages.
getCountries()Returns all country data.
getLicenseInfo()Returns info about the current Craft license.
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.

getComposerWhitelist()

Since
3.0.19

Returns a list of package names that Composer should be allowed to update when installing/updating packages.

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

getCountries()

Returns all country data.

View source

Returns

array

Throws

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

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

getUpdates()

Checks for Craft and plugin updates.

View source

Returns

array

Throws

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

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

request()

View source

Arguments

Returns

\Psr\Http\Message\ResponseInterface

Throws

  • \GuzzleHttp\Exception\RequestException