* @category Horde
* @copyright 2011-2017 Horde LLC
* @license http://www.horde.org/licenses/gpl GPL
* @package IMP
*/
class IMP_Mime_Status
{
/* Action constants. */
const ERROR = 1;
const SUCCESS = 2;
const WARNING = 3;
/**
* Views to display this status in.
*
* @var array
*/
public $views = array(
Horde_Registry::VIEW_BASIC,
Horde_Registry::VIEW_DYNAMIC,
Horde_Registry::VIEW_MINIMAL
);
/**
* DOM ID to use for the status block.
*
* @var string
*/
protected $_domid;
/**
* Icon image HTML.
*
* @var string
*/
protected $_icon;
/**
* List of text to output. Each entry will be output on a newline.
*
* @var array
*/
protected $_text = array();
/**
* Constructor.
*
* @param mixed $text See addText().
*/
public function __construct($text = null)
{
if (!is_null($text)) {
$this->addText($text);
}
}
/**
* Pre-defined actions.
*
* @param integer $type The action type.
*/
public function action($type)
{
switch ($type) {
case self::ERROR:
$this->icon('alerts/error.png', _("Error"));
break;
case self::SUCCESS:
$this->icon('alerts/success.png', _("Success"));
break;
case self::WARNING:
$this->icon('alerts/warning.png', _("Warning"));
break;
}
}
/**
* Adds text line(s) to the output.
*
* @param mixed $text Either a line of text or an array of lines to add.
*/
public function addText($text)
{
if (!is_array($text)) {
$text = array($text);
}
$this->_text = array_merge($this->_text, $text);
}
/**
* Set the icon to use for the status block (Default: no icon).
*
* @param string $img The image file.
* @param string $alt ALT text to use.
*/
public function icon($img, $alt = null)
{
$this->_icon = Horde_Themes_Image::tag($img, array('alt' => $alt));
}
/**
* Set a DOM ID for the status block.
*
* @param string $id The DOM ID to use.
*/
public function domid($id = null)
{
$this->_domid = $id;
}
/**
* Output status block HTML.
*
* @return string The formatted status message HTML.
*/
public function __toString()
{
global $registry;
$out = '';
switch ($registry->getView()) {
case $registry::VIEW_SMARTMOBILE:
foreach ($this->_text as $val) {
$out .= '
' . $val . '
';
}
break;
default:
$out = '
_domid) ? (' id="' . $this->_domid . '" ') : '')
. '>';
/* If no image, simply print out the message. */
if (empty($this->_icon)) {
foreach ($this->_text as $val) {
$out .= '