t3lib_FlashMessage Class Reference

List of all members.

Public Member Functions

 __construct ($message, $title= '', $severity=self::OK, $storeInSession=FALSE)
 getTitle ()
 setTitle ($title)
 isSessionMessage ()
 setStoreInSession ($storeInSession)
 getMessage ()
 setMessage ($message)
 getSeverity ()
 setSeverity ($severity=self::OK)
 render ()
 __toString ()

Public Attributes

const NOTICE = -2
const INFO = -1
const OK = 0
const WARNING = 1
const ERROR = 2

Protected Attributes

 $title = ''
 $message = ''
 $severity = self::OK
 $storeInSession = FALSE

Detailed Description

Definition at line 36 of file class.t3lib_flashmessage.php.

Constructor & Destructor Documentation

t3lib_FlashMessage::__construct ( $  message,
$  title = '',
$  severity = self::OK,
$  storeInSession = FALSE 
)

Constructor for a flash message

Parameters:
string The message.
string Optional message title.
integer Optional severity, must be either of t3lib_FlashMessage::INFO, t3lib_FlashMessage::OK, t3lib_FlashMessage::WARNING or t3lib_FlashMessage::ERROR. Default is t3lib_FlashMessage::OK.
bool Optional, defines whether the message should be stored in the session or only for one request (default)
Returns:
void

Definition at line 82 of file class.t3lib_flashmessage.php.

References $message, $severity, $storeInSession, $title, setMessage(), setSeverity(), setStoreInSession(), and setTitle().

Member Function Documentation

t3lib_FlashMessage::__toString (  ) 

Creates a string representation of the flash message. Useful for command line use.

Returns:
string A string representation of the flash message.

Definition at line 206 of file class.t3lib_flashmessage.php.

References $title, ERROR, INFO, OK, and WARNING.

t3lib_FlashMessage::getMessage (  ) 

Gets the message.

Returns:
string The message.

Definition at line 134 of file class.t3lib_flashmessage.php.

t3lib_FlashMessage::getSeverity (  ) 

Gets the message' severity.

Returns:
integer The message' severity, either of t3lib_FlashMessage::INFO, t3lib_FlashMessage::OK, t3lib_FlashMessage::WARNING or t3lib_FlashMessage::ERROR

Definition at line 153 of file class.t3lib_flashmessage.php.

t3lib_FlashMessage::getTitle (  ) 

Gets the message's title.

Returns:
string The message's title.

Definition at line 94 of file class.t3lib_flashmessage.php.

t3lib_FlashMessage::isSessionMessage (  ) 

Gets the message's storeInSession flag.

Returns:
bool true if message should be stored in the session, otherwise false.

Definition at line 114 of file class.t3lib_flashmessage.php.

t3lib_FlashMessage::render (  ) 

Renders the flash message.

Returns:
string The flash message as HTML.

Definition at line 177 of file class.t3lib_flashmessage.php.

References $message, $title, ERROR, INFO, NOTICE, OK, and WARNING.

t3lib_FlashMessage::setMessage ( $  message  ) 

Sets the message

Parameters:
string The message
Returns:
void

Definition at line 144 of file class.t3lib_flashmessage.php.

References $message.

Referenced by __construct().

t3lib_FlashMessage::setSeverity ( $  severity = self::OK  ) 

Sets the message' severity

Parameters:
string The severity, must be either of t3lib_FlashMessage::INFO, t3lib_FlashMessage::OK, t3lib_FlashMessage::WARNING or t3lib_FlashMessage::ERROR. Default is t3lib_FlashMessage::OK.
Returns:
void

Definition at line 163 of file class.t3lib_flashmessage.php.

References $severity, and t3lib_div::intInRange().

Referenced by __construct().

t3lib_FlashMessage::setStoreInSession ( $  storeInSession  ) 

Sets the message's storeInSession flag

Parameters:
bool The persistence flag
Returns:
void

Definition at line 124 of file class.t3lib_flashmessage.php.

References $storeInSession.

Referenced by __construct().

t3lib_FlashMessage::setTitle ( $  title  ) 

Sets the message's title

Parameters:
string The message's title
Returns:
void

Definition at line 104 of file class.t3lib_flashmessage.php.

