\Copilot\ClientAsset

An asset is a container for a downloadable file.

This can be a image, a document or some other kind of file.

Summary

Methods
Properties
Constants
getId()
getFilename()
getMimeType()
getTags()
containsTag()
getSize()
getDescription()
getDownloadUrl()
getOriginalWidth()
getOriginalHeight()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
No private properties found
N/A

Methods

getId()

getId() : string

Returns the id of the underlaying asset

Returns

string —

The id of the asset

getFilename()

getFilename() : string

Returns the filename of the asset

Returns

string —

The assets filename.

getMimeType()

getMimeType() : string

Returns the mimetype as per RFC2046 of this asset

Returns

string —

The assets mimetype

getTags()

getTags() : array

Returns a string of tags, this asset contains

Returns

array —

Array of strings with tagnames the asset contains

containsTag()

containsTag(string  $tag) : boolean

Returns whether or not the asset has the given tag

Parameters

string $tag

The name of the tag

Returns

boolean —

True if the asset has this tag, false otherwise

getSize()

getSize() : integer

Returns the size in bytes of the file

Returns

integer —

The size of the file in bytes

getDescription()

getDescription() : string

Returns the assets descriptional text

Returns

string —

The assets description

getDownloadUrl()

getDownloadUrl(integer  $width = NULL) : string

Returns the download URL from where the asset could been retrieved.

Parameters

integer $width

If the asset is of mimetype image/* the link will point to an image in that size

Returns

string —

The URL to the given file

getOriginalWidth()

getOriginalWidth() : integer

If the asset has a mimetype of image/* returns the original images width

Returns

integer —

The images original width or NULL if the asset is not an image

getOriginalHeight()

getOriginalHeight() : integer

If the asset has a mimetype of image/* returns the original images height

Returns

integer —

The images original height or NULL if the asset is not an image