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)

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

Campos de Dados
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'

Descrição detalhada

Definido na linha 57 do ficheiro mmessage.class.

Documentação dos Construtores & Destrutor

__construct()

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

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

Definido na linha 78 do ficheiro mmessage.class.

Documentação das funções

clearLastMessage()

static clearLastMessage ( )

static

Clear the last registered message in session

Definido na linha 121 do ficheiro mmessage.class.

getCssClass()

static getCssClass ( $type = self::TYPE_INFORMATION )

static

Definido na linha 138 do ficheiro mmessage.class.

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.

Definido na linha 169 do ficheiro mmessage.class.

getMessageSession()

static getMessageSession ( )

static

Returns session object that could have messages

Retorna

(object) MSession

Definido na linha 113 do ficheiro mmessage.class.

getStaticMessage()

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

static

Returns a div with a message to be usesd statically

Retorna

(object) MDiv

Definido na linha 133 do ficheiro mmessage.class.

Documentação dos campos e atributos

CSS_CLASS

const CSS_CLASS = 'm-message m-message'

Definido na linha 65 do ficheiro mmessage.class.

MSG_CONTAINER_ID

const MSG_CONTAINER_ID = 'm-message-div'

Definido na linha 66 do ficheiro mmessage.class.

MSG_DIV_ID

const MSG_DIV_ID = 'main-message-div'

Definido na linha 67 do ficheiro mmessage.class.

TYPE_ERROR

const TYPE_ERROR = 'error'

Definido na linha 63 do ficheiro mmessage.class.

TYPE_INFORMATION

const TYPE_INFORMATION = 'information'

Definido na linha 61 do ficheiro mmessage.class.

TYPE_SUCCESS

const TYPE_SUCCESS = 'success'

Definido na linha 60 do ficheiro mmessage.class.

TYPE_WARNING

const TYPE_WARNING = 'warning'

Definido na linha 62 do ficheiro mmessage.class.

---

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

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