Zend_Http_UserAgent_Storage_Session Class Reference

Inheritance diagram for Zend_Http_UserAgent_Storage_Session:

Public Member Functions
	__construct ($options=null)
	getNamespace ()
	getMember ()
	isEmpty ()
	read ()
	write ($content)
	clear ()

Data Fields
const	NAMESPACE_DEFAULT = 'Zend_Http_UserAgent'
const	MEMBER_DEFAULT = 'storage'

Protected Attributes
	$_session
	$_namespace
	$_member

Detailed Description

Definition at line 38 of file Session.php.

Constructor & Destructor Documentation

__construct()

__construct

(

$options = null

)

Sets session storage options and initializes session namespace object

Expects options to contain 0 or more of the following keys:

• browser_type – maps to "namespace" internally
• member

Parameters

null | array | object

$options

Returns

void

Exceptions

Zend_Http_UserAgent_Storage_Exception

on invalid $options argument

Definition at line 82 of file Session.php.

    {
        if (is_object($options) && method_exists($options, 'toArray')) {
            $options = $options->toArray();
        } elseif (is_object($options)) {
            $options = (array) $options;
        }
        if (null !== $options && !is_array($options)) {
            #require_once 'Zend/Http/UserAgent/Storage/Exception.php';
            throw new Zend_Http_UserAgent_Storage_Exception(sprintf(
                'Expected array or object options; "%s" provided',
                gettype($options)
            ));
        }

        // add '.' to prevent the message ''Session namespace must not start with a number'
        $this->_namespace = '.'
                          . (isset($options['browser_type'])
                             ? $options['browser_type']
                             : self::NAMESPACE_DEFAULT);
        $this->_member    = isset($options['member']) ? $options['member'] : self::MEMBER_DEFAULT;
        $this->_session   = new Zend_Session_Namespace($this->_namespace);
    }

Member Function Documentation

clear()

clear

(

)

Defined by Zend_Http_UserAgent_Storage

Returns

void

Implements Zend_Http_UserAgent_Storage.

Definition at line 162 of file Session.php.

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

getMember()

getMember

(

)

Returns the name of the session object member

Returns

string

Definition at line 121 of file Session.php.

    {
        return $this->_member;
    }

getNamespace()

getNamespace

(

)

Returns the session namespace name

Returns

string

Definition at line 111 of file Session.php.

    {
        return $this->_namespace;
    }

isEmpty()

isEmpty

(

)

Defined by Zend_Http_UserAgent_Storage

Returns

boolean

Implements Zend_Http_UserAgent_Storage.

Definition at line 131 of file Session.php.

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

read()

read

(

)

Defined by Zend_Http_UserAgent_Storage

Returns

mixed

Implements Zend_Http_UserAgent_Storage.

Definition at line 141 of file Session.php.

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

write()

write

(

$content

)

Defined by Zend_Http_UserAgent_Storage

Parameters

mixed

$contents

Returns

void

Implements Zend_Http_UserAgent_Storage.

Definition at line 152 of file Session.php.

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

Field Documentation

$_member

$_member

protected

Definition at line 69 of file Session.php.

$_namespace

$_namespace

protected

Definition at line 62 of file Session.php.

$_session

$_session

protected

Definition at line 55 of file Session.php.

MEMBER_DEFAULT

const MEMBER_DEFAULT = 'storage'

Default session object member name

Definition at line 48 of file Session.php.

NAMESPACE_DEFAULT

const NAMESPACE_DEFAULT = 'Zend_Http_UserAgent'

Default session namespace

Definition at line 43 of file Session.php.

---

The documentation for this class was generated from the following file:

• vendor/magento/zendframework1/library/Zend/Http/UserAgent/Storage/Session.php