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

Asset

class Asset extends BaseResource implements AssetInterface, CreatableInterface

Asset class.

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

Traits

ArchivableTrait
ArchivableTrait.
DeletableTrait
DeletableTrait.
PublishableTrait
PublishableTrait.
UpdatableTrait
UpdatableTrait.

Properties

protected Asset $sys
Client $client from UpdatableTrait
protected string[] $title
protected string[] $description
protected FileInterface[] $file

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

Archives the current resource.

from ArchivableTrait
unarchive()

Unarchives the current resource.

from ArchivableTrait
getSystemProperties()

{@inheritdoc}

delete()

Deletes the current resource.

from DeletableTrait
publish()

Publishes the current resource.

from PublishableTrait
unpublish()

Unpublishes the current resource.

from PublishableTrait
update()

Updates the current resource.

from UpdatableTrait
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.

process(string $locale = null)

Call the endpoint for processing the file associated to the asset.

string|null
getTitle(string $locale)

No description

Asset
setTitle(string $locale, string $title = null)

No description

string[]
getTitles()

No description

string|null
getDescription(string $locale)

No description

Asset
setDescription(string $locale, string $description = null)

No description

string[]
getDescriptions()

No description

FileInterface|null
getFile(string $locale)

No description

Asset
setFile(string $locale, UnprocessedFileInterface $file = null)

No description

FileInterface[]
getFiles()

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 ArchivableTrait at line 31
archive()

Archives the current resource.

in ArchivableTrait at line 41
unarchive()

Unarchives the current resource.

at line 61
getSystemProperties()

{@inheritdoc}

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.

in UpdatableTrait at line 40
update()

Updates the current resource.

at line 69
jsonSerialize()

{@inheritdoc}

at line 84
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 96
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 106
process(string $locale = null)

Call the endpoint for processing the file associated to the asset.

Parameters

string $locale

See also

https://www.contentful.com/developers/docs/references/content-management-api/#/reference/assets/asset-processing

at line 129
string|null getTitle(string $locale)

Parameters

string $locale

Return Value

string|null

at line 137
Asset setTitle(string $locale, string $title = null)

Parameters

string $locale
string $title

Return Value

Asset

at line 153
string[] getTitles()

Return Value

string[]

at line 161
string|null getDescription(string $locale)

Parameters

string $locale

Return Value

string|null

at line 169
Asset setDescription(string $locale, string $description = null)

Parameters

string $locale
string $description

Return Value

Asset

at line 185
string[] getDescriptions()

Return Value

string[]

at line 193
FileInterface|null getFile(string $locale)

Parameters

string $locale

Return Value

FileInterface|null

at line 201
Asset setFile(string $locale, UnprocessedFileInterface $file = null)

Parameters

string $locale
UnprocessedFileInterface $file

Return Value

Asset

at line 217
FileInterface[] getFiles()

Return Value

FileInterface[]