Extension
class Extension extends BaseResource implements CreatableInterface
Extension class.
This class represents a resource with type "Extension" in Contentful.
Traits
Properties
protected Extension | $sys | ||
Client | $client | from UpdatableTrait | |
protected string | $name | ||
protected string | $source | ||
protected FieldType[] | $fieldTypes | ||
protected bool | $sidebar | ||
protected Parameter[] | $installationParameters | ||
protected Parameter[] | $instanceParameters |
Methods
{@inheritdoc}
Extension construct.
Returns an associative array where keys are the name of the fragments in a URI, and the values are the corresponding IDs.
Returns an array of headers that the current resource needs to sent for being created.
No description
No description
No description
No description
Shortcut for adding a new field type.
No description
No description
No description
No description
{@inheritdoc}
Details
in BaseResource at line 37 getId()
{@inheritdoc}
in BaseResource at line 45 getType()
{@inheritdoc}
in BaseResource at line 53 asLink()
{@inheritdoc}
in UpdatableTrait at line 35 abstract mixed asRequestBody()
Returns the resource in the form of request body.
This can differ from regular serialization, as some fields may not be present in the request payload.
in BaseResource at line 77 BaseResource setClient(Client $client)
Sets the current Client object instance.
This is done automatically when performing API calls, so it shouldn't be used manually.
in DeletableTrait at line 28 delete()
Deletes the current resource.
in UpdatableTrait at line 40 update()
Updates the current resource.
at line 80 getSystemProperties()
{@inheritdoc}
at line 72 __construct(string $name = '')
Extension construct.
at line 88 string[] asUriParameters()
Returns an associative array where keys are the name of the fragments in a URI, and the values are the corresponding IDs.
at line 100 string[] getHeadersForCreation()
Returns an array of headers that the current resource needs to sent for being created.
This method is supposed to be overridden if necessary.
at line 105 getName()
at line 113 Extension setName(string $name)
at line 120 getSource()
at line 130 Extension setSource(string $source)
at line 140 FieldType[] getFieldTypes()
at line 150 Extension setFieldTypes(array $fieldTypes)
at line 174 Extension addNewFieldType(string $type, array $options = [])
Shortcut for adding a new field type.
at line 179 isSidebar()
at line 187 Extension setSidebar(bool $sidebar)
at line 197 Parameter[] getInstallationParameters()
at line 227 Parameter[] getInstanceParameters()
at line 257 jsonSerialize()
{@inheritdoc}