interface DocumentInterface (View source)

Methods

string
getFilename()

No description

setFilename(string $filename)

No description

string
getMimeType()

No description

setMimeType(string $mimeType)

No description

string
getShortType()

Get short type name for current document Mime type.

string
getShortMimeType()

Get short Mime type.

boolean
isImage()

Is current document an image.

boolean
isSvg()

Is current document a vector SVG file.

boolean
isVideo()

Is current document a video.

boolean
isAudio()

Is current document an audio file.

bool
isPdf()

Is current document a PDF file.

string
getFolder()

No description

setFolder(string $folder)

Set folder name.

string|null
getRelativeUrl() deprecated

No description

string|null
getRelativePath()

No description

string
getEmbedId()

No description

setEmbedId(string $embedId)

No description

string
getEmbedPlatform()

No description

setEmbedPlatform(string $embedPlatform)

No description

boolean
isEmbed()

Tells if current document has embed media information.

boolean
isPrivate()

No description

setPrivate(boolean $private)

No description

getRawDocument()

Gets the value of rawDocument.

setRawDocument(DocumentInterface $rawDocument = null)

Sets the value of rawDocument.

boolean
isRaw()

Is document a raw one.

setRaw(boolean $raw)

Sets the value of raw.

getDownscaledDocument()

Gets the downscaledDocument.

Collection
getFolders()

No description

addFolder(FolderInterface $folder)

No description

Details

string getFilename()

Return Value

string

DocumentInterface setFilename(string $filename)

Parameters

string $filename

Return Value

DocumentInterface

string getMimeType()

Return Value

string

DocumentInterface setMimeType(string $mimeType)

Parameters

string $mimeType

Return Value

DocumentInterface

string getShortType()

Get short type name for current document Mime type.

Return Value

string

string getShortMimeType()

Get short Mime type.

Return Value

string

boolean isImage()

Is current document an image.

Return Value

boolean

boolean isSvg()

Is current document a vector SVG file.

Return Value

boolean

boolean isVideo()

Is current document a video.

Return Value

boolean

boolean isAudio()

Is current document an audio file.

Return Value

boolean

bool isPdf()

Is current document a PDF file.

Return Value

bool

string getFolder()

Return Value

string

DocumentInterface setFolder(string $folder)

Set folder name.

Parameters

string $folder

Return Value

DocumentInterface

string|null getRelativeUrl() deprecated

deprecated Use getRelativePath instead, naming is better.

Return Value

string|null

string|null getRelativePath()

Return Value

string|null

string getEmbedId()

Return Value

string

DocumentInterface setEmbedId(string $embedId)

Parameters

string $embedId

Return Value

DocumentInterface

string getEmbedPlatform()

Return Value

string

DocumentInterface setEmbedPlatform(string $embedPlatform)

Parameters

string $embedPlatform

Return Value

DocumentInterface

boolean isEmbed()

Tells if current document has embed media information.

Return Value

boolean

boolean isPrivate()

Return Value

boolean

DocumentInterface setPrivate(boolean $private)

Parameters

boolean $private

Return Value

DocumentInterface

DocumentInterface|null getRawDocument()

Gets the value of rawDocument.

Return Value

DocumentInterface|null

DocumentInterface setRawDocument(DocumentInterface $rawDocument = null)

Sets the value of rawDocument.

Parameters

DocumentInterface $rawDocument the raw document

Return Value

DocumentInterface

boolean isRaw()

Is document a raw one.

Return Value

boolean

DocumentInterface setRaw(boolean $raw)

Sets the value of raw.

Parameters

boolean $raw the raw

Return Value

DocumentInterface

DocumentInterface|null getDownscaledDocument()

Gets the downscaledDocument.

Return Value

DocumentInterface|null

Collection getFolders()

Return Value

Collection

DocumentInterface addFolder(FolderInterface $folder)

Parameters

FolderInterface $folder

Return Value

DocumentInterface

DocumentInterface removeFolder(FolderInterface $folder)

Parameters

FolderInterface $folder

Return Value

DocumentInterface