Api

Type
Class
Namespace
craft\services
Inherits
craft\services\Api » yii\base\Component (opens new window) » yii\base\BaseObject (opens new window)
Implements
yii\base\Configurable (opens new window)
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 (opens new window)

# Public Properties

# client

Type
\GuzzleHttp\Client
Default value
null

View source (opens new window)

# countries

Type
array (opens new window)
Default value
null
Access
Read-only

View source (opens new window)

# licenseInfo

Type
array (opens new window)
Default value
null
Access
Read-only

View source (opens new window)

# updates

Type
array (opens new window)
Default value
null
Access
Read-only

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 an object property.
__isset() (opens new window) Checks if a property is set, i.e. defined and not null.
__set() (opens new window) Sets value of an object property.
__unset() (opens new window) Sets an object property to 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.
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.
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() (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.
init() 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.
request()
trigger() (opens new window) 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 (opens new window)

Arguments

Returns

array (opens new window)

Throws

# getCountries()

Returns all country data.

View source (opens new window)

Returns

array (opens new window)

Throws

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

# getLicenseInfo()

Returns info about the current Craft license.

View source (opens new window)

Arguments

Returns

array (opens new window)

Throws

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

# getUpdates()

Checks for Craft and plugin updates.

View source (opens new window)

Arguments

  • $maxVersions

Returns

array (opens new window)

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 (opens new window)

# request()

View source (opens new window)

Arguments

Returns

\Psr\Http\Message\ResponseInterface

Throws

  • \GuzzleHttp\Exception\RequestException