CHttpSession

CHttpSession 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 {@link 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:

• {@link setSessionID sessionID};
• {@link setSessionName sessionName};
• {@link autoStart};
• {@link setSavePath savePath};
• {@link setCookieParams cookieParams};
• {@link setGCProbability gcProbability};
• {@link setCookieMode cookieMode};
• {@link setUseTransparentSessionID useTransparentSessionID};
• {@link setTimeout timeout}.

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 {@link openSession}, {@link closeSession}, {@link readSession}, {@link writeSession}, {@link destroySession} and {@link gcSession} and set {@link 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 {@link CWebApplication::getSession()}.