1. class
  2. Contentful
  3. \
  4. Management
  5. \
  6. Resource
  7. \
  8. EditorInterface

EditorInterface

class EditorInterface extends BaseResource

EditorInterface class.

This class represents a resource with type "EditorInterface" in Contentful.

Traits

UpdatableTrait
UpdatableTrait.

Properties

protected EditorInterface $sys
Client $client from UpdatableTrait
protected Control[] $controls

Methods

getId()

{@inheritdoc}

from BaseResource
getType()

{@inheritdoc}

from BaseResource
asLink()

{@inheritdoc}

from BaseResource
mixed
asRequestBody()

Returns the resource in the form of request body.

from UpdatableTrait
BaseResource
setClient(Client $client)

Sets the current Client object instance.

from BaseResource
update()

Updates the current resource.

from UpdatableTrait
getSystemProperties()

{@inheritdoc}

jsonSerialize()

{@inheritdoc}

string[]
asUriParameters()

Returns an associative array where keys are the name of the fragments in a URI, and the values are the corresponding IDs.

getControl(string $fieldId)

No description

Control[]
getControls()

No description

Details

in BaseResource at line 37
getId()

{@inheritdoc}

in BaseResource at line 45
getType()

{@inheritdoc}

{@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.

Return Value

mixed

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.

Parameters

Client $client

Return Value

BaseResource

in UpdatableTrait at line 40
update()

Updates the current resource.

at line 49
getSystemProperties()

{@inheritdoc}

at line 57
jsonSerialize()

{@inheritdoc}

at line 68
string[] asUriParameters()

Returns an associative array where keys are the name of the fragments in a URI, and the values are the corresponding IDs.

Return Value

string[]

at line 77
getControl(string $fieldId)

Parameters

string $fieldId

at line 91
Control[] getControls()

Return Value

Control[]