Notification: Add todo that we do not want singleton usage of this class

This commit is contained in:
Eric Lippmann 2013-07-12 11:53:05 +02:00
parent 6d05361370
commit 63a8854f40
1 changed files with 19 additions and 91 deletions

View File

@ -1,104 +1,45 @@
<?php <?php
// {{{ICINGA_LICENSE_HEADER}}}
/**
* Icinga 2 Web - Head for multiple monitoring frontends
* 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>
* @author Icinga Development Team <info@icinga.org>
*/
// {{{ICINGA_LICENSE_HEADER}}}
namespace Icinga\Web; namespace Icinga\Web;
use Icinga\Exception\ProgrammingError; use Icinga\Exception\ProgrammingError;
use Icinga\Application\Platform; use Icinga\Application\Platform;
use Icinga\Application\Logger as Log; use Icinga\Application\Logger as Log;
use Icinga\Authentication\Manager as AuthManager;
/** /**
* Class Notification * // @TODO(eL): Use Notification not as Singleton but within request:
* @package Icinga\Web * <code>
* <?php
* $request->[getUser()]->notify('some message', Notification::INFO);
* </code>
*/ */
class Notification class Notification
{ {
/** protected static $instance;
* @var Notification protected $isCli = false;
*/
private static $instance;
/**
* @var bool
*/
private $cliFlag = false;
/**
* @param boolean $cliFlag
*/
public function setCliFlag($cliFlag)
{
$this->cliFlag = $cliFlag;
}
/**
* @return boolean
*/
public function getCliFlag()
{
return $this->cliFlag;
}
/**
* @param $msg
*/
public static function info($msg) public static function info($msg)
{ {
self::getInstance()->addMessage($msg, 'info'); self::getInstance()->addMessage($msg, 'info');
} }
/**
* @param $msg
*/
public static function success($msg) public static function success($msg)
{ {
self::getInstance()->addMessage($msg, 'success'); self::getInstance()->addMessage($msg, 'success');
} }
/**
* @param $msg
*/
public static function warning($msg) public static function warning($msg)
{ {
self::getInstance()->addMessage($msg, 'warning'); self::getInstance()->addMessage($msg, 'warning');
} }
/**
* @param $msg
*/
public static function error($msg) public static function error($msg)
{ {
self::getInstance()->addMessage($msg, 'error'); self::getInstance()->addMessage($msg, 'error');
} }
/** protected function addMessage($message, $type = 'info')
* @param $message
* @param string $type
* @throws \Icinga\Exception\ProgrammingError
*/
public function addMessage($message, $type = 'info')
{ {
if (! in_array( if (! in_array(
$type, $type,
@ -108,8 +49,7 @@ class Notification
'warning', 'warning',
'success' 'success'
) )
) )) {
) {
throw new ProgrammingError( throw new ProgrammingError(
sprintf( sprintf(
'"%s" is not a valid notification type', '"%s" is not a valid notification type',
@ -118,7 +58,7 @@ class Notification
); );
} }
if ($this->cliFlag) { if ($this->is_cli) {
$msg = sprintf('[%s] %s', $type, $message); $msg = sprintf('[%s] %s', $type, $message);
switch ($type) { switch ($type) {
case 'info': case 'info':
@ -146,17 +86,11 @@ class Notification
$this->session->messages = $msgs; $this->session->messages = $msgs;
} }
/**
* @return bool
*/
public function hasMessages() public function hasMessages()
{ {
return ! empty($this->session->messages); return ! empty($this->session->messages);
} }
/**
* @return mixed
*/
public function getMessages() public function getMessages()
{ {
$msgs = $this->session->messages; $msgs = $this->session->messages;
@ -164,24 +98,18 @@ class Notification
return $msgs; return $msgs;
} }
/**
* Create a new Notification object
*/
final private function __construct() final private function __construct()
{ {
//$this->session = new SessionNamespace('IcingaNotification'); $this->session = AuthManager::getInstance()->getSession();
//if (!is_array($this->session->messages)) { if (!is_array($this->session->get('messages'))) {
$this->session->messages = array(); $this->session->messages = array();
//} }
if (Platform::isCli()) { if (Platform::isCli()) {
$this->cliFlag = true; $this->is_cli = true;
} }
} }
/**
* @return Notification
*/
public static function getInstance() public static function getInstance()
{ {
if (self::$instance === null) { if (self::$instance === null) {