• Home
  • IMP_Mime_Status

PHP Class IMP_Mime_Status, horde

Author: Michael Slusarz ([email protected])
Datei anzeigen Open project: horde/horde Class Usage Examples

Public Properties

Property Type Description
$views array Views to display this status in.

Protected Properties

Property Type Description
$_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 List of text to output. Each entry will be output on a newline.

Public Methods

Method Description
__construct ( Horde_Mime_Part $part = null, mixed $text = null ) Constructor.
__toString ( ) : string Output status block HTML.
action ( integer $type ) Pre-defined actions.
addMimeAction ( string $action, string $text, array $attr = [] ) Adds a MIME Viewer action to the status text.
addText ( mixed $text ) Adds text line(s) to the output.
domid ( string $id = null ) Set a DOM ID for the status block.
icon ( string $img, string $alt = null ) Set the icon to use for the status block (Default: no icon).

Method Details

__construct() public method

Constructor.
public __construct ( Horde_Mime_Part $part = null, mixed $text = null )
$part Horde_Mime_Part MIME Part.
$text mixed See addText().

__toString() public method

Output status block HTML.
public __toString ( ) : string
return string The formatted status message HTML.

action() public method

Pre-defined actions.
public action ( integer $type )
$type integer The action type.

addMimeAction() public method

Adds a MIME Viewer action to the status text.
public addMimeAction ( string $action, string $text, array $attr = [] )
$action string Action ID.
$text string Action description.
$attr array Additional attributes.

addText() public method

Adds text line(s) to the output.
public addText ( mixed $text )
$text mixed Either a line of text or an array of lines to add.

domid() public method

Set a DOM ID for the status block.
public domid ( string $id = null )
$id string The DOM ID to use.

icon() public method

Set the icon to use for the status block (Default: no icon).
public icon ( string $img, string $alt = null )
$img string The image file.
$alt string ALT text to use.

Property Details

$_domid protected_oe property

DOM ID to use for the status block.
protected string $_domid
return string

$_icon protected_oe property

Icon image HTML.
protected string $_icon
return string

$_part protected_oe property

MIME Part that this status object refers to.
protected Horde_Mime_Part $_part
return Horde_Mime_Part

$_text protected_oe property

List of text to output. Each entry will be output on a newline.
protected array $_text
return array

$views public_oe property

Views to display this status in.
public array $views
return array