IMP_Contents_View
in package
Provides logic to format message content for delivery to the browser.
Tags
Table of Contents
Constants
- VIEW_TOKEN_PARAM = 'view_token'
Properties
Methods
- __construct() : mixed
- addToken() : array<string|int, mixed>
- Adds the view token to a parameter list.
- checkToken() : mixed
- Check for a download token.
- downloadAll() : mixed
- downloadAttach() : mixed
- downloadRender() : mixed
- downloadUrl() : Horde_Url
- Returns a URL to be used for downloading data.
- printAttach() : mixed
- saveMessage() : mixed
- viewAttach() : mixed
- viewSource() : mixed
- _getRawDownloadPart() : Horde_Mime_Part
- Get a MIME Part for use in creating download.
Constants
VIEW_TOKEN_PARAM
public
mixed
VIEW_TOKEN_PARAM
= 'view_token'
Properties
$_contents
protected
IMP_Contents
$_contents
Methods
__construct()
public
__construct(IMP_Indices $indices) : mixed
Parameters
- $indices : IMP_Indices
addToken()
Adds the view token to a parameter list.
public
static addToken([array<string|int, mixed> $params = array() ]) : array<string|int, mixed>
Parameters
- $params : array<string|int, mixed> = array()
-
URL parameters.
Return values
array<string|int, mixed> —Parameter list with token added.
checkToken()
Check for a download token.
public
checkToken(Horde_Variables $vars) : mixed
Parameters
- $vars : Horde_Variables
-
Form variables.
Tags
downloadAll()
public
downloadAll() : mixed
downloadAttach()
public
downloadAttach(mixed $id) : mixed
Parameters
- $id : mixed
downloadRender()
public
downloadRender(mixed $id, mixed $mode[, mixed $ctype = null ]) : mixed
Parameters
- $id : mixed
- $mode : mixed
- $ctype : mixed = null
downloadUrl()
Returns a URL to be used for downloading data.
public
static downloadUrl(string $filename[, array<string|int, mixed> $params = array() ]) : Horde_Url
IMP adds token data, since the data displayed is coming from a remote source.
Parameters
- $filename : string
-
The filename of the download data.
- $params : array<string|int, mixed> = array()
-
Additional URL parameters needed.
Tags
Return values
Horde_Url —The download URL.
printAttach()
public
printAttach(mixed $id) : mixed
Parameters
- $id : mixed
saveMessage()
public
saveMessage() : mixed
viewAttach()
public
viewAttach(mixed $id, mixed $mode[, mixed $autodetect = false ][, mixed $ctype = null ]) : mixed
Parameters
- $id : mixed
- $mode : mixed
- $autodetect : mixed = false
- $ctype : mixed = null
Tags
viewSource()
public
viewSource() : mixed
_getRawDownloadPart()
Get a MIME Part for use in creating download.
protected
_getRawDownloadPart(string $id) : Horde_Mime_Part
Parameters
- $id : string
-
MIME ID.
Return values
Horde_Mime_Part —MIME part, or null on error.