class EditorInterface extends BaseResource

EditorInterface class.

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

Traits

UpdatableTrait.

Properties

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

Methods

string
getId()

{@inheritdoc}

string
getType()

{@inheritdoc}

Link
asLink()

{@inheritdoc}

mixed
asRequestBody()

Returns the resource in the form of request body.

setClient(Client $client)

Sets the current Client object instance.

update()

Updates the current resource.

array
jsonSerialize()

{@inheritdoc}

array
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

array
getControls()

No description

Details

in BaseResource at line 37
string getId()

{@inheritdoc}

Return Value

string

in BaseResource at line 45
string getType()

{@inheritdoc}

Return Value

string

{@inheritdoc}

Return Value

Link

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 79
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
EditorInterface getSystemProperties()

{@inheritdoc}

Return Value

EditorInterface

at line 57
array jsonSerialize()

{@inheritdoc}

Return Value

array

at line 68
array 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

array

at line 82
Control getControl(string $fieldId)

Parameters

string $fieldId

Return Value

Control

at line 99
array getControls()

Return Value

array