zSession Class Reference
[Session Management.]

Session Management Class. More...

Inheritance diagram for zSession:

[legend]

Collaboration diagram for zSession:

[legend]

Public Member Functions
	zSession ()
	__construct ()
	started ()
	Is session started.
	start ()
	Starts the Session.
	getEncrypted ($key=null)
	Get value of an encrypted session variable.
	setEncrypted ($key, $val)
	Set value of an session variable in encrypted format.
	getPlain ($key=null)
	get's value of a Plain(UnEncrypted) session data.
	setPlain ($key, $val)
	Set's Session data as Plain Text(Un Encrypted) Stiores Session Data in Unencrypted Format so you need to invoke zSession::getPlain() to retrive its value.
	remove ($key=null)
	Removes a Session Variable.
	keyExists ($key=null)
	Checks wheather a Key exists with the name provided or not.
	commit ()
	Stores the session Data Immedietly.
	regenerateId ($delOldFlag=true)
	Regenarates Session ID.
	cookieParams ($lifeTime=null, $path=null, $domain=null, $secure=null, $httpOnly=null)
	get/set the session cookie parameters.
	Id ($id=null)
	get/set the Current session's Id
	Name ($sessionName=null)
	get/set the name of the current session
	rollBack ($savePointName=null)
	Rolls back the session data to the previous stage or to a Specified save point.
	savePoint ($savePointName)
	sets a savepoint
Data Fields
	$bak = array()
	$savePoint = array()

---

Detailed Description

Session Management Class.

zSession Class can be used with its static methods e.g. zSession::methodName() like zSession::start() or zSession::started() etc.. zSession can also be used from its Instance in ROM. which can be found on $request->session through $request Global Variable. and as ROM engine is embeded into Controller you can also use $this->request->session to call a static/non-static method from the Instance. zSession Class holds several static and non-static methods static methods can be called without an instance where as you must use ROM engine to call a non-static method. You can also use PHP's $_SESSION with it however this is more structured way. setting and getting variables through $_SESSION ould work like zSession::setPlain() and zSession::getPlain(). It also Supports Magic Methods like getName(), setName('Foo') etc..

Definition at line 40 of file session_handler.php.

---

Constructor & Destructor Documentation

zSession::__construct( ) 

Reimplemented from zCore.

Definition at line 59 of file session_handler.php.

Referenced by zSession().

Show Source

                        {
    global $_SESSION;
    parent::__construct();
    if(!defined('DELETE_OLD_SESSION'))define('DELETE_OLD_SESSION', true);
    if(!defined('KEEP_OLD_SESSION'))define('KEEP_OLD_SESSION', false);
    $this->bak = $_SESSION;
  }

Top 

---

Member Function Documentation

zSession::zSession( ) 

Definition at line 56 of file session_handler.php.

References __construct().

Show Source

                     {
    $this->__construct();
  }

Here is the call graph for this function:

Top 

zSession::started( ) 

Is session started.

checks wheather the session has been started or not. Returns true if sesssion has been already started else returns false.

Returns:

bool

Definition at line 73 of file session_handler.php.

References zLogger::debug().

Referenced by commit(), cookieParams(), Id(), regenerateId(), and start().

Show Source

                    {
    if(isset($_SESSION)){
      zLogger::debug("zSession::start() returning true as session has been started", 'rom.session');
      return true;
    }else{
      zLogger::debug("zSession::start() returning false as session has not been started yet", 'rom.session');
      return false;
    }
  }

Here is the call graph for this function:

Top 

zSession::start( ) 

Starts the Session.

Starts the Session if already not started. It doesn't start the Session if it already has been started so that session is started only once. By default Zigmoyd starts Session automatically at the begening. Hoe you can change this behavior (But not recomended) by changing the value of Z_SESSION_AUTO_START in etc/zig.ini.php of your Project.

Warning:

Remember in PHP the Session variable Name is PHPSESSID By default however Zigmoyd Changes it and Uses ZSESSID Instead. However you can change it if you want by changing the value of Z_SESSION_NAME in the INI file etc/zig.ini.php of your Project.

Returns:

void

Definition at line 93 of file session_handler.php.

References zLogger::debug(), and started().

Referenced by zCaptcha::captcha(), commit(), cookieParams(), getEncrypted(), getPlain(), Id(), regenerateId(), setEncrypted(), and setPlain().

Show Source

                  {
    if(!session_id() && !headers_sent() && !zSession::started()){
      session_name(Z_SESSION_NAME);
      zLogger::debug("Starting session", 'rom.session');
      session_start();
    }else{
      zLogger::debug("session already started", 'rom.session');
    }
  }

Here is the call graph for this function:

Top 

zSession::getEncrypted( string $key = null ) 

Get value of an encrypted session variable.

Zigmoyd is able to set/get session data in encrypted format using your current Encryption settings. So If you set a session data in Encrypted format using zSession::setEncrypted() You need to call zSession::getEncrypted() to retrive its value.

