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

Source for file Response.php

Documentation is available at Response.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. require_once 'ForwardFW/Object/Timer.php';
  34.  
  35. /**
  36.  * This class represents the Response to the browser.
  37.  *
  38.  * @category   Request
  39.  * @package    ForwardFW
  40.  * @subpackage Main
  41.  * @author     Alexander Opitz <opitz.alexander@primacom.net>
  42.  * @license    http://www.gnu.org/copyleft/gpl.html GNU General Public License
  43.  * @link       http://forwardfw.sourceforge.net
  44.  */
  45. class ForwardFW_Response
  46. {
  47.     /**
  48.      * Holds every Log message as string.
  49.      *
  50.      * @var ForwardFW_Object_Timer 
  51.      */
  52.     private $logTimer = null;
  53.  
  54.     /**
  55.      * Holds every Error message as string.
  56.      *
  57.      * @var ForwardFW_Object_Timer 
  58.      */
  59.     private $errorTimer = null;
  60.     
  61.     /**
  62.      * Holds the content to send back to web server.
  63.      *
  64.      * @var string 
  65.      */
  66.     private $strContent = '';
  67.  
  68.     /**
  69.      * Constructor
  70.      *
  71.      * @return void 
  72.      */
  73.     public function __construct()
  74.     {
  75.         $this->logTimer   = new ForwardFW_Object_Timer();
  76.         $this->errorTimer = clone $this->logTimer;
  77.     }
  78.  
  79.     /**
  80.      * Adds an entry to the log array.
  81.      *
  82.      * @param string $strEntry The entry as string.
  83.      *
  84.      * @return ForwardFW_Response Themself.
  85.      */
  86.     public function addLog($strEntry)
  87.     {
  88.         $this->logTimer->addEntry($strEntry);
  89.         return $this;
  90.     }
  91.  
  92.     /**
  93.      * Adds an entry to the error array.
  94.      *
  95.      * @param string $strEntry The entry as string.
  96.      *
  97.      * @return ForwardFW_Response Themself.
  98.      */
  99.     public function addError($strEntry)
  100.     {
  101.         $this->errorTimer->addEntry($strEntry);
  102.         return $this;
  103.     }
  104.  
  105.     /**
  106.      * Adds a string to the existent content string.
  107.      *
  108.      * @param string $strContent The content as string.
  109.      *
  110.      * @return ForwardFW_Response Themself.
  111.      */
  112.     public function addContent($strContent)
  113.     {
  114.         $this->content .= $strContent;
  115.         return $this;
  116.     }
  117.  
  118.     /**
  119.      * Returns the array with all its log entries.
  120.      *
  121.      * @return ForwardFW_Object_Timer The entries in a Timer Object.
  122.      */
  123.     public function getErrors()
  124.     {
  125.         return $this->errorTimer;
  126.     }
  127.  
  128.     /**
  129.      * Returns the array with all its log entries.
  130.      *
  131.      * @return ForwardFW_Object_Timer The entries in a Timer Object.
  132.      */
  133.     public function getLogs()
  134.     {
  135.         return $this->logTimer;
  136.     }
  137.  
  138.     /**
  139.      * Returns the content, which should be send back to web server.
  140.      *
  141.      * @return string The content.
  142.      */
  143.     public function getContent()
  144.     {
  145.         return $this->content;
  146.     }
  147. }
  148.  
  149. ?>
Documentation generated on Sun, 30 Jan 2011 20:46:44 +0100 by phpDocumentor 1.4.3