zCookie Class Reference
[Cookie Management.]

Cookie Management Class. More...

Inheritance diagram for zCookie:

[legend]

Collaboration diagram for zCookie:

[legend]

Public Member Functions
	zCookie ()
	__construct ()
	getEncrypted ($key=null)
	Get value of an encrypted cookie variable.
	setEncrypted ($key, $val, $expire=null, $path='', $domain=null, $secure=null, $httpOnly=null)
	Set value of a cookie variable in encrypted format.
	getPlain ($key=null)
	get's value of a Plain(UnEncrypted) cookie data.
	setPlain ($key, $val, $expire=0, $path='', $domain=null, $secure=null, $httpOnly=null)
	Puts Cookie data in Plain text format(e.g.
	setRaw ($key, $val, $expire=0, $path=null, $domain=null, $secure=null, $httpOnly=null)
	Send a Raw Cookie.
	remove ($key=null)
	Removes a Key from Cookie.
	keyExists ($key=null)
	Checks wheather a Key exists with the name provided or not.

---

Detailed Description

Cookie Management Class.

zCookie Class can be used with its static methods e.g. zCookie::methodName() like zCookie::getPlain() or zCookie::setPlain() etc.. zCookie can also be used from its Instance in ROM. which can be found on $request->cookie through $request Global Variable. and as ROM engine is embeded into Controller you can also use $this->request->cookie to call a static/non-static method from the Instance. zCookie 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 $_COOKIE with it however this is more structured way. setting and getting variables through $_COOKIE would work like zCookie::setPlain() and zCookie::getPlain(). It also Supports Magic Methods like getName(), setName('Foo') etc..

Definition at line 40 of file cookie_handler.php.

---

Constructor & Destructor Documentation

zCookie::__construct( ) 

Reimplemented from zCore.

Definition at line 44 of file cookie_handler.php.

References zDef::set().

Referenced by zCookie().

Show Source

                        {
    zDef::set('Z_COOKIE_EXPIRE', Z_COOKIE_EXPIRE);
    zDef::set('Z_COOKIE_SECURE', Z_COOKIE_SECURE);
    zDef::set('Z_COOKIE_HTTPONLY', Z_COOKIE_HTTPONLY);
  }

Here is the call graph for this function:

Top 

---

Member Function Documentation

zCookie::zCookie( ) 

Definition at line 41 of file cookie_handler.php.

References __construct().

Show Source

                    {
    $this->__construct();
  }

Here is the call graph for this function:

Top 

zCookie::getEncrypted( string $key = null ) 

Get value of an encrypted cookie variable.

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

Warning:

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

Parameters:

$key

Name of Cookie variable

Returns:

mixed

Definition at line 60 of file cookie_handler.php.

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

Show Source

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

Here is the call graph for this function:

Top 

zCookie::setEncrypted( string $key, mixed $val, int $expire = null, string $path = '', string $domain = null, boolen $secure = null, boolean $httpOnly = null )

Set value of a cookie variable in encrypted format.

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

Warning:

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

Parameters:

	$key
	$val
	$expire
	$path
	$domain
	$secure
	$httpOnly

Returns:

boolean

Definition at line 94 of file cookie_handler.php.

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

Show Source

                                                                                                       {
    if(is_null($expire))$expire = zDef::get('Z_COOKIE_EXPIRE');
    if(is_null($secure))$expire = zDef::get('Z_COOKIE_SECURE');
    if(is_null($httpOnly))$expire = zDef::get('Z_COOKIE_HTTPONLY');
    zLogger::debug("Setting Value of Encrypted Key:$key Value:$val Expire: $expire, Path: $path Domain: $domain Secure: $secure HTTPOnly: $httpOnly", 'rom.cookie');
    return setcookie($key, zCrypt::encrypt($val, true), (int)$expire, (string)$path, $domain, $secure);
  }

Here is the call graph for this function:

Top 

zCookie::getPlain( string $key = null ) 

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

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

Parameters:

$key

cookie variable Name

Returns:

mixed

Definition at line 108 of file cookie_handler.php.

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

Show Source

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

Here is the call graph for this function:

Top 

zCookie::setPlain( string $key, mixed $val, int $expire = 0, string $path = '', string $domain = null, boolen $secure = null, boolean $httpOnly = null )

Puts Cookie data in Plain text format(e.g.

Un encrypted). Stiores Cookie Data in Unencrypted Format so you need to invoke zCookie::getPlain() to retrive its value

Parameters:

	$key
	$val
	$expire
	$path
	$domain
	$secure
	$httpOnly

Returns:

boolean

Definition at line 137 of file cookie_handler.php.

References $val, zLogger::debug(), and zDef::get().

Show Source

                                                                                                {
    if(is_null($expire))$expire = zDef::get('Z_COOKIE_EXPIRE');
    if(is_null($secure))$expire = zDef::get('Z_COOKIE_SECURE');
    if(is_null($httpOnly))$expire = zDef::get('Z_COOKIE_HTTPONLY');
    zLogger::debug("Setting Value of Key:$key Value:$val Expire: $expire, Path: $path Domain: $domain Secure: $secure HTTPOnly: $httpOnly", 'rom.cookie');
    return setcookie($key, $val, (int)$expire, (string)$path, $domain, $secure);
  }

Here is the call graph for this function:

Top 

zCookie::setRaw( string $key, mixed $val, int $expire = 0, string $path = null, string $domain = null, boolen $secure = null, boolean $httpOnly = null )

Send a Raw Cookie.

Send a cookie without urlencoding the cookie value.

Parameters:

	$key
	$val
	$expire
	$path
	$domain
	$secure
	$httpOnly

Returns:

boolean

Definition at line 157 of file cookie_handler.php.

References $val, zLogger::debug(), and zDef::get().

Show Source

                                                                                                {
    if(is_null($expire))$expire = zDef::get('Z_COOKIE_EXPIRE');
    if(is_null($secure))$expire = zDef::get('Z_COOKIE_SECURE');
    if(is_null($httpOnly))$expire = zDef::get('Z_COOKIE_HTTPONLY');
    zLogger::debug("Setting Value of Raw Key:$key Value:$val Expire: $expire, Path: $path Domain: $domain Secure: $secure HTTPOnly: $httpOnly", 'rom.cookie');
    return setrawcookie($key, $val, $expire, $path, $domain, $secure, $httpOnly);
  }

Here is the call graph for this function:

Top 

zCookie::remove( string $key = null ) 

Removes a Key from Cookie.

Parameters:

$key

Returns:

boolean

Definition at line 170 of file cookie_handler.php.

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

Show Source

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

Here is the call graph for this function:

Top 

zCookie::keyExists( string $key = null ) 

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

Parameters:

$key

Returns:

boolean

Definition at line 191 of file cookie_handler.php.

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

Referenced by remove().

Show Source

                               {
    if($key == null || !is_string($key)){
      perror("<code>zCookie::keyExists()</code><br />You must provide which key to delete and that argumnt must be a string to zCookie::keyExists() e.g. it accepts 1 argumnt");return false;
      return false;
    }
    if(!isset($_COOKIE[$key])){
      zLogger::debug("zCookie::keyExists() says Key $key Doesn't exist", 'rom.cookie');
      return false;
    }else{
      zLogger::debug("zCookie::keyExists() says Key $key exists", 'rom.cookie');
      return true;
    }
  }

Here is the call graph for this function:

Top 

---

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

• cookie_handler.php