Warning:

If Set Session in Unencrypted format by invoking zSession::setPlain() and try to retrive it by zSession::getEncrypted() it will not give you correct data cause you are decrypting an unencrypted data.

Parameters:

$key

Name of Session variable

Returns:

mixed

Definition at line 113 of file session_handler.php.

References zLogger::debug(), zCrypt::decrypt(), perror(), and start().

Show Source

                                  {
    zLogger::debug("Getting value of Encrypted Key $key", 'rom.session');
    zSession::start();
    if(is_array($key)){
      perror('zSession::get() doesn\'t accept array');
    }
    if($key != null){
      if(isset($_SESSION[$key])){
        return zCrypt::decrypt($_SESSION[$key], true);
      }else{
        perror('<code>zigmoyd.session.get</code><br />Trying to get non existing session Variable `'.$key.'`');
      }
    }else{
      return zCrypt::decrypt($_SESSION, true);
    }
    return false;
  }

Here is the call graph for this function:

Top 

zSession::setEncrypted( string $key, mixed $val )

Set value of an session variable in encrypted format.

Zigmoyd is able to set/get session data in encrypted format using your current Encryption settings. So you can set a session data in Encrypted format using zSession::setEncrypted() You need to call zSession::getEncrypted() to retrive its value.

Warning:

If Set Session in encrypted format by invoking zSession::setEncrypted() and try to retrive it by zSession::getPlain() it will not give you correct data cause you are not decrypting an encrypted data.

Parameters:

	$key	Name of Session variable
	$val	value of that Session variable

Returns:

bool

Definition at line 142 of file session_handler.php.

References $val, zLogger::debug(), zCrypt::encrypt(), and start().

Show Source

                                   {
    zLogger::debug("Setting Encrypted value $val of Key $key", 'rom.session');
    zSession::start();
    if($_SESSION[$key] = zCrypt::encrypt($val, true)){return true;}
    return false;
  }

Here is the call graph for this function:

Top 

zSession::getPlain( string $key = null ) 

get's value of a Plain(UnEncrypted) session data.

returns value of a Session data which is set using zSession::setPlain() method or set as unEncrypted text through some other way e.g. $_SESSION etc..

Parameters:

$key

session variable Name

Returns:

mixed

Definition at line 155 of file session_handler.php.

References zLogger::debug(), perror(), and start().

Show Source

                              {
    zLogger::debug("Getting value of Key $key", 'rom.session');
    zSession::start();
    if(is_array($key)){
      perror('zSession::getPlain() doesn\'t accept array');
    }
    if($key != null){
      if(isset($_SESSION[$key])){
        return $_SESSION[$key];
      }else{
        perror('<code>zigmoyd.session.get</code><br />Trying to get non existing session Variable `'.$key.'`');
      }
    }else{
      return $_SESSION;
    }
    return false;
  }

Here is the call graph for this function:

Top 

zSession::setPlain( string $key, mixed $val )

Set's Session data as Plain Text(Un Encrypted) Stiores Session Data in Unencrypted Format so you need to invoke zSession::getPlain() to retrive its value.

Parameters:

	$key	Session Variable Name
	$val	Session variable Value

Returns:

boolean

Definition at line 180 of file session_handler.php.

References $val, zLogger::debug(), and start().

Referenced by rollBack().

Show Source

                               {
    zLogger::debug("Setting value $val of Key $key", 'rom.session');
    zSession::start();
    if($_SESSION[$key] = $val){return true;}
    return false;
  }

Here is the call graph for this function:

Top 

zSession::remove( string $key = null ) 

Removes a Session Variable.

removes a session Variable doesn't matter if its encrypted or not.

Parameters:

$key

Session variable name

Returns:

boolean

Definition at line 193 of file session_handler.php.

References zLogger::debug(), keyExists(), and perror().

Show Source

                            {
    zLogger::debug("removing Key $key", 'rom.session');
    if($key == null || !is_string($key)){
      perror("<code>zSession::remove()</code><br />You must provide which key to delete and that argumnt must be a string to zSession::remove() e.g. it accepts 1 argumnt");return false;
      return false;
    }
    if(!zSession::keyExists($key)){
      perror("<code>zSession::remove()</code><br />zSession::remove() failed to remove key $key from session as it doesn't exist");return false;
      return false;
    }else{
      unset($_SESSION[$key]);
      return true;
    }
  }

Here is the call graph for this function:

Top 

zSession::keyExists( string $key = null ) 

Checks wheather a Key exists with the name provided or not.

Checks wheather or not a Session Variable exists with the provided key Name. Returns boolean value. e.g. true if it exists false otherwise

Parameters:

$key

Session Variable Name

Returns:

boolean

Definition at line 214 of file session_handler.php.

References perror().

Referenced by remove().

