ForwardFW
[ class tree: ForwardFW ] [ index: ForwardFW ] [ all elements ]
Packages:
ForwardFW

Source for file Request.php

Documentation is available at Request.php

  1. <?php
  2. declare(encoding = "utf-8");
  3. /**
  4.  * This file is part of ForwardFW a web application framework.
  5.  *
  6.  * This library is free software; you can redistribute it and/or
  7.  * modify it under the terms of the GNU General Public
  8.  * License as published by the Free Software Foundation; either
  9.  * version 2.1 of the License, or (at your option) any later version.
  10.  *
  11.  * This library is distributed in the hope that it will be useful,
  12.  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13.  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14.  * General Public License for more details.
  15.  *
  16.  * You should have received a copy of the GNU General Public
  17.  * License along with this library; if not, write to the Free Software
  18.  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  19.  *
  20.  * PHP version 5
  21.  *
  22.  * @category   Request
  23.  * @package    ForwardFW
  24.  * @subpackage Main
  25.  * @author     Alexander Opitz <opitz.alexander@primacom.net>
  26.  * @copyright  2009,2010 The Authors
  27.  * @license    http://www.gnu.org/copyleft/gpl.html GNU General Public License
  28.  * @version    SVN: $Id: $
  29.  * @link       http://forwardfw.sourceforge.net
  30.  * @since      File available since Release 0.0.1
  31.  */
  32.  
  33. /**
  34.  * This class represents the Request from browser.
  35.  *
  36.  * @category   Request
  37.  * @package    ForwardFW
  38.  * @subpackage Main
  39.  * @author     Alexander Opitz <opitz.alexander@primacom.net>
  40.  * @license    http://www.gnu.org/copyleft/gpl.html GNU General Public License
  41.  * @link       http://forwardfw.sourceforge.net
  42.  */
  43. class ForwardFW_Request
  44. {
  45.     /**
  46.      * Returns the parameter for the application from browser request or
  47.      * the session data.
  48.      *
  49.      * @param string $strParameterName   Name of the parameter to return.
  50.      * @param string $strControllerClass Class name of the controller, wh asks.
  51.      * @param string $strApplicationName Name of the application.
  52.      *
  53.      * @return mixed The parameter for the application or null.
  54.      */
  55.     public function getParameter(
  56.         $strParameterName,
  57.         $strControllerClass = 'ForwardFW_Request',
  58.         $strApplicationName = ''
  59.     ) {
  60.         $return = $this->getRequestParameter(
  61.             $strParameterName, $strApplicationName
  62.         );
  63.         if (is_null($return)) {
  64.             $return = $this->getConfigParameter(
  65.                 $strParameterName, $strControllerClass, $strApplicationName
  66.             );
  67.         }
  68.         return $return;
  69.     }
  70.  
  71.     /**
  72.      * Returns the request parameter from browser/user session.
  73.      *
  74.      * @param string $strParameterName   Name of the parameter to return.
  75.      * @param string $strApplicationName Name of the application.
  76.      *
  77.      * @return mixed The parameter from the request.
  78.      */
  79.     public function getRequestParameter(
  80.         $strParameterName,
  81.         $strApplicationName = ''
  82.     ) {
  83.         $return = null;
  84.         if (isset($_REQUEST[$strApplicationName][$strParameterName])) {
  85.             $return = $_REQUEST[$strApplicationName][$strParameterName];
  86.         }
  87.         return $return;
  88.     }
  89.  
  90.     /**
  91.      * Returns the config parameter for the application from configuration.
  92.      *
  93.      * @param string $strParameterName   Name of the parameter to return.
  94.      * @param string $strControllerClass Class name of the controller, wh asks.
  95.      * @param string $strApplicationName Name of the application.
  96.      *
  97.      * @return mixed The configuration for the application or null.
  98.      */
  99.     public function getConfigParameter(
  100.         $strParameterName,
  101.         $strControllerClass = 'ForwardFW_Request',
  102.         $strApplicationName = ''
  103.     ) {
  104.         $return = null;
  105.         if (isset($GLOBALS[$strParameterName])) {
  106.             $return = $GLOBALS[$strParameterName];
  107.         }
  108.         if (isset($GLOBALS['ForwardFW'][$strParameterName])) {
  109.             $return = $GLOBALS['ForwardFW'][$strParameterName];
  110.         }
  111.         if (isset($GLOBALS[$strApplicationName][$strParameterName])) {
  112.             $return = $GLOBALS[$strApplicationName][$strParameterName];
  113.         }
  114.         if (isset($GLOBALS[$strControllerClass][$strParameterName])) {
  115.             $return = $GLOBALS[$strControllerClass][$strParameterName];
  116.         }
  117.         if (
  118.             isset(
  119.                 $GLOBALS[$strApplicationName][$strControllerClass][$strParameterName]
  120.             )
  121.         ) {
  122.             $return = $GLOBALS[$strApplicationName][$strControllerClass][$strParameterName];
  123.         }
  124.         return $return;
  125.     }
  126. }
  127. ?>
Documentation generated on Sun, 30 Jan 2011 20:46:44 +0100 by phpDocumentor 1.4.3