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

Source for file Screen.php

Documentation is available at Screen.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 Controller
  25.  * @author     Alexander Opitz <opitz.alexander@primacom.net>
  26.  * @copyright  2009 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.  *
  35.  */
  36. require_once 'ForwardFW/Controller/View.php';
  37. require_once 'ForwardFW/Interface/Application.php';
  38. require_once 'ForwardFW/Interface/Screen.php';
  39.  
  40. /**
  41.  * This class is a basic Screen class.
  42.  *
  43.  * @category   Application
  44.  * @package    ForwardFW
  45.  * @subpackage Controller
  46.  * @author     Alexander Opitz <opitz.alexander@primacom.net>
  47.  * @license    http://www.gnu.org/copyleft/gpl.html GNU General Public License
  48.  * @link       http://forwardfw.sourceforge.net
  49.  */
  50. class ForwardFW_Controller_Screen extends ForwardFW_Controller_View
  51.     implements ForwardFW_Interface_Screen
  52. {
  53.     /**
  54.      * The View which should be used.
  55.      *
  56.      * @var ArrayObject of ForwardFW_Controller_View
  57.      */
  58.     private $views;
  59.  
  60.     /**
  61.      * Constructor
  62.      *
  63.      * @param ForwardFW_Interface_Application $_application The running application.
  64.      *
  65.      * @return void 
  66.      */
  67.     public function __construct(ForwardFW_Interface_Application $_application)
  68.     {
  69.         parent::__construct($_application);
  70.         $this->views = new ArrayObject();
  71.         $this->strView = 'ForwardFW_Controller_View';
  72.     }
  73.  
  74.     /**
  75.      * Processes the Screen.
  76.      *
  77.      * @return string result of View
  78.      */
  79.     public function process()
  80.     {
  81.         $this->application->getResponse()->addLog('Processing ' . get_class($this));
  82.         $this->controlInput();
  83.         $this->processInput();
  84.         $this->controlView();
  85.         return $this->processView();
  86.     }
  87.  
  88.     /**
  89.      * Control the user input, if available.
  90.      *
  91.      * @return boolean True if all user input was accepted.
  92.      */
  93.     public function controlInput()
  94.     {
  95.         return true;
  96.     }
  97.  
  98.  
  99.     /**
  100.      * Do some processing with user Input.
  101.      *
  102.      * @return boolean True if processing was succesfully.
  103.      */
  104.     public function processInput()
  105.     {
  106.         return true;
  107.     }
  108.  
  109.     /**
  110.      * Loads Data for views and defines which views to use.
  111.      * strView is used.
  112.      *
  113.      * @return boolean True if screen wants to be viewed. Necessary for MultiApps.
  114.      */
  115.     public function controlView()
  116.     {
  117.         $view = $this->loadView($this->strView);
  118.         $this->addView($view);
  119.         parent::controlView();
  120.         return true;
  121.     }
  122.  
  123.     /**
  124.      * Processes the View.
  125.      *
  126.      * @return string what to view
  127.      */
  128.     public function processView()
  129.     {
  130.         $templater = ForwardFW_Templater::factory($this->application);
  131.         foreach ($this->views as $view) {
  132.             $templater->setVar(
  133.                 'VIEW_' . strtoupper($view->strViewName),
  134.                 $view->process()
  135.             );
  136.         }
  137.         return parent::processView();
  138.     }
  139.  
  140.     /**
  141.      * Adds a view to the list of views.
  142.      *
  143.      * @param ForwardFW_Controller_View $view The view to add.
  144.      *
  145.      * @return ForwardFW_Controller_Screen This Screen.
  146.      */
  147.     protected function addView(ForwardFW_Controller_View $view)
  148.     {
  149.         $this->views->append($view);
  150.         return $this;
  151.     }
  152.  
  153.     /**
  154.      * Loads the view by its Name.
  155.      *
  156.      * @param String $strView Name of the View.
  157.      *
  158.      * @return ForwardFW_Controller_View The instance of the view.
  159.      */
  160.     protected function loadView($strView)
  161.     {
  162.         $strFile = str_replace('_', '/', $strView) . '.php';
  163.         include_once $strFile;
  164.         $view = new $strView($this->application);
  165.         return $view;
  166.     }
  167.  
  168.     /**
  169.      * Returns the list of views to show.
  170.      *
  171.      * @return ArrayObject of ForwardFW_Controller_View The list of views.
  172.      */
  173.     public function getViews()
  174.     {
  175.         return $this->views;
  176.     }
  177. }
  178. ?>
Documentation generated on Sun, 30 Jan 2011 20:46:45 +0100 by phpDocumentor 1.4.3