CHttpSession

所有包 | 属性 | 方法

包	system.web
继承	class CHttpSession » CApplicationComponent » CComponent
实现	IApplicationComponent, IteratorAggregate, Traversable, ArrayAccess, Countable
子类	CCacheHttpSession, CDbHttpSession
可用自	1.0
版本	$Id$

CHttpSession provides session-level data management and the related configurations.

To start the session, call open(); To complete and send out session data, call close(); To destroy the session, call destroy().

If autoStart is set true, the session will be started automatically when the application component is initialized by the application.

CHttpSession can be used like an array to set and get session data. For example,

  $session=new CHttpSession;
  $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:

See the corresponding setter and getter documentation for more information. Note, these properties must be set before the session is started.

CHttpSession can be extended to support customized session storage. Override openSession, closeSession, readSession, writeSession, destroySession and gcSession and set useCustomStorage to true. Then, the session data will be stored and retrieved using the above methods.

CHttpSession is a Web application component that can be accessed via CWebApplication::getSession().

公共属性

隐藏继承的属性

属性	类型	描述	被定义在
autoStart	boolean	whether the session should be automatically started when the session application component is initialized, defaults to true.	CHttpSession
behaviors	array	the behaviors that should be attached to this component.	CApplicationComponent
cookieMode	string	how to use cookie to store session ID.	CHttpSession
cookieParams	array	the session cookie parameters.	CHttpSession
count	integer	the number of session variables	CHttpSession
gCProbability	integer	the probability (percentage) that the gc (garbage collection) process is started on every session initialization, defaults to 1 meaning 1% chance.	CHttpSession
isInitialized	boolean	whether this application component has been initialized (i.	CApplicationComponent
isStarted	boolean	whether the session has started	CHttpSession
iterator	CHttpSessionIterator	Returns an iterator for traversing the session variables.	CHttpSession
keys	array	the list of session variable names	CHttpSession
savePath	string	the current session save path, defaults to '/tmp'.	CHttpSession
sessionID	string	the current session ID	CHttpSession
sessionName	string	the current session name	CHttpSession
timeout	integer	the number of seconds after which data will be seen as 'garbage' and cleaned up, defaults to 1440 seconds.	CHttpSession
useCustomStorage	boolean	Returns a value indicating whether to use custom session storage.	CHttpSession
useTransparentSessionID	boolean	whether transparent sid support is enabled or not, defaults to false.	CHttpSession

公共方法

隐藏继承的方法

方法	描述	被定义在
__call()	Calls the named method which is not a class method.	CComponent
__get()	Returns a property value, an event handler list or a behavior based on its name.	CComponent
__isset()	Checks if a property value is null.	CComponent
__set()	Sets value of a component property.	CComponent
__unset()	Sets a component property to be null.	CComponent
add()	Adds a session variable.	CHttpSession
asa()	Returns the named behavior object.	CComponent
attachBehavior()	Attaches a behavior to this component.	CComponent
attachBehaviors()	Attaches a list of behaviors to the component.	CComponent
attachEventHandler()	Attaches an event handler to an event.	CComponent
canGetProperty()	Determines whether a property can be read.	CComponent
canSetProperty()	Determines whether a property can be set.	CComponent
clear()	Removes all session variables	CHttpSession
close()	Ends the current session and store session data.	CHttpSession
closeSession()	Session close handler.	CHttpSession
contains()		CHttpSession
count()	Returns the number of items in the session.	CHttpSession
destroy()	Frees all session variables and destroys all data registered to a session.	CHttpSession
destroySession()	Session destroy handler.	CHttpSession
detachBehavior()	Detaches a behavior from the component.	CComponent
detachBehaviors()	Detaches all behaviors from the component.	CComponent
detachEventHandler()	Detaches an existing event handler.	CComponent
disableBehavior()	Disables an attached behavior.	CComponent
disableBehaviors()	Disables all behaviors attached to this component.	CComponent
enableBehavior()	Enables an attached behavior.	CComponent
enableBehaviors()	Enables all behaviors attached to this component.	CComponent
gcSession()	Session GC (garbage collection) handler.	CHttpSession
getCookieMode()		CHttpSession
getCookieParams()		CHttpSession
getCount()		CHttpSession
getEventHandlers()	Returns the list of attached event handlers for an event.	CComponent
getGCProbability()		CHttpSession
getIsInitialized()		CApplicationComponent
getIsStarted()		CHttpSession
getIterator()	Returns an iterator for traversing the session variables.	CHttpSession
getKeys()		CHttpSession
getSavePath()		CHttpSession
getSessionID()		CHttpSession
getSessionName()		CHttpSession
getTimeout()		CHttpSession
getUseCustomStorage()	Returns a value indicating whether to use custom session storage.	CHttpSession
getUseTransparentSessionID()		CHttpSession
hasEvent()	Determines whether an event is defined.	CComponent
hasEventHandler()	Checks whether the named event has attached handlers.	CComponent
hasProperty()	Determines whether a property is defined.	CComponent
init()	Initializes the application component.	CHttpSession
itemAt()	Returns the session variable value with the session variable name.	CHttpSession
offsetExists()	This method is required by the interface ArrayAccess.	CHttpSession
offsetGet()	This method is required by the interface ArrayAccess.	CHttpSession
offsetSet()	This method is required by the interface ArrayAccess.	CHttpSession
offsetUnset()	This method is required by the interface ArrayAccess.	CHttpSession
open()	Starts the session if it has not started yet.	CHttpSession
openSession()	Session open handler.	CHttpSession
raiseEvent()	Raises an event.	CComponent
readSession()	Session read handler.	CHttpSession
remove()	Removes a session variable.	CHttpSession
setCookieMode()		CHttpSession
setCookieParams()	Sets the session cookie parameters.	CHttpSession
setGCProbability()		CHttpSession
setSavePath()		CHttpSession
setSessionID()		CHttpSession
setSessionName()		CHttpSession
setTimeout()		CHttpSession
setUseTransparentSessionID()		CHttpSession
toArray()		CHttpSession
writeSession()	Session write handler.	CHttpSession

属性详情

autoStart 属性

public boolean $autoStart;

whether the session should be automatically started when the session application component is initialized, defaults to true.

cookieMode 属性

public string getCookieMode()
public void setCookieMode(string $value)

how to use cookie to store session ID. Defaults to 'Allow'.

cookieParams 属性

public array getCookieParams()
public void setCookieParams(array $value)

the session cookie parameters.

参见

http://us2.php.net/manual/en/function.session-get-cookie-params.php

count 属性只读

public integer getCount()

the number of session variables

gCProbability 属性

public integer getGCProbability()
public void setGCProbability(integer $value)

the probability (percentage) that the gc (garbage collection) process is started on every session initialization, defaults to 1 meaning 1% chance.

isStarted 属性只读

public boolean getIsStarted()

whether the session has started

iterator 属性只读

public CHttpSessionIterator getIterator()

Returns an iterator for traversing the session variables. This method is required by the interface IteratorAggregate.

keys 属性只读

public array getKeys()

the list of session variable names

savePath 属性

public string getSavePath()
public void setSavePath(string $value)

the current session save path, defaults to '/tmp'.

sessionID 属性

public string getSessionID()
public void setSessionID(string $value)

the current session ID

sessionName 属性

public string getSessionName()
public void setSessionName(string $value)

the current session name

timeout 属性

public integer getTimeout()
public void setTimeout(integer $value)

the number of seconds after which data will be seen as 'garbage' and cleaned up, defaults to 1440 seconds.

useCustomStorage 属性只读

public boolean getUseCustomStorage()

Returns a value indicating whether to use custom session storage. This method should be overriden to return true if custom session storage handler should be used. If returning true, make sure the methods openSession, closeSession, readSession, writeSession, destroySession, and gcSession are overridden in child class, because they will be used as the callback handlers. The default implementation always return false.

useTransparentSessionID 属性

public boolean getUseTransparentSessionID()
public void setUseTransparentSessionID(boolean $value)

whether transparent sid support is enabled or not, defaults to false.

方法详情

add() 方法

public void add(mixed $key, mixed $value)
$key	mixed	session variable name
$value	mixed	session variable value

Adds a session variable. Note, if the specified name already exists, the old value will be removed first.

clear() 方法

public void clear()

Removes all session variables

close() 方法

public void close()

Ends the current session and store session data.

closeSession() 方法

public boolean closeSession()
{return}	boolean	whether session is closed successfully

Session close handler. This method should be overridden if useCustomStorage is set true. Do not call this method directly.

contains() 方法

public boolean contains(mixed $key)
$key	mixed	session variable name
{return}	boolean	whether there is the named session variable

count() 方法

public integer count()
{return}	integer	number of items in the session.

Returns the number of items in the session. This method is required by Countable interface.

destroy() 方法

public void destroy()

Frees all session variables and destroys all data registered to a session.

destroySession() 方法

public boolean destroySession(string $id)
$id	string	session ID
{return}	boolean	whether session is destroyed successfully

Session destroy handler. This method should be overridden if useCustomStorage is set true. Do not call this method directly.

gcSession() 方法

public boolean gcSession(integer $maxLifetime)
$maxLifetime	integer	the number of seconds after which data will be seen as 'garbage' and cleaned up.
{return}	boolean	whether session is GCed successfully

Session GC (garbage collection) handler. This method should be overridden if useCustomStorage is set true. Do not call this method directly.

getCookieMode() 方法

public string getCookieMode()
{return}	string	how to use cookie to store session ID. Defaults to 'Allow'.

getCookieParams() 方法

public array getCookieParams()
{return}	array	the session cookie parameters.

参见

http://us2.php.net/manual/en/function.session-get-cookie-params.php

getCount() 方法

public integer getCount()
{return}	integer	the number of session variables

getGCProbability() 方法

public integer getGCProbability()
{return}	integer	the probability (percentage) that the gc (garbage collection) process is started on every session initialization, defaults to 1 meaning 1% chance.

getIsStarted() 方法

public boolean getIsStarted()
{return}	boolean	whether the session has started

getIterator() 方法

public CHttpSessionIterator getIterator()
{return}	CHttpSessionIterator	an iterator for traversing the session variables.

Returns an iterator for traversing the session variables. This method is required by the interface IteratorAggregate.

getKeys() 方法

public array getKeys()
{return}	array	the list of session variable names

getSavePath() 方法

public string getSavePath()
{return}	string	the current session save path, defaults to '/tmp'.

getSessionID() 方法

public string getSessionID()
{return}	string	the current session ID

getSessionName() 方法

public string getSessionName()
{return}	string	the current session name

getTimeout() 方法

public integer getTimeout()
{return}	integer	the number of seconds after which data will be seen as 'garbage' and cleaned up, defaults to 1440 seconds.

getUseCustomStorage() 方法

public boolean getUseCustomStorage()
{return}	boolean	whether to use custom storage.

getUseTransparentSessionID() 方法

public boolean getUseTransparentSessionID()
{return}	boolean	whether transparent sid support is enabled or not, defaults to false.

init() 方法

public void init()

Initializes the application component. This method is required by IApplicationComponent and is invoked by application.

itemAt() 方法

public mixed itemAt(mixed $key)
$key	mixed	the session variable name
{return}	mixed	the session variable value, null if no such variable exists

Returns the session variable value with the session variable name. This method is exactly the same as offsetGet.

offsetExists() 方法

public boolean offsetExists(mixed $offset)
$offset	mixed	the offset to check on
{return}	boolean

This method is required by the interface ArrayAccess.

offsetGet() 方法

public mixed offsetGet(integer $offset)
$offset	integer	the offset to retrieve element.
{return}	mixed	the element at the offset, null if no element is found at the offset

This method is required by the interface ArrayAccess.

offsetSet() 方法

public void offsetSet(integer $offset, mixed $item)
$offset	integer	the offset to set element
$item	mixed	the element value

This method is required by the interface ArrayAccess.

offsetUnset() 方法

public void offsetUnset(mixed $offset)
$offset	mixed	the offset to unset element

This method is required by the interface ArrayAccess.

open() 方法

public void open()

Starts the session if it has not started yet.

openSession() 方法

public boolean openSession(string $savePath, string $sessionName)
$savePath	string	session save path
$sessionName	string	session name
{return}	boolean	whether session is opened successfully

Session open handler. This method should be overridden if useCustomStorage is set true. Do not call this method directly.

readSession() 方法

public string readSession(string $id)
$id	string	session ID
{return}	string	the session data

Session read handler. This method should be overridden if useCustomStorage is set true. Do not call this method directly.

remove() 方法

public mixed remove(mixed $key)
$key	mixed	the name of the session variable to be removed
{return}	mixed	the removed value, null if no such session variable.

Removes a session variable.

setCookieMode() 方法

public void setCookieMode(string $value)
$value	string	how to use cookie to store session ID. Valid values include 'none', 'allow' and 'only'.

setCookieParams() 方法

public void setCookieParams(array $value)
$value	array	cookie parameters, valid keys include: lifetime, path, domain, secure.

Sets the session cookie parameters. The effect of this method only lasts for the duration of the script. Call this method before the session starts.

参见

http://us2.php.net/manual/en/function.session-set-cookie-params.php

setGCProbability() 方法

public void setGCProbability(integer $value)
$value	integer	the probability (percentage) that the gc (garbage collection) process is started on every session initialization.

setSavePath() 方法

public void setSavePath(string $value)
$value	string	the current session save path

setSessionID() 方法

public void setSessionID(string $value)
$value	string	the session ID for the current session

setSessionName() 方法

public void setSessionName(string $value)
$value	string	the session name for the current session, must be an alphanumeric string, defaults to PHPSESSID

setTimeout() 方法

public void setTimeout(integer $value)
$value	integer	the number of seconds after which data will be seen as 'garbage' and cleaned up

setUseTransparentSessionID() 方法

public void setUseTransparentSessionID(boolean $value)
$value	boolean	whether transparent sid support is enabled or not.

toArray() 方法

public array toArray()
{return}	array	the list of all session variables in array

writeSession() 方法

public boolean writeSession(string $id, string $data)
$id	string	session ID
$data	string	session data
{return}	boolean	whether session write is successful

Session write handler. This method should be overridden if useCustomStorage is set true. Do not call this method directly.