Source for file Request.php

Documentation is available at Request.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.  * POST/GETで受け取った値を格納する
  20.  *
  21.  * @package     teeple
  22.  */
  23. class Teeple_Request
  24. {
  25.     /**
  26.      * POT/GETで受け取った値を保持する
  27.      * @var array 
  28.      */
  29.     private $_params;
  30.     
  31.     /**
  32.      * @var array 
  33.      */
  34.     private $errorList = array();
  35.     
  36.     /**
  37.      * @var string 
  38.      */
  39.     private $filterError;
  40.     
  41.     /**
  42.      * @var string 
  43.      */
  44.     private $actionMethod;
  45.     
  46.     /**
  47.      * Actionの実行が完了したかどうか
  48.      * @var boolean 
  49.      */
  50.     private $completeActionFlg = FALSE;
  51.     
  52.     /**
  53.      * Responseの返却が完了したかどうか
  54.      * @var boolean 
  55.      */
  56.     private $completeResponseFlg = FALSE;
  57.     
  58.     /**
  59.      * 
  60.      * @var boolean 
  61.      */
  62.     public $isRedirect = FALSE;
  63.         
  64.     /**
  65.      * @var Logger 
  66.      */
  67.     private $log;
  68.  
  69.     /**
  70.      * コンストラクタ
  71.      *
  72.      */
  73.     public function __construct() {
  74.  
  75.         $this->log = LoggerManager::getLogger(get_class($this));
  76.         
  77.         $request = array_merge($_POST, $_GET);
  78.         if (get_magic_quotes_gpc()) {
  79.             $request = $this->_stripSlashesDeep($request);
  80.         }
  81.         if (!ini_get("mbstring.encoding_translation") &&
  82.             (INPUT_CODE != INTERNAL_CODE)) {
  83.              mb_convert_variables(INTERNAL_CODE, INPUT_CODE, $request);
  84.         }
  85.         
  86.         // action:~ではじまるパラメータがあればactionMethodをセットする
  87.         $methodName = "execute";
  88.         $key = NULL;
  89.         foreach($request as $k => $val) {
  90.             if (preg_match('/^action:(.+)$/', $k, $m)) {
  91.                 $methodName = $m[1];
  92.                 $this->log->debug("actionMethodが指定されました。 {$methodName}");
  93.                 $key = $k;
  94.                 break;
  95.             }
  96.         }
  97.         $this->actionMethod = $methodName;
  98.         if ($key != NULL) {
  99.             unset($request[$key]);
  100.         }
  101.  
  102.         $this->_params = $request;
  103.         
  104.         return;
  105.     }
  106.     
  107.     /**
  108.      * stripslashes() 関数を再帰的に実行する
  109.      *
  110.      * @param   mixed  $value  処理する変数
  111.      * @return  mixed  処理結果
  112.      * @see     http://www.php.net/manual/ja/function.stripslashes.php#AEN181588
  113.      */
  114.     private function _stripSlashesDeep($value) {
  115.  
  116.         if (is_array($value)) {
  117.             $value = array_map(array($this, '_stripSlashesDeep'), $value);
  118.         } else {
  119.             $value = stripslashes($value);
  120.         }
  121.         return $value;
  122.     }
  123.  
  124.     /**
  125.      * REQUEST_METHODの値を返却
  126.      *
  127.      * @return  string  REQUEST_METHODの値
  128.      */
  129.     public function getMethod() {
  130.         return $_SERVER["REQUEST_METHOD"];
  131.     }
  132.  
  133.     /**
  134.      * POST/GETの値を返却
  135.      *
  136.      * @param   string  $key    パラメータ名
  137.      * @return  string  パラメータの値
  138.      */
  139.     public function getParameter($key) {
  140.         return isset($this->_params[$key]) ?
  141.             $this->_params[$key] : NULL;
  142.     }
  143.  
  144.     /**
  145.      * POST/GETの値をセット
  146.      *
  147.      * @param   string  $key    パラメータ名
  148.      * @param   string  $value  パラメータの値
  149.      */
  150.     function setParameter($key, $value) {
  151.         $this->_params[$key] = $value;
  152.     }
  153.  
  154.     /**
  155.      * リクエストパラメータを削除する
  156.      *
  157.      * @param string $key 
  158.      */
  159.     function removeParameter($key) {
  160.         unset($this->_params[$key]);
  161.     }
  162.     
  163.     /**
  164.      * POST/GETの値を返却(配列で返却)
  165.      *
  166.      * @param   string  $key    パラメータ名
  167.      * @return  array  パラメータの値(配列)
  168.  
  169.      */
  170.     function getParameters() {
  171.         return $this->_params;
  172.     }
  173.  
  174.     /**
  175.      * エラーメッセージを追加します。
  176.      *
  177.      * @param string $message 
  178.      * @param string $target 
  179.      */
  180.     public function addErrorMessage($message, $target="__DEFAULT") {
  181.         
  182.         if (! isset($this->errorList[$target])) {
  183.             $this->errorList[$target] = array();
  184.         }
  185.         $this->errorList[$target][] = $message;
  186.         return;
  187.     }
  188.     
  189.     /**
  190.      * エラーがあるかどうか
  191.      *
  192.      * @return boolean 
  193.      */
  194.     public function isError() {
  195.         return count($this->errorList) > 0;
  196.     }
  197.     
  198.     /**
  199.      * 指定されたtargetのエラーメッセージを取得します。
  200.      *
  201.      * @param string $target 
  202.      * @return array 
  203.      */
  204.     public function getErrorMessages($target=NULL) {
  205.         
  206.         if ($target == NULL) {
  207.             return $this->getAllErrorMessages();
  208.         }
  209.         return isset($this->errorList[$target]) ?
  210.             $this->errorList[$target] : array();
  211.     }
  212.     
  213.     /**
  214.      * 全てのエラーメッセージを取得します。
  215.      *
  216.      * @return array 
  217.      */
  218.     public function getAllErrorMessages() {
  219.         
  220.         $allmessages = array();
  221.         foreach($this->errorList as $target => $errors) {
  222.             $allmessages = array_merge($allmessages, $errors);
  223.         }
  224.         return $allmessages;
  225.     }
  226.     
  227.     /**
  228.      * エラーメッセージをクリアします。
  229.      *
  230.      */
  231.     public function resetErrorMessages() {
  232.         $this->errorList = array();
  233.         return;
  234.     }
  235.     
  236.     public function setFilterError($errorType) {
  237.         $this->filterError = $errorType;
  238.         return;
  239.     }
  240.     
  241.     public function getFilterError() {
  242.         return $this->filterError;
  243.     }
  244.     
  245.     public function isFilterError() {
  246.         return isset($this->filterError) && strlen($this->filterError);
  247.     }
  248.     
  249.     public function getActionMethod() {
  250.         return $this->actionMethod;
  251.     }
  252.     
  253.     public function setActionMethod($method) {
  254.         $this->actionMethod = $method;
  255.     }
  256.     
  257.     
  258.     /**
  259.      * Actionの完了をセットします。
  260.      *
  261.      */
  262.     public function completeAction() {
  263.         $this->completeActionFlg = TRUE;
  264.     }
  265.     
  266.     /**
  267.      * Responseの完了をセットします。
  268.      *
  269.      */
  270.     public function completeResponse() {
  271.         $this->completeActionFlg = TRUE;
  272.         $this->completeResponseFlg = TRUE;
  273.     }
  274.     
  275.     /**
  276.      * Actionが完了したかどうか？
  277.      * @return boolean 
  278.      */
  279.     public function isCompleteAction() {
  280.         return $this->completeActionFlg;
  281.     }
  282.     
  283.     /**
  284.      * Responseが完了したかどうか？
  285.      * @return boolean 
  286.      */
  287.     public function isCompleteResponse() {
  288.         return $this->completeResponseFlg;
  289.     }
  290.     
  291.     public function resetCompleteFlag() {
  292.         $this->completeActionFlg = FALSE;
  293.         $this->completeResponseFlg = FALSE;
  294.     }    
  295.  
  296. }
  297. ?>
Documentation generated on Mon, 26 Apr 2010 08:59:54 +0900 by phpDocumentor 1.4.3