Service/WindowsAzure/SessionHandler.php

Show: inherited
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-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Package
Zend_Service_WindowsAzure  
Subpackage
Session  
Version
$Id: SessionHandler.php 24593 2012-01-05 20:35:02Z matthew $  

\Zend_Service_WindowsAzure_SessionHandler

Package: Zend\Service\WindowsAzure\Session

Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Constants

Constantint  MAX_TS_PROPERTY_SIZE = 65536

Maximal property size in table storage.

See
\global\http://msdn.microsoft.com/en-us/library/dd179338.aspx  
int
Constant  STORAGE_TYPE_TABLE = 'table'

Storage backend type

Constant  STORAGE_TYPE_BLOB = 'blob'

Properties

Propertyprotectedstring $_sessionContainer =

Session container name

Details
Type
string
Propertyprotectedstring $_sessionContainerPartition =

Session container partition

Details
Type
string
Propertyprotected\Zend_Service_WindowsAzure_Storage_Table|\Zend_Service_WindowsAzure_Storage_Blob $_storage =

Storage back-end

Propertyprotectedstring $_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
Name Type Description
$storage \Zend_Service_WindowsAzure_Storage_Table | \Zend_Service_WindowsAzure_Storage_Blob

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

$sessionContainer string

Session container name

$sessionContainerPartition string

Session container partition

methodpublicclose() : bool

Close the session store

Returns
Type Description
bool
methodpublicdestroy(int $id) : boolean

Destroy a specific session

Parameters
Name Type Description
$id int

Session Id

Returns
Type Description
boolean
methodpublicgc(int $lifeTime) : boolean

Garbage collector

Parameters
Name Type Description
$lifeTime int

Session maximal lifetime

Returns
Type Description
boolean
Details
See
\global\session.gc_divisor  
See
\global\session.gc_maxlifetime  
See
\global\session.gc_probability  
Usage
Execution rate 1/100 (session.gc_probability/session.gc_divisor)  
methodpublicopen() : bool

Open the session store

Returns
Type Description
bool
methodpublicread(int $id) : string

Read a specific session

Parameters
Name Type Description
$id int

Session Id

Returns
Type Description
string
methodpublicregister() : boolean

Registers the current session handler as PHP's session handler

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

Write a specific session

Parameters
Name Type Description
$id int

Session Id

$serializedData string

Serialized PHP object

Throws
Exception Description
\Exception
Documentation was generated by phpDocumentor 2.0.0a8.