icingaweb2/library/Icinga/Web/Session.php

<?php
// {{{ICINGA_LICENSE_HEADER}}}
/**
 * This file is part of Icinga Web 2.
 *
 * Icinga Web 2 - Head for multiple monitoring backends.
 * Copyright (C) 2014 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  2014 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;

use Icinga\Session\PhpSession;
use Icinga\Session\SessionNamespace;
use Icinga\Session\Session as BaseSession;
use Icinga\Exception\ProgrammingError;

/**
 * Session container
 */
class Session
{
    /**
     * The current session
     *
     * @var BaseSession $session
     */
    private static $session;

    /**
     * Create the session
     *
     * @param   BaseSession  $session
     *
     * @return  BaseSession
     */
    public static function create(BaseSession $session = null)
    {
        if ($session === null) {
            self::$session = new PhpSession();
        } else {
            self::$session = $session;
        }

        return self::$session;
    }

    /**
     * Return the current session
     *
     * @return  BaseSession
     * @throws  ProgrammingError
     */
    public static function getSession()
    {
        if (self::$session === null) {
            throw new ProgrammingError('No session created yet');
        }

        return self::$session;
    }

    /**
     * Get or create a new session namespace
     *
     * @param   string      $identifier     The namespace's identifier
     *
     * @return  SessionNamespace
     * @throws  ProgrammingError
     */
    public static function getNamespace($identifier)
    {
        if (self::$session === null) {
            throw new ProgrammingError('No session created yet');
        }

        return self::$session->getNamespace($identifier);
    }
}