Referência à classe MMessage

Diagrama de heranças da classe MMessage

Membros públicos
	__construct ($message, $type=self::TYPE_INFORMATION, $display=true, $msgContainer=self::MSG_CONTAINER_ID, $animate=true)

Membros públicos estáticos
static	getMessageSession ()
static	clearLastMessage ()
static	getStaticMessage ($name, $message, $type=self::TYPE_SUCCESS)
static	getMessageContainer ()

Campos de Dados
const	TYPE_SUCCESS = 'Success'
const	TYPE_INFORMATION = 'Information'
const	TYPE_WARNING = 'Warning'
const	TYPE_ERROR = 'Error'
const	CSS_CLASS = 'mMessage mMessage'
const	MSG_CONTAINER_ID = 'messageDiv'
const	MSG_DIV_ID = 'mainMessageDiv'

Documentação dos Construtores & Destrutor

__construct()

__construct	(		$message,
			$type = self::TYPE_INFORMATION,
			$display = true,
			$msgContainer = self::MSG_CONTAINER_ID,
			$animate = true )

Returns a message, formated according the type.

Parâmetros

(string)	$mensagem Message to show
(string)	$type Message type, TYPE_INFORMATION, TYPE_WARNING or TYPE_ERROR
(boolean)	$display Defines if the message will be displayed, otherwise, message is registered in session to be displayed on the next event
(string)	$msgContainer Id of the div/container where the message will be displayed
(boolean)	$animate Sets if the message must be animated

Documentação das funções

clearLastMessage()

static clearLastMessage ( )

static

Clear the last registered message in session

getMessageContainer()

static getMessageContainer ( )

static

Create a container for the messages. If a message is registered in session, returns it in the container.

Retorna

(object) Container (MDiv) with a message, if it's registered in session.

getMessageSession()

static getMessageSession ( )

static

Returns session object that could have messages

Retorna

(object) MSession

getStaticMessage()

static getStaticMessage ( $name, $message, $type = self::TYPE_SUCCESS )

static

Returns a div with a message to be usesd statically

Retorna

(object) MDiv

Documentação dos campos e atributos

CSS_CLASS

const CSS_CLASS = 'mMessage mMessage'

MSG_CONTAINER_ID

const MSG_CONTAINER_ID = 'messageDiv'

MSG_DIV_ID

const MSG_DIV_ID = 'mainMessageDiv'

TYPE_ERROR

const TYPE_ERROR = 'Error'

TYPE_INFORMATION

const TYPE_INFORMATION = 'Information'

TYPE_SUCCESS

const TYPE_SUCCESS = 'Success'

TYPE_WARNING

const TYPE_WARNING = 'Warning'

---

A documentação para esta classe foi gerada a partir do seguinte ficheiro:

• /var/docker/solisge-devel/www/solisge/miolo25/classes/ui/controls/mmessage.class.php