Current File : //usr/local/prospamfilter/application/views/helpers/FlashMessages.php
<?php
/**
* FlashMessages view helper
* application/modules/admin/views/helpers/FlashMessages.php
*
* This helper creates an easy method to return groupings of
* flash messages by status.
*
* @author Aaron Bach <bachya1208[at]googlemail.com
* @license Free to use - no strings.
*/
class Zend_View_Helper_FlashMessages
{
/**
* flashMessages function.
*
* Takes a specially formatted array of flash messages and prepares them
* for output.
*
* SAMPLE INPUT (in, say, a controller):
* $this->_flashMessenger->addMessage(array('message' => 'Success message #1', 'status' => 'success'));
* $this->_flashMessenger->addMessage(array('message' => 'Error message #1', 'status' => 'error'));
* $this->_flashMessenger->addMessage(array('message' => 'Warning message #1', 'status' => 'warning'));
* $this->_flashMessenger->addMessage(array('message' => 'Success message #2', 'status' => 'success'));
*
* SAMPLE OUTPUT (in a view):
* <div class="success">
* <ul>
* <li>Success message #1</li>
* <li>Success message #2</li>
* </ul>
* </div>
* <div class="error">Error message #1</div>
* <div class="warning">Warning message #2</div>
*
* @access public
* @param Zend_Translate $translator An optional instance of Zend_Translate
* @return string HTML of output messages
*/
public function flashMessages($translator = NULL)
{
// Set up some variables, including the retrieval of all flash messages.
/** @var $fh Zend_Controller_Action_Helper_FlashMessenger */
$fh = Zend_Controller_Action_HelperBroker::getStaticHelper('FlashMessenger');
$messages = $fh->getMessages() + $fh->getCurrentMessages(); ## retrieve old + new
$fh->clearCurrentMessages(); // Clear the current ones to not show them again.
$statMessages = array();
$output = '';
// If there are no messages, don't bother with this whole process.
if (is_array($messages) && count($messages) > 0)
{
// This chunk of code takes the messages (formatted as in the above sample
// input) and puts them into an array of the form:
// Array(
// [status1] => Array(
// [0] => "Message 1"
// [1] => "Message 2"
// ),
// [status2] => Array(
// [0] => "Message 1"
// [1] => "Message 2"
// )
// ....
// )
foreach ($messages as $message)
{
if (!array_key_exists($message['status'], $statMessages))
$statMessages[$message['status']] = array();
if ($translator != NULL && $translator instanceof Zend_Translate)
array_push($statMessages[$message['status']], $translator->_($message['message']));
else
array_push($statMessages[$message['status']], $message['message']);
}
// This chunk of code formats messages for HTML output (per
// the example in the class comments).
foreach ($statMessages as $status => $messages)
{
$output .= '<div class="alert alert-' . $status . (('error' == $status) ? ' alert-danger' : '') . '">';
$output .= join('<br />', $messages);
$output .= '</div>';
}
// Return the final HTML string to use.
return $output;
}
}
}
/*
##
Instantiation (demonstrated in controller here):
<?php
public function init()
{
// Enable the flash messenger helper so we can send messages.
$this->_flashMessenger = $this->_helper->getHelper('FlashMessenger');
}
...
public function deleteAction()
{
// Tell the user that we succeeded.
$this->_flashMessenger->addMessage(array('message' => 'Broker deleted.', 'status' => 'success'));
// Redirect user back to edit page.
$this->_helper->redirector('edit', 'broker');
}
##
Usage (in a view):
<?php echo($this->flashMessages()); ?>
*/
Mini Shell