class Asset extends BaseResource implements AssetInterface, CreatableInterface

Asset class.

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

Traits

ArchivableTrait.
DeletableTrait.
PublishableTrait.
UpdatableTrait.

Properties

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

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.

archive()

Archives the current resource.

unarchive()

Unarchives the current resource.

getSystemProperties()

{@inheritdoc}

delete()

Deletes the current resource.

publish()

Publishes the current resource.

unpublish()

Unpublishes the current resource.

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.

array
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

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

No description

array
getTitles()

No description

string|null
getDescription(string $locale)

No description

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

No description

array
getDescriptions()

No description

FileInterface|null
getFile(string $locale)

No description

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

No description

array
getFiles()

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

Archives the current resource.

in ArchivableTrait at line 41
unarchive()

Unarchives the current resource.

at line 61
Asset getSystemProperties()

{@inheritdoc}

Return Value

Asset

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
array jsonSerialize()

{@inheritdoc}

Return Value

array

at line 84
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 96
array 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

array

at line 108
process(string $locale = \null)

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

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

Parameters

string $locale

Return Value

string|null

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

Parameters

string $locale
string $title

Return Value

Asset

at line 160
array getTitles()

Return Value

array

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

Parameters

string $locale

Return Value

string|null

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

Parameters

string $locale
string $description

Return Value

Asset

at line 197
array getDescriptions()

Return Value

array

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

Parameters

string $locale

Return Value

FileInterface|null

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

Parameters

string $locale
UnprocessedFileInterface $file

Return Value

Asset

at line 234
array getFiles()

Return Value

array