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

Source for file RequestResponse.php

Documentation is available at RequestResponse.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   Filter
  23.  * @package    ForwardFW
  24.  * @subpackage RequestResponse
  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. require_once 'ForwardFW/Filter.php';
  34. require_once 'ForwardFW/Request.php';
  35. require_once 'ForwardFW/Response.php';
  36.  
  37. /**
  38.  * This abstract class needs to be extended to be a callable filter.
  39.  *
  40.  * @category   Filter
  41.  * @package    ForwardFW
  42.  * @subpackage RequestResponse
  43.  * @author     Alexander Opitz <opitz.alexander@primacom.net>
  44.  * @license    http://www.gnu.org/copyleft/gpl.html GNU General Public License
  45.  * @link       http://forwardfw.sourceforge.net
  46.  */
  47. class ForwardFW_Filter_RequestResponse extends ForwardFW_Filter
  48. {
  49.     /**
  50.      * The Request object
  51.      *
  52.      * @var ForwardFW_Request 
  53.      */
  54.     protected $request = null;
  55.  
  56.     /**
  57.      * The Response object
  58.      *
  59.      * @var ForwardFW_Request 
  60.      */
  61.     protected $response = null;
  62.  
  63.     /**
  64.      * Constructor
  65.      *
  66.      * @param ForwardFW_Filter_RequestResponse $_child    The child filter or null
  67.      *  if you are the last
  68.      * @param ForwardFW_Request                $_request  The request for this
  69.      *                                                     application
  70.      * @param ForwardFW_Response               $_response The response for this
  71.      *                                                     application
  72.      *
  73.      * @return new instance
  74.      */
  75.     public function __construct(
  76.         ForwardFW_Filter_RequestResponse $_child = null,
  77.         ForwardFW_Request $_request = null,
  78.         ForwardFW_Response $_response = null
  79.     ) {
  80.         parent::__construct($_child);
  81.         if (! is_null($this->child)) {
  82.             $this->request  = $this->child->getRequest();
  83.             $this->response = $this->child->getResponse();
  84.         } else {
  85.             $this->request  = $_request;
  86.             $this->response = $_response;
  87.         }
  88.     }
  89.  
  90.     /**
  91.      * Function to process before your child
  92.      *
  93.      * @return void 
  94.      */
  95.     public function doIncomingFilter()
  96.     {
  97.         $this->response->addLog('Hallo');
  98.     }
  99.  
  100.     /**
  101.      * Function to process after your child
  102.      *
  103.      * @return void 
  104.      */
  105.     public function doOutgoingFilter()
  106.     {
  107.         $this->response->addLog('Bye');
  108.     }
  109.  
  110.     /**
  111.      * Returns the request object of this process
  112.      *
  113.      * @return ForwardFW_Request 
  114.      */
  115.     public function getRequest()
  116.     {
  117.         return $this->request;
  118.     }
  119.  
  120.     /**
  121.      * Returns the response object of this process
  122.      *
  123.      * @return ForwardFW_Response 
  124.      */
  125.     public function getResponse()
  126.     {
  127.         return $this->response;
  128.     }
  129.  
  130.     /**
  131.      * Builds the Filters which are defined in the configuration for RequestResponse
  132.      * handling.
  133.      *
  134.      * @param ForwardFW_Request  $_request  The request for this application
  135.      * @param ForwardFW_Response $_response The response for this application
  136.      *
  137.      * @return ForwardFW_Filter_RequestResponse The start filter with the
  138.      *  configured childs. So the filters can be started.
  139.      */
  140.     public static function getFilters(
  141.         ForwardFW_Request $_request,
  142.         ForwardFW_Response $_response
  143.     ) {
  144.         $filter = null;
  145.         $arConfig = $GLOBALS[get_class()];
  146.         if (is_array($arConfig)) {
  147.             $arConfig = array_reverse($arConfig);
  148.             foreach ($arConfig as $strFilter) {
  149.                 include_once str_replace('_', '/', $strFilter) . '.php';
  150.                 $filter = new $strFilter($filter, $_request, $_response);
  151.             }
  152.         } else {
  153.             // Fehler werfen
  154.         }
  155.         return $filter;
  156.     }
  157. }
  158. ?>
Documentation generated on Sun, 30 Jan 2011 20:46:44 +0100 by phpDocumentor 1.4.3