PHP Класс Prado\Web\THttpSession

THttpSession provides session-level data management and the related configurations. To start the session, call {@link open}; to complete and send out session data, call {@link close}; to destroy the session, call {@link destroy}. If AutoStart is true, then the session will be started once the session module is loaded and initialized. To access data stored in session, use THttpSession like an associative array. For example,


  $session=new THttpSession;
  $session->open();
  $value1=$session['name1'];  // get session variable 'name1'
  $value2=$session['name2'];  // get session variable 'name2'
  foreach($session as $name=>$value) // traverse all session variables
  $session['name3']=$value3;  // set session variable 'name3'

The following configurations are available for session: {@link setAutoStart AutoStart}, {@link setCookieMode CookieMode}, {@link setSavePath SavePath}, {@link setUseCustomStorage UseCustomStorage}, {@link setGCProbability GCProbability}, {@link setTimeout Timeout}. See the corresponding setter and getter documentation for more information. Note, these properties must be set before the session is started. THttpSession can be inherited with customized session storage method. Override {@link _open}, {@link _close}, {@link _read}, {@link _write}, {@link _destroy} and {@link _gc} and set {@link setUseCustomStorage UseCustomStorage} to true. Then, the session data will be stored using the above methods. By default, THttpSession is registered with {@link TApplication} as the request module. It can be accessed via {@link TApplication::getSession()}. THttpSession may be configured in application configuration file as follows,

where {@link getSessionName SessionName}, {@link getSavePath SavePath}, {@link getCookieMode CookieMode}, {@link getUseCustomStorage UseCustomStorage}, {@link getAutoStart AutoStart}, {@link getGCProbability GCProbability}, {@link getUseTransparentSessionID UseTransparentSessionID} and {@link getTimeout TimeOut} are configurable properties of THttpSession. To avoid the possibility of identity theft through some variants of XSS attacks, THttpSessionshould always be configured to enforce HttpOnly setting on session cookie. The HttpOnly setting is disabled by default. To enable it, configure the THttpSession module as follows,

С версии: 3.0

Автор: Qiang Xue ([email protected])

Наследование: extends Prado\TApplicationComponent, implements IteratorAggregate, implements ArrayAccess, implements Countable, implements Prado\IModule

Показать файл Открыть проект Примеры использования класса

Открытые методы

Метод	Описание
_close ( ) : boolean	Session close handler.
_destroy ( $id ) : boolean	Session destroy handler.
_gc ( $maxLifetime ) : boolean	Session GC (garbage collection) handler.
_open ( $savePath, $sessionName ) : boolean	Session open handler.
_read ( $id ) : string	Session read handler.
_write ( $id, $data ) : boolean	Session write handler.
add ( $key, $value )	Adds a session variable.
clear ( )	Removes all session variables
close ( )	Ends the current session and store session data.
contains ( $key ) : boolean
count ( ) : integer	Returns the number of items in the session.
destroy ( )	Destroys all data registered to a session.
getAutoStart ( ) : boolean
getCookie ( ) : THttpCookie
getCookieMode ( ) : THttpSessionCookieMode
getCount ( ) : integer
getGCProbability ( ) : integer
getID ( ) : string
getIsStarted ( ) : boolean
getIterator ( ) : TSessionIterator	Returns an iterator for traversing the session variables.
getKeys ( ) : array
getSavePath ( ) : string
getSessionID ( ) : string
getSessionName ( ) : string
getTimeout ( ) : integer
getUseCustomStorage ( ) : boolean
getUseTransparentSessionID ( ) : boolean
init ( $config )	Initializes the module.
itemAt ( $key ) : mixed	Returns the session variable value with the session variable name.
offsetExists ( $offset ) : boolean	This method is required by the interface \ArrayAccess.
offsetGet ( $offset ) : mixed	This method is required by the interface \ArrayAccess.
offsetSet ( $offset, $item )	This method is required by the interface \ArrayAccess.
offsetUnset ( $offset )	This method is required by the interface \ArrayAccess.
open ( )	Starts the session if it has not started yet.
regenerate ( boolean $deleteOld = false ) : string	Update the current session id with a newly generated one
remove ( $key ) : mixed	Removes a session variable.
setAutoStart ( $value )
setCookieMode ( $value )
setGCProbability ( $value )
setID ( $value )
setSavePath ( $value )
setSessionID ( $value )
setSessionName ( $value )
setTimeout ( $value )
setUseCustomStorage ( $value )
setUseTransparentSessionID ( $value )
toArray ( ) : array

Описание методов

_close() публичный Метод

This method should be overridden if {@link setUseCustomStorage UseCustomStorage} is set true.

public _close ( ) : boolean
Результат	boolean	whether session is closed successfully

_destroy() публичный Метод

This method should be overridden if {@link setUseCustomStorage UseCustomStorage} is set true.

public _destroy ( $id ) : boolean
Результат	boolean	whether session is destroyed successfully

_gc() публичный Метод

This method should be overridden if {@link setUseCustomStorage UseCustomStorage} is set true.

public _gc ( $maxLifetime ) : boolean
Результат	boolean	whether session is GCed successfully

_open() публичный Метод

This method should be overridden if {@link setUseCustomStorage UseCustomStorage} is set true.

