Loading Please wait...

session_handler.php

Go to the documentation of this file.

<?php
class zSession extends zCore{
  var $bak = array();
  var $savePoint = array();

  function zSession(){
    $this->__construct();
  }
  function __construct(){
    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;
  }
  function started(){
    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;
    }
  }
  function start(){
    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');
    }
  }
  function getEncrypted($key=null){
    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;
  }
  function setEncrypted($key, $val){
    zLogger::debug("Setting Encrypted value $val of Key $key", 'rom.session');
    zSession::start();
    if($_SESSION[$key] = zCrypt::encrypt($val, true)){return true;}
    return false;
  }
  function getPlain($key=null){
    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;
  }
  function setPlain($key, $val){
    zLogger::debug("Setting value $val of Key $key", 'rom.session');
    zSession::start();
    if($_SESSION[$key] = $val){return true;}
    return false;
  }
  function remove($key=null){
    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;
    }
  }
  function keyExists($key=null){
    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]);
  }
  function commit(){
    zLogger::debug("Commiting session data to the server", 'rom.session');
    if(!zSession::started())zSession::start();
    session_write_close();
  }
  function regenerateId($delOldFlag=true){
    zLogger::debug("Regenarating session ID", 'rom.session');
    if(!zSession::started())zSession::start();
    return session_regenerate_id($delOldFlag);
  }
  function cookieParams($lifeTime=null, $path=null, $domain=null, $secure=null, $httpOnly=null){
    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);
    }
  }
  function Id($id=null){
    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;
  }
  function Name($sessionName=null){
    if(!is_null($sessionName)){
      $sesName = (strlen(session_name($sessionName)) >= 1);
    }else{
      $sesName = session_name();
    }
    zLogger::debug("Returning session Name $sesName", 'rom.session');
    return $sesName;
  }
  function rollBack($savePointName=null){
    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);
      }
    }
  }
  function savePoint($savePointName){
    $this->savePoint[$savePointName] = $_SESSION;
  }
  function __call($methodName, $args, &$return){
    switch(true){
      case (preg_match('~setEncrypted(\w+)~i', $methodName, $m) >= 1):
          $return = zSession::setEncrypted(strtolower($m[1]), $args[0]);
        break;
      case (preg_match('~getEncrypted(\w+)~i', $methodName, $m) >= 1):
          $return = zSession::getEncrypted(strtolower($m[1]), $args[0]);
        break;
      case (preg_match('~set(\w+)~i', $methodName, $m) >= 1):
          $return = zSession::setPlain(strtolower($m[1]), $args[0]);
        break;
      case (preg_match('~get(\w+)~i', $methodName, $m) >= 1):
          $return = zSession::getPlain(strtolower($m[1]));
        break;
      default:
        perror("<code>zigtmoyd.session.$methodName()</code><br />no Such method in zSession Class");
    }
    return true;
  }
}
if(function_exists('overload'))overload('zSession');
if(Z_SESSION_AUTO_START)zSession::start();//Start the Session automatically if
?>

---