Documentation

IMP_Mime_Status
in package

Provides the object that contains the status data to output when viewing MIME parts in IMP.

Tags
author

Michael Slusarz slusarz@horde.org

category

Horde

copyright

2011-2017 Horde LLC

license

http://www.horde.org/licenses/gpl GPL

Table of Contents

Constants

ERROR  = 1
SUCCESS  = 2
WARNING  = 3

Properties

$views  : array<string|int, mixed>
Views to display this status in.
$_domid  : string
DOM ID to use for the status block.
$_icon  : string
Icon image HTML.
$_part  : Horde_Mime_Part
MIME Part that this status object refers to.
$_text  : array<string|int, mixed>
List of text to output. Each entry will be output on a newline.

Methods

__construct()  : mixed
Constructor.
__toString()  : string
Output status block HTML.
action()  : mixed
Pre-defined actions.
addMimeAction()  : mixed
Adds a MIME Viewer action to the status text.
addText()  : mixed
Adds text line(s) to the output.
domid()  : mixed
Set a DOM ID for the status block.
icon()  : mixed
Set the icon to use for the status block (Default: no icon).

Constants

SUCCESS

public mixed SUCCESS = 2

WARNING

public mixed WARNING = 3

Properties

$views

Views to display this status in.

public array<string|int, mixed> $views = array(\Horde_Registry::VIEW_BASIC, \Horde_Registry::VIEW_DYNAMIC)

$_domid

DOM ID to use for the status block.

protected string $_domid

$_icon

Icon image HTML.

protected string $_icon

$_part

MIME Part that this status object refers to.

protected Horde_Mime_Part $_part

$_text

List of text to output. Each entry will be output on a newline.

protected array<string|int, mixed> $_text = array()

Methods

__construct()

Constructor.

public __construct([Horde_Mime_Part $part = null ][, mixed $text = null ]) : mixed
Parameters
$part : Horde_Mime_Part = null

MIME Part.

$text : mixed = null

See addText().

__toString()

Output status block HTML.

public __toString() : string
Return values
string

The formatted status message HTML.

action()

Pre-defined actions.

public action(int $type) : mixed
Parameters
$type : int

The action type.

addMimeAction()

Adds a MIME Viewer action to the status text.

public addMimeAction(string $action, string $text[, array<string|int, mixed> $attr = array() ]) : mixed
Parameters
$action : string

Action ID.

$text : string

Action description.

$attr : array<string|int, mixed> = array()

Additional attributes.

addText()

Adds text line(s) to the output.

public addText(mixed $text) : mixed
Parameters
$text : mixed

Either a line of text or an array of lines to add.

domid()

Set a DOM ID for the status block.

public domid([string $id = null ]) : mixed
Parameters
$id : string = null

The DOM ID to use.

icon()

Set the icon to use for the status block (Default: no icon).

public icon(string $img[, string $alt = null ]) : mixed
Parameters
$img : string

The image file.

$alt : string = null

ALT text to use.


        
On this page

Search results