includes/mod_roomReservationControl.inc

   1 <?php
   2 /**
   3  * @file mod_roomReservationControl.inc
   4  * Class that represents an abstract control
   5  * @author Roland Hieber (roland.hieber@wilhelm-gym.net)
   6  * @date 25.07.2008
   7  *
   8  * Copyright © 2007 Roland Hieber
   9  *
  10  * Permission is hereby granted, free of charge, to any person obtaining
  11  * copy of this software and associated documentation files (the "Software"),
  12  * to deal in the Software without restriction, including without limitation
  13  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
  14  * and/or sell copies of the Software, and to permit persons to whom the
  15  * Software is furnished to do so, subject to the following conditions:
  16  *
  17  * The above copyright notice and this permission notice shall be included in
  18  * all copies or substantial portions of the Software.
  19  *
  20  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  21  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  22  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  23  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  24  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  25  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  26  * THE SOFTWARE.
  27  */
  28
  29 require_once("quote.inc");
  30 require_once("functions.inc");
  31
  32 /** @todo document */
  33 abstract class mod_roomReservationControl {
  34   /** (array of strings) Errors that occur while processing the form */
  35   protected $asMessages;
  36   /** (mod_roomReservationConfig) Reference to the configuration object */
  37   protected $oCfg;
  38
  39   /***************************************************************************/
  40   /**
  41    * @name Constructor
  42    * @{
  43    * Constructor
  44    * @param $oCfg (reference to mod_roomReservationConfig) Reference to the
  45    *  configuration
  46    * @return mod_roomReservationBookingTable
  47    */
  48   public function __construct(mod_roomReservationConfig &$oCfg) {
  49     rrAddCss(".blue .treeview .err { color:red !important; }");
  50     $this->oCfg = $oCfg;
  51     $this->processRequestVariables();
  52   }
  53
  54   /***************************************************************************/
  55   /**
  56    * @}
  57    * @name Initialization
  58    * @{
  59    */
  60
  61   /**
  62    * Process the REQUEST variables and preset the some variables
  63    * @return void
  64    */
  65   protected function processRequestVariables() { }
  66
  67   /***************************************************************************/
  68   /**
  69    * @}
  70    * @name Output
  71    * @{
  72    */
  73
  74   /**
  75    * Get the messages that have been produced. Returns HTML.
  76    * @return string
  77    */
  78   protected function getMessages() {
  79     if(count($this->asMessages) > 0) {
  80       return sprintf("<div class='err'>%s</p>\n",
  81         nl2br(q(join("\n", $this->asMessages))));
  82     }
  83   }
  84
  85   /**
  86    * Show the beginning of the control.
  87    * @return void
  88    */
  89   protected function beginShow() { }
  90
  91   /**
  92    * Show the control. Override this function to print your HTML code.
  93    * @return void
  94    */
  95   protected abstract function doShow();
  96
  97   /**
  98    * Show the end of the control.
  99    * @return void
 100    */
 101   protected function endShow() { }
 102
 103   /**
 104    * Show the full control. You don't need to override this function. Instead,
 105    * override doShow().
 106    * @return void
 107    */
 108   public function show() {
 109     $this->beginShow();
 110     $this->doShow();
 111     $this->endShow();
 112   }
 113 }
 114 ?>