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

ContentType

class ContentType extends BaseResource implements ContentTypeInterface, CreatableInterface

ContentType class.

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

Traits

ContentTypeProxyExtension
ContentTypeProxyExtension trait.
DeletableTrait
DeletableTrait.
PublishableTrait
PublishableTrait.
UpdatableTrait
UpdatableTrait.

Properties

protected ContentType $sys
Client $client from UpdatableTrait
protected string $name
protected string|null $description
protected string|null $displayField
protected FieldInterface[] $fields
protected bool $isPublished

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
getSpaceId()

{@inheritdoc}

getEnvironmentId()

{@inheritdoc}

getContentTypeId()

{@inheritdoc}

ContentTypeSnapshot
getSnapshot(string $snapshotId)

Returns a ContentTypeSnapshot resource.

from ContentTypeProxyExtension
ResourceArray
getSnapshots(Query $query = \null)

Returns a ResourceArray object which contains ContentTypeSnapshot resources.

from ContentTypeProxyExtension
EditorInterface
getEditorInterface()

Returns an EditorInterface resource.

from ContentTypeProxyExtension
delete()

Deletes the current resource.

from DeletableTrait
publish()

Publishes the current resource.

from PublishableTrait
unpublish()

Unpublishes the current resource.

from PublishableTrait
getSystemProperties()

{@inheritdoc}

update()

Updates the current resource.

from UpdatableTrait
__construct(string $name)

ContentType constructor.

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.

string[]
getHeadersForCreation()

Returns an array of headers that the current resource needs to sent for being created.

string
getName()

No description

ContentType
setName(string $name)

No description

string|null
getDescription()

No description

ContentType
setDescription(string $description = \null)

No description

string|null
getDisplayField()

No description

ContentType
setDisplayField(string $displayField = \null)

No description

FieldInterface[]
getFields()

No description

FieldInterface
getField(string $fieldId)

No description

ContentType
setFields(array $fields)

No description

ContentType
addField(FieldInterface $contentTypeField)

No description

bool
isPublished()

No description

FieldInterface
addNewField(string $type, string $fieldId, string $name, array $params)

Adds a new content type field, and returns it.

FieldInterface
createField(string $type, string $fieldId, string $name, array $params)

Shortcut for creating a new field object.

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 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

at line 131
protected getSpaceId()

{@inheritdoc}

at line 139
protected getEnvironmentId()

{@inheritdoc}

at line 147
protected getContentTypeId()

{@inheritdoc}

in ContentTypeProxyExtension at line 61
ContentTypeSnapshot getSnapshot(string $snapshotId)

Returns a ContentTypeSnapshot resource.

Parameters

string $snapshotId

Return Value

ContentTypeSnapshot

See also

https://www.contentful.com/developers/docs/references/content-management-api/#/reference/snapshots/content-type-snapshot

in ContentTypeProxyExtension at line 80
ResourceArray getSnapshots(Query $query = \null)

Returns a ResourceArray object which contains ContentTypeSnapshot resources.

Parameters

Query $query

Return Value

ResourceArray

See also

https://www.contentful.com/developers/docs/references/content-management-api/#/reference/snapshots/content-type-snapshots-collection

in ContentTypeProxyExtension at line 97
EditorInterface getEditorInterface()

Returns an EditorInterface resource.

Return Value

EditorInterface

See also

https://www.contentful.com/developers/docs/references/content-management-api/#/reference/editor-interface

in DeletableTrait at line 28
delete()

Deletes the current resource.

in PublishableTrait at line 31
publish()

Publishes the current resource.

in PublishableTrait at line 41
unpublish()

Unpublishes the current resource.

at line 81
getSystemProperties()

{@inheritdoc}

in UpdatableTrait at line 40
update()

Updates the current resource.

at line 73
__construct(string $name)

ContentType constructor.

Parameters

string $name

at line 89
jsonSerialize()

{@inheritdoc}

at line 111
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 123
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.

Return Value

string[]

at line 155
string getName()

Return Value

string

at line 165
ContentType setName(string $name)

Parameters

string $name

Return Value

ContentType

at line 175
string|null getDescription()

Return Value

string|null

at line 185
ContentType setDescription(string $description = \null)

Parameters

string $description

Return Value

ContentType

at line 195
string|null getDisplayField()

Return Value

string|null

at line 205
ContentType setDisplayField(string $displayField = \null)

Parameters

string $displayField

Return Value

ContentType

at line 215
FieldInterface[] getFields()

Return Value

FieldInterface[]

at line 227
FieldInterface getField(string $fieldId)

Parameters

string $fieldId

Return Value

FieldInterface

Exceptions

InvalidArgumentException

at line 247
ContentType setFields(array $fields)

Parameters

array $fields

Return Value

ContentType

at line 259
ContentType addField(FieldInterface $contentTypeField)

Parameters

FieldInterface $contentTypeField

Return Value

ContentType

at line 269
bool isPublished()

Return Value

bool

at line 284
FieldInterface addNewField(string $type, string $fieldId, string $name, array $params)

Adds a new content type field, and returns it.

Parameters

string $type A valid field type, must be a class in the Contentful\Management\Resource\ContentType\Field namespace
string $fieldId The field ID
string $name The field name
array $params mixed> $params Extra parameters that will be forwarded to the field object constructor

Return Value

FieldInterface

at line 302
FieldInterface createField(string $type, string $fieldId, string $name, array $params)

Shortcut for creating a new field object.

Parameters

string $type A valid field type, must be a class in the Contentful\Management\Resource\ContentType\Field namespace
string $fieldId The field ID
string $name The field name
array $params mixed> $params Extra parameters that will be forwarded to the field object constructor

Return Value

FieldInterface