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

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. {
  46.     /**
  47.      * Holds every Log message as string.
  48.      *
  49.      * @var ForwardFW_Object_Timer 
  50.      */
  51.     private $logTimer = null;
  52.  
  53.     /**
  54.      * Holds every Error message as string.
  55.      *
  56.      * @var ForwardFW_Object_Timer 
  57.      */
  58.     private $errorTimer = null;
  59.     
  60.     /**
  61.      * Holds the content to send back to web server.
  62.      *
  63.      * @var string 
  64.      */
  65.     private $strContent = '';
  66.  
  67.     /**
  68.      * Constructor
  69.      *
  70.      * @return void 
  71.      */
  72.     public function __construct()
  73.     {
  74.         $this->logTimer   = new ForwardFW_Object_Timer();
  75.         $this->errorTimer = clone $this->logTimer;
  76.     }
  77.  
  78.     /**
  79.      * Adds an entry to the log array.
  80.      *
  81.      * @param string $strEntry The entry as string.
  82.      *
  83.      * @return ForwardFW_Response Themself.
  84.      */
  85.     public function addLog($strEntry)
  86.     {
  87.         $this->logTimer->addEntry($strEntry);
  88.         return $this;
  89.     }
  90.  
  91.     /**
  92.      * Adds an entry to the error array.
  93.      *
  94.      * @param string $strEntry The entry as string.
  95.      *
  96.      * @return ForwardFW_Response Themself.
  97.      */
  98.     public function addError($strEntry)
  99.     {
  100.         $this->errorTimer->addEntry($strEntry);
  101.         return $this;
  102.     }
  103.  
  104.     /**
  105.      * Adds a string to the existent content string.
  106.      *
  107.      * @param string $strContent The content as string.
  108.      *
  109.      * @return ForwardFW_Response Themself.
  110.      */
  111.     public function addContent($strContent)
  112.     {
  113.         $this->content .= $strContent;
  114.         return $this;
  115.     }
  116.  
  117.     /**
  118.      * Returns the array with all its log entries.
  119.      *
  120.      * @return ForwardFW_Object_Timer The entries in a Timer Object.
  121.      */
  122.     public function getErrors()
  123.     {
  124.         return $this->errorTimer;
  125.     }
  126.  
  127.     /**
  128.      * Returns the array with all its log entries.
  129.      *
  130.      * @return ForwardFW_Object_Timer The entries in a Timer Object.
  131.      */
  132.     public function getLogs()
  133.     {
  134.         return $this->logTimer;
  135.     }
  136.  
  137.     /**
  138.      * Returns the content, which should be send back to web server.
  139.      *
  140.      * @return string The content.
  141.      */
  142.     public function getContent()
  143.     {
  144.         return $this->content;
  145.     }
  146. }
  147.  
  148. ?>

Documentation generated on Sun, 30 Jan 2011 20:46:44 +0100 by phpDocumentor 1.4.3