mmessage.class

Ir para a documentação deste ficheiro.

<?php
 
/*
 * Class to show a message.
 * This classes can be used to show messages to the user, using Dojo's features. On your form, 
 * you need only to add a field, which will be used to show the message, and than when you want, 
 * create a new MMessage object and it's done.  
 * 
 * @example
 * <code>
 * ...
 * $fields[] = MMessage::getMessageContainer();
 * $this->setFields($fields);
 * ...
 * new MMessage("Error message string here.", MMessage::TYPE_ERROR);
 * </code>
 * 
 */
$MIOLO = MIOLO::getInstance();
if (!is_null($MIOLO->page))
{
    $MIOLO->page->addScript('m_message.js');
}
 
class MMessage
{
    // Message types
    const TYPE_SUCCESS = 'success';
    const TYPE_INFORMATION = 'information';
    const TYPE_WARNING = 'warning';
    const TYPE_ERROR = 'error';
 
    const CSS_CLASS = 'm-message m-message';
    const MSG_CONTAINER_ID = 'm-message-div';
    const MSG_DIV_ID = 'main-message-div';
 
    public function __construct($message, $type = self::TYPE_INFORMATION, $display = true, $msgContainer = self::MSG_CONTAINER_ID)
    {
        $MIOLO = MIOLO::getInstance();
 
        if ( is_array($message) )
        {
            $message = implode($message, '<br/>');
        }
 
        $box = new MDiv(self::MSG_DIV_ID, $message, self::getCssClass($type));
 
        if ( $display )
        {
            $jsCode = "mmessage.show('$msgContainer'); ";
            $jsCode .= "mmessage.connectHideEvents('". self::MSG_DIV_ID ."'); ";
 
            $generatedBox = addslashes(str_replace("\n", ' ', $box->generate()));
 
            $jsCode .= "document.getElementById('$msgContainer').innerHTML = '$generatedBox';";
            $MIOLO->page->onload($jsCode);
        }
        else
        {
            // TODO: some kind of multi message support, adding them to the session
            $session = new MSession(self::MSG_DIV_ID);
            $session->setValue('lastMessage', $message);
            $session->setValue('lastType', $type);
        }
    }
 
    public static function getMessageSession()
    {
        return new MSession(self::MSG_DIV_ID);
    }
 
    public static function clearLastMessage()
    {
        $session = new MSession(self::MSG_DIV_ID);
        $session->setValue('lastMessage', '');
        $session->setValue('lastType', '');
    }
 
    public static function getStaticMessage($name, $message, $type = self::TYPE_SUCCESS)
    {
        return new MDiv($name, $message, self::getCssClass($type));
    }
 
    public static function getCssClass($type = self::TYPE_INFORMATION)
    {
        $cssClass = self::CSS_CLASS . '-' . $type . ' alert ';
 
        switch ($type)
        {
            case self::TYPE_SUCCESS:
                $cssClass .= 'alert-success';
                break;
 
            case self::TYPE_INFORMATION:
                $cssClass .= 'alert-info';
                break;
 
            case self::TYPE_WARNING:
                $cssClass .= 'alert-warning';
                break;
 
            case self::TYPE_ERROR:
                $cssClass .= 'alert-danger';
                break;
        }
 
        return $cssClass;
    }
 
    public static function getMessageContainer()
    {
        $MIOLO = MIOLO::getInstance();
 
        $session = self::getMessageSession();
        $type = $session->getValue('lastType');
        $message = $session->getValue('lastMessage');
 
        $content = '';
 
        // if a message exists in session, return it
        if ( $type && $message )
        {
            $content = new MDiv(self::MSG_DIV_ID, $message, self::getCssClass($type));
            
            self::clearLastMessage();
 
            $jsCode = "mmessage.show('". self::MSG_DIV_ID ."');";
            $jsCode .= "mmessage.connectHideEvents('". self::MSG_DIV_ID ."');";
            $MIOLO->page->onload($jsCode);
        }
 
        return new MDiv(self::MSG_CONTAINER_ID, $content);
    }
}
 
class MMessageSuccess extends MMessage
{
    public function __construct($message, $display = true)
    {
        parent::__construct($message, self::TYPE_SUCCESS, $display);
 
    }
}
 
class MMessageInformation extends MMessage
{
    public function __construct($message, $display = true)
    {
        parent::__construct($message, self::TYPE_INFORMATION, $display);
    }
}
 
class MMessageWarning extends MMessage
{
    public function __construct($message, $display = true)
    {
        parent::__construct($message, self::TYPE_WARNING, $display);
    }
}
 
class MMessageError extends MMessage
{
    public function __construct($message, $display = true)
    {
        parent::__construct($message, self::TYPE_ERROR, $display);
    }
}
 
?>