public _open ( $savePath, $sessionName ) : boolean
Результат	boolean	whether session is opened successfully

_read() публичный Метод

This method should be overridden if {@link setUseCustomStorage UseCustomStorage} is set true.

public _read ( $id ) : string
Результат	string	the session data

_write() публичный Метод

This method should be overridden if {@link setUseCustomStorage UseCustomStorage} is set true.

public _write ( $id, $data ) : boolean
Результат	boolean	whether session write is successful

add() публичный Метод

Note, if the specified name already exists, the old value will be removed first.

public add ( $key, $value )

clear() публичный Метод

Removes all session variables

public clear ( )

close() публичный Метод

Ends the current session and store session data.

public close ( )

contains() публичный Метод

public contains ( $key ) : boolean
Результат	boolean	whether there is the named session variable

count() публичный Метод

This method is required by \Countable interface.

public count ( ) : integer
Результат	integer	number of items in the session.

destroy() публичный Метод

Destroys all data registered to a session.

public destroy ( )

getAutoStart() публичный Метод

public getAutoStart ( ) : boolean
Результат	boolean	whether the session should be automatically started when the session module is initialized, defaults to false.

getCookie() публичный Метод

public getCookie ( ) : THttpCookie
Результат	THttpCookie	cookie that will be used to store session ID

getCookieMode() публичный Метод

public getCookieMode ( ) : THttpSessionCookieMode
Результат	THttpSessionCookieMode	how to use cookie to store session ID. Defaults to THttpSessionCookieMode::Allow.

getCount() публичный Метод

public getCount ( ) : integer
Результат	integer	the number of session variables

getGCProbability() публичный Метод

public getGCProbability ( ) : integer
Результат	integer	the probability (percentage) that the gc (garbage collection) process is started on every session initialization, defaults to 1 meaning 1% chance.

getID() публичный Метод

public getID ( ) : string
Результат	string	id of this module

getIsStarted() публичный Метод

public getIsStarted ( ) : boolean
Результат	boolean	whether the session has started

getIterator() публичный Метод

This method is required by the interface \IteratorAggregate.

public getIterator ( ) : TSessionIterator
Результат	TSessionIterator	an iterator for traversing the session variables.

getKeys() публичный Метод

public getKeys ( ) : array
Результат	array	the list of session variable names

getSavePath() публичный Метод

public getSavePath ( ) : string
Результат	string	the current session save path, defaults to '/tmp'.

getSessionID() публичный Метод

public getSessionID ( ) : string
Результат	string	the current session ID

getSessionName() публичный Метод

public getSessionName ( ) : string
Результат	string	the current session name

getTimeout() публичный Метод

public getTimeout ( ) : integer
Результат	integer	the number of seconds after which data will be seen as 'garbage' and cleaned up, defaults to 1440 seconds.

getUseCustomStorage() публичный Метод

public getUseCustomStorage ( ) : boolean
Результат	boolean	whether to use user-specified handlers to store session data. Defaults to false.

getUseTransparentSessionID() публичный Метод

public getUseTransparentSessionID ( ) : boolean
Результат	boolean	whether transparent sid support is enabled or not, defaults to false.

init() публичный Метод

This method is required by IModule. If AutoStart is true, the session will be started.

public init ( $config )

itemAt() публичный Метод

This method is exactly the same as {@link offsetGet}.

public itemAt ( $key ) : mixed
Результат	mixed	the session variable value, null if no such variable exists

offsetExists() публичный Метод

This method is required by the interface \ArrayAccess.

public offsetExists ( $offset ) : boolean
Результат	boolean

offsetGet() публичный Метод

This method is required by the interface \ArrayAccess.

public offsetGet ( $offset ) : mixed
Результат	mixed	the element at the offset, null if no element is found at the offset

offsetSet() публичный Метод

This method is required by the interface \ArrayAccess.

public offsetSet ( $offset, $item )

offsetUnset() публичный Метод

This method is required by the interface \ArrayAccess.

public offsetUnset ( $offset )

open() публичный Метод

Starts the session if it has not started yet.

public open ( )

regenerate() публичный Метод

Update the current session id with a newly generated one

См. ссылку: http://php.net/manual/en/function.session-regenerate-id.php

public regenerate ( boolean $deleteOld = false ) : string
$deleteOld	boolean	Whether to delete the old associated session or not.
Результат	string	old session id

remove() публичный Метод

Removes a session variable.

public remove ( $key ) : mixed
Результат	mixed	the removed value, null if no such session variable.

setAutoStart() публичный Метод

public setAutoStart ( $value )

setCookieMode() публичный Метод

public setCookieMode ( $value )

setGCProbability() публичный Метод

public setGCProbability ( $value )

setID() публичный Метод

public setID ( $value )

setSavePath() публичный Метод

public setSavePath ( $value )

setSessionID() публичный Метод

public setSessionID ( $value )

setSessionName() публичный Метод

public setSessionName ( $value )

setTimeout() публичный Метод

public setTimeout ( $value )

setUseCustomStorage() публичный Метод

public setUseCustomStorage ( $value )

setUseTransparentSessionID() публичный Метод

public setUseTransparentSessionID ( $value )

toArray() публичный Метод

public toArray ( ) : array
Результат	array	the list of all session variables in array