Source for file Session.class.php

Documentation is available at Session.class.php

  1. <?php
  2. /**
  3.  * Gumbo Library Framework
  4.  *
  5.  * LICENSE
  6.  * This library is being released under the terms of the New BSD License.  A
  7.  * copy of the license is packaged with the software (LICENSE.txt).  If no
  8.  * copy is found, a copy of the license template can be found at:
  9.  * http://www.opensource.org/licenses/bsd-license.php
  10.  * 
  11.  * @category Gumbo
  12.  * @package Session
  13.  * @copyright Copyright (c) 2007, iBayou, Michael Luster
  14.  * @license http://www.opensource.org/licenses/bsd-license.php New BSD License
  15.  * @author Michael Luster <mluster79@yahoo.com>
  16.  * @link http://sourceforge.net/projects/phpgumbo
  17.  * @version 0.0.1
  18.  */
  19.  
  20. /**
  21.  * Session Interface
  22.  *
  23.  * @category Gumbo
  24.  * @package Session
  25.  * @copyright Copyright (c) 2007, iBayou, Michael Luster
  26.  * @license http://www.opensource.org/licenses/bsd-license.php New BSD License
  27.  * @author Michael Luster <mluster79@yahoo.com>
  28.  * @link http://sourceforge.net/projects/phpgumbo
  29.  * @desc Session Interface
  30.  * @version 0.0.1
  31.  */
  32.  
  33. interface Gumbo_Interface_Session {
  34.     
  35.     /**
  36.      * Returns a SESSION value
  37.      * @param string $key 
  38.      * @return mix 
  39.      */
  40.     public function __get ($key);
  41.     
  42.     /**
  43.      * Sets the SESSION value
  44.      * @param string $key 
  45.      * @param mix $val 
  46.      */
  47.     public function __set ($key, $val);
  48.     
  49.     /**
  50.      * Returns if a SESSION variable exists
  51.      * @param string $key 
  52.      * @return bool 
  53.      */
  54.     public function __isset ($key);
  55.     
  56.     /**
  57.      * Unsets a SESSION variable
  58.      * @param string $key 
  59.      */
  60.     public function __unset ($key);
  61.     
  62.     
  63.     
  64.     /** ACTION METHODS **/
  65.     /**
  66.      * Starts the Session
  67.      * @return bool 
  68.      */
  69.     public function start ();
  70.     
  71.     /**
  72.      * Stops the Session by removing all Session data
  73.      */
  74.     public function stop ();
  75.     
  76.     /**
  77.      * Sets Session settings
  78.      * @param int $lifetime 
  79.      * @param string $path 
  80.      * @param string $domain 
  81.      * @param bool $secure 
  82.      */
  83.     public function saveSettings ($lifetime, $path=null, $domain=null, $secure=false);
  84.     
  85.     
  86.     
  87.     /** MUTATOR METHODS **/
  88.     /**
  89.      * Sets a value inside the SESSION array
  90.      * @param string $key 
  91.      * @param mix $val (primitive values only)
  92.      */
  93.     public function set ($key, $val);
  94.     
  95.     /**
  96.      * Sets the Session Lifetime
  97.      * @param int $secs 
  98.      */
  99.     public function setLifetime ($secs);
  100.     
  101.     /**
  102.      * Sets the Session path
  103.      * @param string $path 
  104.      */
  105.     public function setPath ($path);
  106.     
  107.     /**
  108.      * Sets the Session domain
  109.      * @param string $domain 
  110.      */
  111.     public function setDomain ($domain);
  112.     
  113.     /**
  114.      * Sets if the Session should be secure
  115.      * @param bool $val 
  116.      */
  117.     public function setSecure ($val);
  118.     
  119.     
  120.     
  121.     /** ACCESSOR METHODS **/
  122.     /**
  123.      * Returns the Session ID
  124.      * @return string 
  125.      */
  126.     public function getId ();
  127.     
  128.     /**
  129.      * Returns the Session Name
  130.      * @return string 
  131.      */
  132.     public function getName ();
  133.     
  134.     /**
  135.      * Returns the value of the SESSION variable
  136.      * @param string $key 
  137.      * @return string 
  138.      */
  139.     public function get ($key);
  140.     
  141.     /**
  142.      * Returns the SESSION array
  143.      * @return array 
  144.      */
  145.     public function getAll ();
  146.     
  147.     /**
  148.      * Returns the Session lifetime
  149.      * @return int 
  150.      */
  151.     public function getLifetime ();
  152.     
  153.     /**
  154.      * Returns the Session path
  155.      * @return string 
  156.      */
  157.     public function getPath ();
  158.     
  159.     /**
  160.      * Returns the Session domain
  161.      * @return string 
  162.      */
  163.     public function getDomain ();
  164.     
  165.     /**
  166.      * Returns if the Session is secure
  167.      * @return bool 
  168.      */
  169.     public function isSecure ();
  170.     
  171. }
  172.  
  173. ?>