class Upload extends BaseResource implements CreatableInterface

Upload class.

This class represents an "Upload" object in Contentful.

Traits

DeletableTrait.

Properties

protected Upload $sys
Client $client from DeletableTrait
protected string|resource|StreamInterface|null $body

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.

delete()

Deletes the current resource.

__construct(string|resource|StreamInterface $body)

Upload constructor.

getSystemProperties()

{@inheritdoc}

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.

string|resource|StreamInterface|null
getBody()

No description

setBody(string|resource|StreamInterface|null $body)

No description

LocalUploadFile
asAssetFile(string $filename, string $contentType)

Returns an object representation of the upload that is compatible to an asset resource.

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

at line 76
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 DeletableTrait at line 28
delete()

Deletes the current resource.

at line 50
__construct(string|resource|StreamInterface $body)

Upload constructor.

Parameters

string|resource|StreamInterface $body Internally this is the value that is passed to Guzzle's request body, which means that all values accepted by Guzzle are allowed. These include an actual "string", a resource such as the result of a "fopen('file.txt', 'r')" call, an object implementing StreamInterface, etc.

See also

http://docs.guzzlephp.org/en/stable/request-options.html#body For more un Guzzle's internal options

at line 58
Upload getSystemProperties()

{@inheritdoc}

Return Value

Upload

at line 66
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 95
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 103
string|resource|StreamInterface|null getBody()

Return Value

string|resource|StreamInterface|null

at line 113
Upload setBody(string|resource|StreamInterface|null $body)

Parameters

string|resource|StreamInterface|null $body

Return Value

Upload

at line 128
LocalUploadFile asAssetFile(string $filename, string $contentType)

Returns an object representation of the upload that is compatible to an asset resource.

Parameters

string $filename
string $contentType

Return Value

LocalUploadFile