ApiKey
class ApiKey extends BaseResource
ApiKey class.
Properties
| protected SystemProperties | $sys | from BaseResource | |
| protected BaseProxy | $proxy | from BaseResource | |
| protected string | $name | ||
| protected string|null | $description | ||
| protected string|null | $accessToken |
Methods
Returns the resource's system properties, defined in the object "sys" in Contentful's responses.
Shortcut for accessing the resource ID through its system properties.
Shortcut for forwarding methods to the current proxy, using the current object as argument.
No description
No description
No description
No description
Returns an array to be used by "json_encode" to serialize objects of this class.
Details
in BaseResource at line 38
protected
__construct(string $type, array $sys = [])
BaseResource constructor.
in BaseResource at line 47
SystemProperties
getSystemProperties()
Returns the resource's system properties, defined in the object "sys" in Contentful's responses.
in BaseResource at line 57
string|null
getId()
Shortcut for accessing the resource ID through its system properties.
in BaseResource at line 65
Link
asLink()
Creates a Link representation of the current resource.
in BaseResource at line 79
BaseResource
setProxy(BaseProxy $proxy)
Sets the current BaseProxy object instance.
This is done automatically when performing API calls, so it shouldn't be used manually.
in BaseResource at line 89
asRequestBody()
{@inheritdoc}
in BaseResource at line 111
__call(string $name, array $arguments)
Shortcut for forwarding methods to the current proxy, using the current object as argument.
// Instead of
$client->asset->publish($asset);
// You can use
$asset->publish();
at line 35
string
getName()
at line 45
ApiKey
setName(string $name)
at line 55
string|null
getDescription()
at line 65
ApiKey
setDescription(string $description)
at line 75
string|null
getAccessToken()
at line 85
array
jsonSerialize()
Returns an array to be used by "json_encode" to serialize objects of this class.