Http/UserAgent/Storage/Session.php

Show: PublicProtectedPrivateinherited
Table of Contents
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  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Package
Zend_Http  
Subpackage
UserAgent  

\Zend_Http_UserAgent_Storage_Session

Package: Zend\Http\UserAgent
Implements
\Zend_Http_UserAgent_Storage
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Constants

>VConstant  NAMESPACE_DEFAULT = 'Zend_Http_UserAgent'
Default session namespace
>VConstant  MEMBER_DEFAULT = 'storage'
Default session object member name

Properties

>VPropertyprotectedmixed $_member
Session object member
Details
Type
mixed
>VPropertyprotectedmixed $_namespace
Session namespace
Details
Type
mixed
>VPropertyprotected\Zend_Session_Namespace $_session
Object to proxy $_SESSION storage

Methods

methodpublic__construct(null | array | object $options = null) : void

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
NameTypeDescription
$optionsnull | array | object
Throws
ExceptionDescription
\Zend_Http_UserAgent_Storage_Exceptionon invalid $options argument
methodpublicclear() : void

Defined by Zend_Http_UserAgent_Storage

Throws
ExceptionDescription
\Zend_Http_UserAgent_Storage_ExceptionIf clearing contents from storage is impossible
methodpublicgetMember() : string

Returns the name of the session object member

Returns
TypeDescription
string
methodpublicgetNamespace() : string

Returns the session namespace name

Returns
TypeDescription
string
methodpublicisEmpty() : boolean

Defined by Zend_Http_UserAgent_Storage

Returns
TypeDescription
boolean
Throws
ExceptionDescription
\Zend_Http_UserAgent_Storage_ExceptionIf it is impossible to determine whether storage is empty
methodpublicread() : mixed

Defined by Zend_Http_UserAgent_Storage

Behavior is undefined when storage is empty.

Returns
TypeDescription
mixed
Throws
ExceptionDescription
\Zend_Http_UserAgent_Storage_ExceptionIf reading contents from storage is impossible
methodpublicwrite( $content) : void

Defined by Zend_Http_UserAgent_Storage

Parameters
NameTypeDescription
$content
Throws
ExceptionDescription
\Zend_Http_UserAgent_Storage_ExceptionIf writing $contents to storage is impossible
Documentation was generated by phpDocumentor 2.0.0a12.