References $title.

Referenced by __construct().

Member Data Documentation

t3lib_FlashMessage::$message = '' [protected]

Definition at line 56 of file class.t3lib_flashmessage.php.

Referenced by __construct(), render(), and setMessage().

t3lib_FlashMessage::$severity = self::OK [protected]

Definition at line 63 of file class.t3lib_flashmessage.php.

Referenced by __construct(), and setSeverity().

t3lib_FlashMessage::$storeInSession = FALSE [protected]

Definition at line 70 of file class.t3lib_flashmessage.php.

Referenced by __construct(), and setStoreInSession().

t3lib_FlashMessage::$title = '' [protected]

Definition at line 49 of file class.t3lib_flashmessage.php.

Referenced by __construct(), __toString(), render(), and setTitle().

const t3lib_FlashMessage::ERROR = 2

Definition at line 42 of file class.t3lib_flashmessage.php.

Referenced by __toString(), SC_mod_tools_em_index::clearAndMakeExtensionDir(), tx_scheduler_Module::executeTasks(), SC_mod_tools_em_index::extDelete(), t3lib_extFileFunctions::getErrorMessages(), tx_sysaction_task::getTask(), SC_mod_tools_em_index::importExtFromRep(), tx_tstemplateobjbrowser::main(), SC_mod_user_setup_index::main(), SC_mod_tools_config_index::main(), tx_scheduler_Module::preprocessData(), t3lib_TCEmain::printLogErrorMessages(), t3lib_fullsearch::procesStoreControl(), render(), SC_mod_user_task_index::renderModuleContent(), tx_saltedpasswords_emconfhelper::setErrorLevel(), t3lib_BEfunc::thumbCode(), tx_scheduler_TestTask_AdditionalFieldProvider::validateAdditionalFields(), tx_scheduler_SleepTask_AdditionalFieldProvider::validateAdditionalFields(), tx_sysaction_task::viewNewBackendUser(), tx_sysaction_task::viewRecordList(), and tx_sysaction_task::viewSqlQuery().

const t3lib_FlashMessage::INFO = -1

Definition at line 39 of file class.t3lib_flashmessage.php.

Referenced by __toString(), recordHistory::displayHistory(), SC_mod_tools_em_index::fetchMetaData(), SC_mod_user_task_index::indexAction(), SC_mod_tools_em_index::init(), SC_db_layout::main(), SC_alt_db_navframe::main(), SC_mod_user_setup_index::main(), SC_mod_web_func_index::main(), tx_rtehtmlarea_browse_links::main_rte(), browse_links::main_rte(), SC_mod_web_ts_index::noTemplate(), render(), tx_sysaction_task::renderActionList(), SC_mod_user_task_index::renderModuleContent(), tx_saltedpasswords_emconfhelper::setErrorLevel(), SC_mod_tools_em_index::showExtDetails(), and SC_mod_tools_em_index::tsStyleConfigForm().

const t3lib_FlashMessage::NOTICE = -2

Definition at line 38 of file class.t3lib_flashmessage.php.

Referenced by tx_impexp_task::main(), and render().

const t3lib_FlashMessage::OK = 0

Definition at line 40 of file class.t3lib_flashmessage.php.

Referenced by __toString(), SC_mod_tools_em_index::extDelete(), SC_mod_user_setup_index::main(), SC_mod_tools_config_index::main(), render(), tx_saltedpasswords_emconfhelper::renderFlashMessage(), tx_saltedpasswords_emconfhelper::setErrorLevel(), SC_mod_tools_em_index::showExtDetails(), and tx_sysaction_task::viewNewBackendUser().

const t3lib_FlashMessage::WARNING = 1

Definition at line 41 of file class.t3lib_flashmessage.php.

Referenced by __toString(), SC_mod_web_perm_index::doEdit(), SC_alt_doc::makeEditForm(), render(), SC_mod_user_setup_index::renderLanguageSelect(), SC_db_layout::renderQuickEdit(), and tx_saltedpasswords_emconfhelper::setErrorLevel().

The documentation for this class was generated from the following file:
Generated on Sat Sep 4 04:18:22 2010 for TYPO3 API by  doxygen 1.4.7