<?php

/**

 * Zend Framework

 *

 * LICENSE

 *

 * This source file is subject to the new BSD license that is bundled

 * with this package in the file LICENSE.txt.

 * It is also available through the world-wide-web at this URL:

 * http://framework.zend.com/license/new-bsd

 * If you did not receive a copy of the license and are unable to

 * obtain it through the world-wide-web, please send an email

 * to license@zend.com so we can send you a copy immediately.

 *

 * @category   Zend

 * @package    Zend_Auth

 * @subpackage Storage

 * @copyright  Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)

 * @license    http://framework.zend.com/license/new-bsd     New BSD License

 * @version    $Id: Session.php 20096 2010-01-06 02:05:09Z bkarwin $

 */

/**

 * @see Zend_Auth_Storage_Interface

 */

require_once 'Zend/Auth/Storage/Interface.php';

/**

 * @see Zend_Session

 */

require_once 'Zend/Session.php';

/**

 * @category   Zend

 * @package    Zend_Auth

 * @subpackage Storage

 * @copyright  Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)

 * @license    http://framework.zend.com/license/new-bsd     New BSD License

 */

class Zend_Auth_Storage_Session implements Zend_Auth_Storage_Interface

{

    /**

     * Default session namespace

     */

    const NAMESPACE_DEFAULT = 'Zend_Auth';

    /**

     * Default session object member name

     */

    const MEMBER_DEFAULT = 'storage';

    /**

     * Object to proxy $_SESSION storage

     *

     * @var Zend_Session_Namespace

     */

    protected $_session;

    /**

     * Session namespace

     *

     * @var mixed

     */

    protected $_namespace;

    /**

     * Session object member

     *

     * @var mixed

     */

    protected $_member;

    /**

     * Sets session storage options and initializes session namespace object

     *

     * @param  mixed $namespace

     * @param  mixed $member

     * @return void

     */

    public function __construct($namespace = self::NAMESPACE_DEFAULT, $member = self::MEMBER_DEFAULT)

    {

        $this->_namespace = $namespace;

        $this->_member    = $member;

        $this->_session   = new Zend_Session_Namespace($this->_namespace);

    }

    /**

     * Returns the session namespace

     *

     * @return string

     */

    public function getNamespace()

    {

        return $this->_namespace;

    }

    /**

     * Returns the name of the session object member

     *

     * @return string

     */

    public function getMember()

    {

        return $this->_member;

    }

    /**

     * Defined by Zend_Auth_Storage_Interface

     *

     * @return boolean

     */

    public function isEmpty()

    {

        return !isset($this->_session->{$this->_member});

    }

    /**

     * Defined by Zend_Auth_Storage_Interface

     *

     * @return mixed

     */

    public function read()

    {

        return $this->_session->{$this->_member};

    }

    /**

     * Defined by Zend_Auth_Storage_Interface

     *

     * @param  mixed $contents

     * @return void

     */

    public function write($contents)

    {

        $this->_session->{$this->_member} = $contents;

    }

    /**

     * Defined by Zend_Auth_Storage_Interface

     *

     * @return void

     */

    public function clear()

    {

        unset($this->_session->{$this->_member});

    }

}