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 service is available via Craft::$app->api.
Public Properties ​
| Property | Description |
|---|---|
| behaviors | yii\base\Behavior – List of behaviors attached to this component. |
| client | \GuzzleHttp\Client |
| countries | array |
| licenseInfo | array |
| updates | array |
client ​
- Type
\GuzzleHttp\Client- Default value
null
countries ​
- Type
- array
- Default value
null- Access
- Read-only
licenseInfo ​
- Type
- array
- Default value
null- Access
- Read-only
updates ​
- Type
- array
- Default value
null- Access
- Read-only
Public Methods ​
| Method | Description |
|---|---|
| __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 a component property. |
| __isset() | Checks if a property is set, i.e. defined and not null. |
| __set() | Sets the value of a component property. |
| __unset() | Sets a component property to be 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. |
| 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 for this component. |
| 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. |
getCountries() ​
Returns all country data.
Returns ​
Throws ​
\GuzzleHttp\Exception\RequestException
if the API gave a non-2xx response
getLicenseInfo() ​
Returns info about the current Craft license.
Arguments ​
$include(string[])
Returns ​
Throws ​
\GuzzleHttp\Exception\RequestException
if the API gave a non-2xx response
getUpdates() ​
Checks for Craft and plugin updates.
Arguments ​
$maxVersions(string[]) – The maximum versions that should be allowed
Returns ​
init() ​
Initializes the object.
This method is invoked at the end of the constructor after the object is initialized with the given configuration.
request() ​
Arguments ​
Returns ​
\Psr\Http\Message\ResponseInterface
Throws ​
\GuzzleHttp\Exception\RequestException