dmBridge PHP API
DMFlash Class Reference

Encapsulates a temporary status message that is generated in response to some state-changing action on the server. More...

Public Member Functions

Data Fields


Detailed Description

Encapsulates a temporary status message that is generated in response to some state-changing action on the server.

It consists of a value (a text string) and a status, which can be one of positive/success negative/failure, or neutral/null (the default; see setStatus()).

Author:
Alex Dolski <alex.dolski@unlv.edu> http://www.opensource.org/licenses/mit-license.php

Definition at line 17 of file DMFlash.php.


Constructor & Destructor Documentation

DMFlash::__construct ( value,
status = null 
) [final]
Parameters:
stringvalue
Boolean|nullstatus
Since:
0.1

Definition at line 26 of file DMFlash.php.


Member Function Documentation

DMFlash::__toString ( ) [final]
Returns:
string
Since:
0.1

Definition at line 35 of file DMFlash.php.

DMFlash::getStatus ( ) [final]
Returns:
True for positive/sucess, false for negative/failure, or null for neutral/null. You must use the === operator to check the return value.
Since:
0.1

Definition at line 45 of file DMFlash.php.

DMFlash::getValue ( ) [final]
Returns:
string
Since:
0.1

Definition at line 67 of file DMFlash.php.

Referenced by __toString().

DMFlash::setStatus ( status) [final]
Parameters:
Boolean|nullstatus True for sucess, false for failure, or null for neutral (will affect the CSS class given to the tag rendered by DMGenericTemplateHelper::drawFormattedFlash()).
Since:
0.1

Definition at line 55 of file DMFlash.php.

Referenced by __construct().

DMFlash::setValue ( value) [final]
Parameters:
stringvalue
Since:
0.1

Definition at line 75 of file DMFlash.php.

Referenced by __construct().


The documentation for this class was generated from the following file:
 All Data Structures Functions Variables