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

Source for file Application.php

Documentation is available at Application.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   Application
  23.  * @package    ForwardFW
  24.  * @subpackage Interface
  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.5
  31.  */
  32.  
  33. /**
  34.  *
  35.  */
  36.  
  37. /**
  38.  * This Interface must be implemented from an application.
  39.  *
  40.  * @category   Application
  41.  * @package    ForwardFW
  42.  * @subpackage Interface
  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. interface ForwardFW_Interface_Application
  48. {
  49.     /**
  50.      * Constructor
  51.      *
  52.      * @param string             $strName  Name of application.
  53.      * @param ForwardFW_Request  $request  The ForwardFW request object.
  54.      * @param ForwardFW_Response $response The ForwardFW response object.
  55.      *
  56.      * @return void 
  57.      */
  58.     public function __construct(
  59.         $strName,
  60.         ForwardFW_Request $request,
  61.         ForwardFW_Response $response
  62.     );
  63.  
  64.     /**
  65.      * Run screen and return generated content
  66.      *
  67.      * @return string generated content form screens
  68.      */
  69.     public function run();
  70.  
  71.  
  72.     /**
  73.      * Returns the name of the application
  74.      *
  75.      * @return string 
  76.      */
  77.     public function getName();
  78.  
  79.  
  80.     /**
  81.      * Returns the request object
  82.      *
  83.      * @return ForwardFW_Request 
  84.      */
  85.     public function getRequest();
  86.  
  87.     /**
  88.      * Returns the response object
  89.      *
  90.      * @return ForwardFW_Response 
  91.      */
  92.     public function getResponse();
  93. }
  94. ?>
Documentation generated on Sun, 30 Jan 2011 20:46:37 +0100 by phpDocumentor 1.4.3