typo3/sysext/extbase/Classes/MVC/View/EmptyView.php

   1 <?php
   2 /***************************************************************
   3 *  Copyright notice
   4 *
   5 *  (c) 2009 Jochen Rau <jochen.rau@typoplanet.de>
   6 *  All rights reserved
   7 *
   8 *  This class is a backport of the corresponding class of FLOW3.
   9 *  All credits go to the v5 team.
  10 *
  11 *  This script is part of the TYPO3 project. The TYPO3 project is
  12 *  free software; you can redistribute it and/or modify
  13 *  it under the terms of the GNU General Public License as published by
  14 *  the Free Software Foundation; either version 2 of the License, or
  15 *  (at your option) any later version.
  16 *
  17 *  The GNU General Public License can be found at
  18 *  http://www.gnu.org/copyleft/gpl.html.
  19 *
  20 *  This script is distributed in the hope that it will be useful,
  21 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  22 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  23 *  GNU General Public License for more details.
  24 *
  25 *  This copyright notice MUST APPEAR in all copies of the script!
  26 ***************************************************************/
  27
  28 /**
  29  * An empty view - a special case.
  30  *
  31  * @package Extbase
  32  * @subpackage MVC\View
  33  * @version $Id$
  34  * @license http://www.gnu.org/licenses/lgpl.html GNU Lesser General Public License, version 3 or later
  35  */
  36 final class Tx_Extbase_MVC_View_EmptyView implements Tx_Extbase_MVC_View_ViewInterface {
  37
  38         /**
  39          * Dummy method to satisfy the ViewInterface
  40          *
  41          * @param Tx_Extbase_MVC_Controller_ControllerContext $controllerContext
  42          * @return void
  43          */
  44         public function setControllerContext(Tx_Extbase_MVC_Controller_ControllerContext $controllerContext) {
  45         }
  46
  47         /**
  48          * Dummy method to satisfy the ViewInterface
  49          *
  50          * @param string $key
  51          * @param mixed $value
  52          * @return Tx_Extbase_MVC_View_EmptyView instance of $this to allow chaining
  53          * @api
  54          */
  55         public function assign($key, $value) {
  56                 return $this;
  57         }
  58
  59         /**
  60          * Dummy method to satisfy the ViewInterface
  61          *
  62          * @param array $values
  63          * @return Tx_Extbase_MVC_View_EmptyView instance of $this to allow chaining
  64          * @api
  65          */
  66         public function assignMultiple(array $values) {
  67                 return $this;
  68         }
  69
  70         /**
  71          * This view can be used in any case.
  72          *
  73          * @param Tx_Extbase_MVC_Controller_ControllerContext $controllerContext
  74          * @return boolean TRUE
  75          * @api
  76          */
  77         public function canRender(Tx_Extbase_MVC_Controller_ControllerContext $controllerContext) {
  78                 return TRUE;
  79         }
  80
  81         /**
  82          * Renders the empty view
  83          *
  84          * @return string An empty string
  85          */
  86         public function render() {
  87                 return '<!-- This is the output of the Empty View. An appropriate View was not found. -->';
  88         }
  89
  90         /**
  91          * A magic call method.
  92          *
  93          * Because this empty view is used as a Special Case in situations when no matching
  94          * view is available, it must be able to handle method calls which originally were
  95          * directed to another type of view. This magic method should prevent PHP from issuing
  96          * a fatal error.
  97          *
  98          * @return void
  99          */
 100         public function __call($methodName, array $arguments) {
 101         }
 102
 103         /**
 104          * Initializes this view.
 105          *
 106          * Override this method for initializing your concrete view implementation.
 107          *
 108          * @return void
 109          * @api
 110          */
 111         public function initializeView() {
 112         }
 113 }
 114 ?>