Source for file Token.php

Documentation is available at Token.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.  * Token管理を行う
  20.  *
  21.  * @package     teeple
  22.  */
  23. class Teeple_Token
  24. {
  25.     /**
  26.      * @var Tokenの名前を保持する 
  27.      *
  28.      * @access  private
  29.      * @since   3.0.0
  30.      */
  31.     var $_name;
  32.  
  33.     /**
  34.      * @var Teeple_Session 
  35.      */
  36.     var $_session;
  37.     public function setComponent_Teeple_Session($c) {
  38.         $this->_session = $c;
  39.     }
  40.  
  41.     /**
  42.      * コンストラクター
  43.      *
  44.      * @access  public
  45.      * @since   3.0.0
  46.      */
  47.     function __construct()
  48.     {
  49.         $this->_name = "";
  50.         $this->_session = NULL;
  51.     }
  52.  
  53.     /**
  54.      * Sessionのインスタンスをセット
  55.      *
  56.      * @param   Object  $session    Sessionのインスタンス
  57.      * @access  public
  58.      * @since   3.0.0
  59.      */
  60.     function setSession($session)
  61.     {
  62.         $this->_session = $session;
  63.     }
  64.  
  65.     /**
  66.      * Tokenの名前を返却
  67.      *
  68.      * @return  string  Tokenの名前
  69.      * @access  public
  70.      * @since   3.0.0
  71.      */
  72.     function getName()
  73.     {
  74.         if ($this->_name == "") {
  75.             $this->_name = "mapleToken";
  76.         }
  77.  
  78.         return $this->_name;
  79.     }
  80.  
  81.     /**
  82.      * Tokenの名前を設定
  83.      *
  84.      * @param   string  $name   Tokenの名前
  85.      * @access  public
  86.      * @since   3.0.0
  87.      */
  88.     function setName($name)
  89.     {
  90.         $this->_name = $name;
  91.     }
  92.  
  93.     /**
  94.      * Tokenの値を返却
  95.      *
  96.      * @return  string  Tokenの値を返却
  97.      * @access  public
  98.      * @since   3.0.0
  99.      */
  100.     function getValue()
  101.     {
  102.         return $this->_session->getParameter($this->getName());
  103.     }
  104.  
  105.     /**
  106.      * Tokenの値を生成
  107.      *
  108.      * @access  public
  109.      * @since   3.0.0
  110.      */
  111.     function build()
  112.     {
  113.         $this->_session->setParameter($this->getName(), md5(uniqid(rand(),1)));
  114.     }
  115.  
  116.     /**
  117.      * Tokenの値を比較
  118.      *
  119.      * @param   Object  $value  Requestクラスのインスタンス
  120.      * @return  boolean Tokenの値が一致するか？
  121.      * @access  public
  122.      * @since   3.0.0
  123.      */
  124.     function check(&$request)
  125.     {
  126.         return (($this->getValue() != '') &&
  127.                 $this->getValue() == $request->getParameter($this->getName()));
  128.     }
  129.  
  130.     /**
  131.      * Tokenの値を削除
  132.      *
  133.      * @access  public
  134.      * @since   3.0.0
  135.      */
  136.     function remove()
  137.     {
  138.         $this->_session->removeParameter($this->getName());
  139.     }
  140. }
  141. ?>
Documentation generated on Mon, 26 Apr 2010 09:00:00 +0900 by phpDocumentor 1.4.3