Source for file Session.php

Documentation is available at Session.php

  1. <?php
  2. /**
  3.  * Teeple2 - PHP5 Web Application Framework inspired by Seasar2
  4.  *
  5.  * PHP versions 5
  6.  *
  7.  * LICENSE: This source file is subject to version 3.0 of the PHP license
  8.  * that is available through the world-wide-web at the following URI:
  9.  * http://www.php.net/license/3_0.txt.  If you did not receive a copy of
  10.  * the PHP License and are unable to obtain it through the web, please
  11.  * send a note to license@php.net so we can mail you a copy immediately.
  12.  *
  13.  * @package     teeple
  14.  * @author      Mitsutaka Sato <miztaka@gmail.com>
  15.  * @license     http://www.php.net/license/3_0.txt  PHP License 3.0
  16.  */
  17.  
  18. /**
  19.  * Session管理を行う
  20.  *
  21.  * @package     teeple
  22.  */
  23. class Teeple_Session
  24. {
  25.  
  26.     /**
  27.      * 設定されている値を返却
  28.      *
  29.      * @param   string  $key    パラメータ名
  30.      * @return  string  パラメータの値
  31.      */
  32.     public function getParameter($key) {
  33.         return isset($_SESSION[$key]) ?
  34.             $_SESSION[$key] : NULL;
  35.     }
  36.  
  37.     /**
  38.      * 値をセット
  39.      *
  40.      * @param   string  $key    パラメータ名
  41.      * @param   string  $value  パラメータの値
  42.      */
  43.     public function setParameter($key, $value) {
  44.         $_SESSION[$key] = $value;
  45.     }
  46.  
  47.     /**
  48.      * 値をセット(オブジェクトをセット)
  49.      *
  50.      * @param   string  $key    パラメータ名
  51.      * @param   Object  $value  パラメータの値
  52.      */
  53.     public function setParameterRef($key, &$value) {
  54.         $_SESSION[$key] =& $value;
  55.     }
  56.  
  57.     /**
  58.      * 値を返却(配列で返却)
  59.      *
  60.      * @param   string  $key    パラメータ名
  61.      * @return  string  パラメータの値(配列)
  62.      */
  63.     public function getParameters() {
  64.         return isset($_SESSION) ? $_SESSION : NULL;
  65.     }
  66.  
  67.     /**
  68.      * 値を削除する
  69.      *
  70.      * @param   string  $key    パラメータ名
  71.      */
  72.     public function removeParameter($key) {
  73.         unset($_SESSION[$key]);
  74.     }
  75.  
  76.     /**
  77.      * セッション処理を開始
  78.      * TODO regenerateするとブラウザバックとかしたときにおかしくなるのでコメントアウト
  79.      */
  80.     public function start() {
  81.  
  82.         if (! isset($_COOKIE[session_name()])) {
  83.             @ini_set('session.use_trans_sid','1');
  84.         }
  85.         @session_start();
  86.         //@session_regenerate_id(true);
  87.     }
  88.  
  89.     /**
  90.      * セッション処理を終了
  91.      *
  92.      */
  93.     public function close() {
  94.         $_SESSION = array();
  95.         session_destroy();
  96.     }
  97.  
  98.     /**
  99.      * セッション名を返却
  100.      *
  101.      * @return  string  セッション名
  102.      */
  103.     public function getName() {
  104.         return session_name();
  105.     }
  106.  
  107.     /**
  108.      * セッション名をセット
  109.      *
  110.      * @param   string  $name   セッション名
  111.      */
  112.     public function setName($name = '') {
  113.         if ($name) {
  114.             session_name($name);
  115.         }
  116.     }
  117.  
  118.     /**
  119.      * セッションIDを返却
  120.      *
  121.      * @return  string  セッションID
  122.      */
  123.     public function getID() {
  124.         return session_id();
  125.     }
  126.  
  127.     /**
  128.      * セッションIDをセット
  129.      *
  130.      * @param   string  $id セッションID
  131.      */
  132.     public function setID($id = '') {
  133.         if ($id) {
  134.             session_id($id);
  135.         }
  136.     }
  137.  
  138.     /**
  139.      * save_pathをセット
  140.      *
  141.      * @param   string  $savePath   save_path
  142.      */
  143.     public function setSavePath($savePath) {
  144.         if (!isset($savePath)) {
  145.             return;
  146.         }
  147.         session_save_path($savePath);
  148.     }
  149.  
  150.     /**
  151.      * cache_limiterをセット
  152.      *
  153.      * @param   string  $cacheLimiter   cache_limiter
  154.      */
  155.     public function setCacheLimiter($cacheLimiter) {
  156.         if (!isset($cacheLimiter)) {
  157.             return;
  158.         }
  159.         session_cache_limiter($cacheLimiter);
  160.     }
  161.  
  162.     /**
  163.      * cache_expireをセット
  164.      *
  165.      * @param   string  $cacheExpire    cache_expire
  166.      */
  167.     public function setCacheExpire($cacheExpire) {
  168.         if (!isset($cacheExpire)) {
  169.             return;
  170.         }
  171.         session_cache_expire($cacheExpire);
  172.     }
  173.  
  174.     /**
  175.      * use_cookies をセット
  176.      *
  177.      * @param   string  $useCookies use_cookies
  178.      */
  179.     public function setUseCookies($useCookies) {
  180.         if (!isset($useCookies)) {
  181.             return;
  182.         }
  183.         ini_set('session.use_cookies', $useCookies ? 1 : 0);
  184.     }
  185.  
  186.     /**
  187.      * cookie_lifetime をセット
  188.      *
  189.      * @param   string  $cookieLifetime cookie_lifetime
  190.      */
  191.     public function setCookieLifetime($cookieLifetime) {
  192.         
  193.         if (!isset($cookieLifetime)) {
  194.             return;
  195.         }
  196.         $cookie_params = session_get_cookie_params();
  197.         session_set_cookie_params($cookieLifetime, $cookie_params['path'], $cookie_params['domain'], $cookie_params['secure']);
  198.     }
  199.  
  200.     /**
  201.      * cookie_path をセット
  202.      *
  203.      * @param   string  $cookiePath cookie_path
  204.      */
  205.     public function setCookiePath($cookiePath) {
  206.  
  207.         if (!isset($cookiePath)) {
  208.             return;
  209.         }
  210.         $cookie_params = session_get_cookie_params();
  211.         session_set_cookie_params($cookie_params['lifetime'], $cookiePath, $cookie_params['domain'], $cookie_params['secure']);
  212.     }
  213.  
  214.     /**
  215.      * cookie_domain をセット
  216.      *
  217.      * @param   string  $cookieDomain   cookie_domain
  218.      */
  219.     public function setCookieDomain($cookieDomain) {
  220.  
  221.         if (!isset($cookieDomain)) {
  222.             return;
  223.         }
  224.         $cookie_params = session_get_cookie_params();
  225.         session_set_cookie_params($cookie_params['lifetime'], $cookie_params['path'], $cookieDomain, $cookie_params['secure']);
  226.     }
  227.  
  228.     /**
  229.      * cookie_secure をセット(SSL利用時などにsecure属性を設定する)
  230.      *
  231.      * @param   string  $cookieSecure   cookie_secure
  232.      */
  233.     public function setCookieSecure($cookieSecure) {
  234.  
  235.         if (!isset($cookieSecure)) {
  236.             return;
  237.         }
  238.         if (preg_match('/^true$/i', $cookieSecure) ||
  239.             preg_match('/^secure$/i', $cookieSecure) ||
  240.             preg_match('/^on$/i', $cookieSecure) ||
  241.             ($cookieSecure === '1') || ($cookieSecure === 1)) {
  242.             $cookieSecure = true;
  243.         } else {
  244.             $cookieSecure = false;
  245.         }
  246.  
  247.         $cookie_params = session_get_cookie_params();
  248.         session_set_cookie_params($cookie_params['lifetime'], $cookie_params['path'], $cookie_params['domain'], $cookieSecure);
  249.     }
  250. }
  251. ?>
Documentation generated on Mon, 26 Apr 2010 08:59:56 +0900 by phpDocumentor 1.4.3