OSS_Message pop up type class for displaying messages for users.

category OSS
package OSS_Message
copyright Copyright (c) 2007 - 2012, Open Source Solutions Limited, Dublin, Ireland
license New BSD License
author Barry O'Donovan
author Roland Huszti
author Nerijus Barauskas

 Methods

Constructor

__construct(string $message, string $class, bool $isHTML) : void

Parameters

$message

string

Message to display

$class

string

Message class

$isHTML

bool

Htmk flag

Adding message box

addAction(string $str) : void

Parameters

$str

string

Action description

Getting messages

getActions() : array

Returns

array

Get the class

getClass() : string
Inherited
inherited_from \OSS_Message::getClass()

Returns

stringthe class

Get the message

getMessage() : string
Inherited
inherited_from \OSS_Message::getMessage()

Returns

string

Get the message as plaintext - essentially strips the tags from the message if it is an HTML message

getPlaintext() : string
Inherited
inherited_from \OSS_Message::getPlaintext()

Returns

string

Get the message type

getType() : int
Inherited
inherited_from \OSS_Message::getType()

Returns

int

Set the class

setClass(string $class) 
Inherited
inherited_from \OSS_Message::setClass()

Parameters

$class

string

the class

Set the message type

setType(int $type) : void
Inherited
inherited_from \OSS_Message::setType()

Parameters

$type

int

Message type

 Properties

 

A variable to hold the appropriate HTML class (e.g.

$class : string
Inherited

error, success, info)

inherited_from \OSS_Message::$$class
 

A variable to indicate whether the message is HTML or not

$isHTML : bool
Inherited
inherited_from \OSS_Message::$$isHTML
 

A variable to hold the message (either scalar string or array of strings )

$message : mixed
Inherited
inherited_from \OSS_Message::$$message
 

The type of OSS_Message

$type : int
Inherited
inherited_from \OSS_Message::$$type
 

Elements for the action area

$actions : null | array

 Constants

 

ALERT

ALERT 
Inherited
inherited_from \OSS_Message::ALERT
 

ERROR

ERROR 
Inherited
inherited_from \OSS_Message::ERROR
 

INFO

INFO 
Inherited
inherited_from \OSS_Message::INFO
 

SUCCESS

SUCCESS 
Inherited
inherited_from \OSS_Message::SUCCESS
 

TYPE_BLOCK

TYPE_BLOCK 
Inherited
inherited_from \OSS_Message::TYPE_BLOCK
 

TYPE_MESSAGE

TYPE_MESSAGE 
Inherited
inherited_from \OSS_Message::TYPE_MESSAGE
 

TYPE_POP_UP

TYPE_POP_UP 
Inherited
inherited_from \OSS_Message::TYPE_POP_UP
 

WARNING

WARNING 
Inherited
inherited_from \OSS_Message::WARNING