class MagicDocumentHelper

Class MagicDocumentHelper

Methods

__construct($document_index)

No description

get_document_index()

Returns the document_index

string
get_file_url(mixed $file_path = false, bool $inline_disposition = true, bool $name = false, bool $zipOnTheFly = false, bool $width = false, bool $height = false, bool $resize_mode = false, bool $resize_cache = true, null $cache_hash = null)

Returns the url to download this file

string
get_file_path()

Retrieves the file path for this document, in case any should exist

array
get_file_info()

Get Information about this file

string
get_doclink_url(bool $with_domain = false)

Returns the url to the doclink

string
get_preview_link($args = array())

Returns a link to the document opening the doc viewer

get_document_xui()

Return the xui element for the document

string
get_webdav_url()

Returns the webdav url that can be used to directly open the document belonging to this file.

Details

at line 20
__construct($document_index)

Parameters

$document_index

at line 37
DocumentIndex get_document_index()

Returns the document_index

Return Value

DocumentIndex

at line 57
string get_file_url(mixed $file_path = false, bool $inline_disposition = true, bool $name = false, bool $zipOnTheFly = false, bool $width = false, bool $height = false, bool $resize_mode = false, bool $resize_cache = true, null $cache_hash = null)

Returns the url to download this file

Parameters

mixed $file_path
bool $inline_disposition
bool $name
bool $zipOnTheFly
bool $width
bool $height
bool $resize_mode
bool $resize_cache
null $cache_hash

Return Value

string The url

at line 115
string get_file_path()

Retrieves the file path for this document, in case any should exist

Return Value

string The absolute path of the file on the sever

at line 129
array get_file_info()

Get Information about this file

Return Value

array

Returns the url to the doclink

Parameters

bool $with_domain

Return Value

string The url

Returns a link to the document opening the doc viewer

Parameters

$args

Return Value

string The link source code

at line 192
Document get_document_xui()

Return the xui element for the document

Return Value

Document The xui document implementation

at line 207
string get_webdav_url()

Returns the webdav url that can be used to directly open the document belonging to this file.

The webdav path will return false if the document does not implement xi_system_dms_fully_integrated and thus has no file path to return an actual file. Please note, that editing is only available for native dms documents

Return Value

string The webdav url of the document