Show Source

                               {
    if($key == null || !is_string($key)){
      perror("<code>zSession::keyExists()</code><br />You must provide which key to Check and that argumnt must be a string to zSession::keyExists() e.g. it accepts 1 argumnt");
      return false;
    }
    return isset($_SESSION[$key]);
  }

Here is the call graph for this function:

Top 

zSession::commit( ) 

Stores the session Data Immedietly.

Session data is usually stored after your script terminated. However if you invoke zSession::commit() it will try to do that immedietly. e.g. same as session_write_close() standared PHP function

Definition at line 226 of file session_handler.php.

References zLogger::debug(), start(), and started().

Show Source

                   {
    zLogger::debug("Commiting session data to the server", 'rom.session');
    if(!zSession::started())zSession::start();
    session_write_close();
  }

Here is the call graph for this function:

Top 

zSession::regenerateId( string $delOldFlag = true ) 

Regenarates Session ID.

replace the current session id with a new one, and keep the current session information

Parameters:

$delOldSession

boolean Deleta Old session Data or not ? boolean value

Returns:

boolean

Definition at line 238 of file session_handler.php.

References zLogger::debug(), start(), and started().

Show Source

                                         {
    zLogger::debug("Regenarating session ID", 'rom.session');
    if(!zSession::started())zSession::start();
    return session_regenerate_id($delOldFlag);
  }

Here is the call graph for this function:

Top 

zSession::cookieParams( int $lifeTime = null, string $path = null, string $domain = null, boolean $secure = null, boolean $httpOnly = null )

get/set the session cookie parameters.

Works like session_set_cookie_params() standared PHP function.

Parameters:

	$lifeTime
	$path
	$domain
	$secure
	$httpOnly

Returns:

mixed

Definition at line 254 of file session_handler.php.

References start(), and started().

Show Source

                                                                                               {
    if(!zSession::started())zSession::start();
    if(is_null($lifeTime) && is_null($path) && is_null($domain) && is_null($secure) && is_null($httpOnly)){
      return session_get_cookie_params();
    }else{
      $currentParams = session_get_cookie_params();
      if(is_null($lifeTime))$lifeTime = $currentParams['lifetime'];
      if(is_null($path))$path = $currentParams['path'];
      if(is_null($domain))$domain = $currentParams['domain'];
      if(is_null($secure))$secure = $currentParams['secure'];
      if(is_null($httpOnly))$httpOnly = $currentParams['httponly'];
      session_set_cookie_params($lifeTime, $path, $domain, $secure, $httpOnly);
    }
  }

Here is the call graph for this function:

Top 

zSession::Id( string $id = null ) 

get/set the Current session's Id

Parameters:

$id

Returns:

mixed

Definition at line 274 of file session_handler.php.

References zLogger::debug(), start(), and started().

Show Source

                       {
    if(!zSession::started())zSession::start();
    if(is_null($id)){
      $sesId = session_id();
    }else{
      $sesId = (strlen(session_id($id)) >= 1);
    }
    zLogger::debug("Returning session Id $sesId", 'rom.session');
    return $sesId;
  }

Here is the call graph for this function:

Top 

zSession::Name( string $sessionName = null ) 

get/set the name of the current session

Parameters:

$sessionName

Returns:

mixed

Definition at line 290 of file session_handler.php.

References zLogger::debug().

Show Source

                                  {
    if(!is_null($sessionName)){
      $sesName = (strlen(session_name($sessionName)) >= 1);
    }else{
      $sesName = session_name();
    }
    zLogger::debug("Returning session Name $sesName", 'rom.session');
    return $sesName;
  }

Here is the call graph for this function:

Top 

zSession::rollBack( string $savePointName = null ) 

Rolls back the session data to the previous stage or to a Specified save point.

Warning:

non-static method. Must be called from an Instance.

Parameters:

$savePointName

SavePoint Name to which you want to restore

Returns:

void

Definition at line 306 of file session_handler.php.

References $val, savePoint(), and setPlain().

Show Source

                                        {
    if(is_null($savePointName)){
      foreach($this->bak as $key => $val){
        zSession::setPlain($key, $val);
      }
    }else{
      foreach($this->savePoint[$savePointName] as $key => $val){
        zSession::setPlain($key, $val);
      }
    }
  }

Here is the call graph for this function:

Top 

zSession::savePoint( string $savePointName ) 

sets a savepoint

Warning:

non-static method. Must be called from an Instance.

Parameters:

$savePointName

Savepoint Name where to backup the Current Session Data

Definition at line 323 of file session_handler.php.

Referenced by rollBack().

Show Source

                                    {
    $this->savePoint[$savePointName] = $_SESSION;
  }

Top 

---

Field Documentation

zSession::$bak = array()

Definition at line 47 of file session_handler.php.

Top 

zSession::$savePoint = array()

Definition at line 54 of file session_handler.php.

Top 

---

The documentation for this class was generated from the following file:

• session_handler.php