mirror of
https://github.com/Icinga/icingaweb2.git
synced 2025-05-28 02:20:10 +02:00
2a0add3ec3
Store messages in the current user session to be able to fetch messages from other controllers, so that the use can be redirected back to the index, instead of staying in the original action refs #5100
119 lines
3.8 KiB
PHP
119 lines
3.8 KiB
PHP
<?php
|
|
// {{{ICINGA_LICENSE_HEADER}}}
|
|
/**
|
|
* This file is part of Icinga Web 2.
|
|
*
|
|
* Icinga Web 2 - Head for multiple monitoring backends.
|
|
* Copyright (C) 2013 Icinga Development Team
|
|
*
|
|
* This program is free software; you can redistribute it and/or
|
|
* modify it under the terms of the GNU General Public License
|
|
* as published by the Free Software Foundation; either version 2
|
|
* of the License, or (at your option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License
|
|
* along with this program; if not, write to the Free Software
|
|
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
|
|
*
|
|
* @copyright 2013 Icinga Development Team <info@icinga.org>
|
|
* @license http://www.gnu.org/licenses/gpl-2.0.txt GPL, version 2
|
|
* @author Icinga Development Team <info@icinga.org>
|
|
*
|
|
*/
|
|
// {{{ICINGA_LICENSE_HEADER}}}
|
|
|
|
namespace Icinga\Web\Controller;
|
|
|
|
use \Icinga\Application\Icinga;
|
|
use \Icinga\Authentication\Manager as AuthenticationManager;
|
|
use \Zend_Log;
|
|
use \Icinga\User\Message;
|
|
|
|
/**
|
|
* Base class for Configuration Controllers
|
|
*
|
|
* Module preferences use this class to make sure they are automatically
|
|
* added to the application's configuration dialog. If you create a subclass of
|
|
* BasePreferenceController and overwrite @see init(), make sure you call
|
|
* parent::init(), otherwise you won't have the $tabs property in your view.
|
|
*/
|
|
class BaseConfigController extends ActionController
|
|
{
|
|
/**
|
|
* @var Zend_Controller_Action_Helper_FlashMessenger
|
|
*/
|
|
protected $flashManager;
|
|
|
|
/**
|
|
* Remove all messages from the current user, return them and commit
|
|
* changes to the underlying session.
|
|
*
|
|
* @return array The messages
|
|
*/
|
|
protected function getAndClearMessages()
|
|
{
|
|
// empty all messages
|
|
$user = AuthenticationManager::getInstance()->getUser();
|
|
$messages = $user->getMessages();
|
|
$user->clearMessages();
|
|
AuthenticationManager::getInstance()->getSession()->write();
|
|
return $messages;
|
|
}
|
|
|
|
/**
|
|
* Send a message with the logging level Zend_Log::INFO to the current user and
|
|
* commit the changes to the underlying session.
|
|
*
|
|
* @param $msg The message content
|
|
*/
|
|
protected function addSuccessMessage($msg)
|
|
{
|
|
AuthenticationManager::getInstance()->getUser()->addMessage(
|
|
new Message($msg, Zend_Log::INFO)
|
|
);
|
|
AuthenticationManager::getInstance()->getSession()->write();
|
|
}
|
|
|
|
/**
|
|
* Send a message with the logging level Zend_Log::ERR to the current user and
|
|
* commit the changes to the underlying session.
|
|
*
|
|
* @param $msg The message content
|
|
*/
|
|
protected function addErrorMessage($msg)
|
|
{
|
|
AuthenticationManager::getInstance()->getUser()->addMessage(
|
|
new Message($msg, Zend_Log::ERR)
|
|
);
|
|
AuthenticationManager::getInstance()->getSession()->write();
|
|
}
|
|
|
|
/*
|
|
* Return an array of tabs provided by this configuration controller.
|
|
*
|
|
* Those tabs will automatically be added to the application's configuration dialog
|
|
*
|
|
* @return array
|
|
*/
|
|
public static function createProvidedTabs()
|
|
{
|
|
return array();
|
|
}
|
|
|
|
/**
|
|
* Initialize the controller and collect all tabs for it from the application and it's modules
|
|
*
|
|
* @see ActionController::init
|
|
*/
|
|
public function init()
|
|
{
|
|
parent::init();
|
|
$this->view->tabs = ControllerTabCollector::collectControllerTabs('ConfigController');
|
|
}
|
|
}
|