/**
* Renders set session flash messages
*
* @param array an array of message types to render
* @param array an array of rendering options, see function for details
* @return array
*/
public static function render($displayOnlyType = array(), $options = array())
{
// build up the default options
/**
* growl If TRUE all errors are generate a growl message, this can be
* disabled with FLASE or it can be an array of message types
* growlTemplate This is the growl JS statement, any arbitrary var used in
* the second parameter of setMessage can be referenced via {foo}
* defaults avaliable are {key}, {type}, and {text}
* html If TRUE all errors are generate a html message, this can be
* disabled with FLASE or it can be an array of message types
* htmlTemplate This is the html markup, any arbitrary var used in
* the second parameter of setMessage can be referenced via {foo}
* defaults avaliable are {key}, {type}, and {text}
* inline If inline is true then this puts the messages outputs into
* the buffer
*/
$options += array('growl' => array('alert', 'info', 'success'), 'growlTemplate' => '$.jGrowl(\'{text}\', { theme: \'{type}\', life: 5000 });', 'html' => array('error'), 'htmlTemplate' => '<div class="{type}">{text}</div>', 'inline' => TRUE);
// get the messages
$flashMessages = Session::instance()->get_once('bluebox_message', array());
// set up some empty result arrays
$growl = array();
$html = array();
// loop through each message
foreach ($flashMessages as $flashKey => $flashMessage) {
// if we have been asked to show a type and this isnt it then move on
if (!empty($displayOnlyType) && $displayOnlyType != $flashMessage['type']) {
continue;
}
// allow the templates in options to be populated with anything in the message subarray
$search = array_keys($flashMessage);
$search = array_map(create_function('$v', 'return \'{\' . $v . \'}\';'), $search);
// if we are generating a growl message then do so
if (!empty($options['growl'])) {
if ($options['growl'] === TRUE || is_array($options['growl']) && in_array($flashMessage['type'], $options['growl'])) {
Event::run('bluebox.message_growl', $flashMessage['text']);
$flashMessage['text'] = str_replace('\'', '\\\'', $flashMessage['text']);
$growl[] = str_replace($search, $flashMessage, $options['growlTemplate']);
}
}
// if we are generating a html markup then do so
if (!empty($options['html'])) {
if ($options['html'] === TRUE || is_array($options['html']) && in_array($flashMessage['type'], $options['html'])) {
Event::run('bluebox.message_html', $flashMessage['text']);
$flashMessage['text'] = str_replace('"', '\'', $flashMessage['text']);
$html[] = str_replace($search, $flashMessage, $options['htmlTemplate']);
}
}
// this message is assumed to have been displayed, remove it
unset($flashMessages[$flashKey]);
}
// save back any messages that did not get displayed to the user
Session::instance()->set('bluebox_message', $flashMessages);
// if we are doing this inline then echo it out here and now
if (!empty($options['inline'])) {
if (!empty($html)) {
echo implode(' ', $html);
}
if (!empty($growl)) {
jquery::addPlugin('growl');
jquery::evalScript(implode(' ', $growl));
}
}
// if the user wants the results then give it to them
return compact('growl', 'html');
}
