Service/WindowsAzure/SessionHandler.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 [email protected] so we can send you a copy immediately.
Category
Zend  
Copyright
Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Package
Zend_Service_WindowsAzure  
Subpackage
Session  
Version
$Id$  

\Zend_Service_WindowsAzure_SessionHandler

Package: Zend_Service_WindowsAzure\Session
Category
Zend  
Copyright
Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Constants

>VConstantint  MAX_TS_PROPERTY_SIZE = 65536
Maximal property size in table storage.
See
 
MAX_TS_PROPERTY_SIZE
int

>VConstant  STORAGE_TYPE_TABLE = 'table'
Storage backend type
>VConstant  STORAGE_TYPE_BLOB = 'blob'

Properties

>VPropertyprotectedstring $_sessionContainer
Session container name
Details
Type
string
>VPropertyprotectedstring $_sessionContainerPartition
Session container partition
Details
Type
string
>VPropertyprotected\Zend_Service_WindowsAzure_Storage_Table|\Zend_Service_WindowsAzure_Storage_Blob $_storage
Storage back-end
>VPropertyprotectedstring $_storageType
Storage backend type
Details
Type
string

Methods

methodpublic__construct(\Zend_Service_WindowsAzure_Storage_Table | \Zend_Service_WindowsAzure_Storage_Blob $storage, string $sessionContainer = 'phpsessions', string $sessionContainerPartition = 'sessions') : void

Creates a new Zend_Service_WindowsAzure_SessionHandler instance

Parameters
NameTypeDescription
$storage\Zend_Service_WindowsAzure_Storage_Table | \Zend_Service_WindowsAzure_Storage_Blob

Storage back-end, can be table storage and blob storage

$sessionContainerstring

Session container name

$sessionContainerPartitionstring

Session container partition

methodpublicclose() : bool

Close the session store

Returns
TypeDescription
bool
methodpublicdestroy(int $id) : boolean

Destroy a specific session

Parameters
NameTypeDescription
$idint

Session Id

Returns
TypeDescription
boolean
methodpublicgc(int $lifeTime) : boolean

Garbage collector

Parameters
NameTypeDescription
$lifeTimeint

Session maximal lifetime

Returns
TypeDescription
boolean
Details
See
100  
See
1440  
See
1  
Usage
Execution rate 1/100 (session.gc_probability/session.gc_divisor)  
methodpublicopen() : bool

Open the session store

Returns
TypeDescription
bool
methodpublicread(int $id) : string

Read a specific session

Parameters
NameTypeDescription
$idint

Session Id

Returns
TypeDescription
string
methodpublicregister() : boolean

Registers the current session handler as PHP's session handler

Returns
TypeDescription
boolean
methodpublicwrite(int $id, string $serializedData) : void

Write a specific session

Parameters
NameTypeDescription
$idint

Session Id

$serializedDatastring

Serialized PHP object

Throws
ExceptionDescription
\Exception
Documentation was generated by phpDocumentor 2.2.0 .