OSS
Back to top  

OSS: Message

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

 Methods

The constructor

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

Parameters

$message

$class

$isHTML

Get the class

getClass() : string

Returns

stringthe class

Get the message

getMessage() : string

Returns

string

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

getPlaintext() : string

Returns

string

Get the message type

getType() : int

Returns

int

Set the class

setClass(string $class) 

Parameters

$class

string

the class

Set the message type

setType(int $type) : void

Parameters

$type

int

Message type

 Properties

 

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

$class : string

error, success, info)

 

A variable to indicate whether the message is HTML or not

$isHTML : bool
 

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

$message : mixed
 

The type of OSS_Message

$type : int

 Constants

 

ALERT

ALERT 
 

ERROR

ERROR 
 

INFO

INFO 
 

SUCCESS

SUCCESS 
 

TYPE_BLOCK

TYPE_BLOCK 
 

TYPE_MESSAGE

TYPE_MESSAGE 
 

TYPE_POP_UP

TYPE_POP_UP 
 

WARNING

WARNING