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

Upload

class Upload extends BaseResource implements CreatableInterface

Upload class.

This class represents an "Upload" object in Contentful.

Traits

DeletableTrait
DeletableTrait.

Properties

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

Methods

initialize(string $type, array $sys = [])

Initialize system properties.

from BaseResource
getSystemProperties()

{@inheritdoc}

from BaseResource
getId()

{@inheritdoc}

from BaseResource
getType()

{@inheritdoc}

from BaseResource
asLink()

{@inheritdoc}

from BaseResource
mixed
asRequestBody()

Returns the resource in the form of request body.

BaseResource
setClient(Client $client)

Sets the current Client object instance.

from BaseResource
delete()

Deletes the current resource.

from DeletableTrait
__construct(string|resource|StreamInterface $body)

Upload constructor.

array
jsonSerialize()

Returns an array to be used by "json_encode" to serialize objects of this class.

string[]
asUriParameters()

Returns an associate 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|resource|StreamInterface|null
getBody()

No description

Upload
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 39
protected initialize(string $type, array $sys = [])

Initialize system properties.

Parameters

string $type The system type
array $sys

in BaseResource at line 48
getSystemProperties()

{@inheritdoc}

in BaseResource at line 56
getId()

{@inheritdoc}

in BaseResource at line 64
getType()

{@inheritdoc}

{@inheritdoc}

at line 64
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 98
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 29
delete()

Deletes the current resource.

at line 43
__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 54
array jsonSerialize()

Returns an array to be used by "json_encode" to serialize objects of this class.

Return Value

array

at line 72
string[] asUriParameters()

Returns an associate array where keys are the name of the fragments in a URI, and the values are the corresponding IDs.

Return Value

string[]

at line 83
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 91
string|resource|StreamInterface|null getBody()

Return Value

string|resource|StreamInterface|null

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

Parameters

string|resource|StreamInterface|null $body

Return Value

Upload

at line 116
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