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 /** @todo document */
  30 abstract class mod_roomReservationControl {
  31   /** (array of strings) Errors that occur while processing the form */
  32   protected $asMessages;
  33   /** (mod_roomReservationConfig) Reference to the configuration object */
  34   protected $oCfg;
  35
  36   /***************************************************************************/
  37   /**
  38    * @name Constructor
  39    * @{
  40    * Constructor
  41    * @param $oCfg (reference to mod_roomReservationConfig) Reference to the
  42    *  configuration
  43    * @return mod_roomReservationBookingTable
  44    */
  45   public function __construct(mod_roomReservationConfig &$oCfg) {
  46     rrAddCss(".blue .treeview .err { color:red !important; }");
  47     $this->oCfg = $oCfg;
  48     $this->processRequestVariables();
  49   }
  50
  51   /***************************************************************************/
  52   /**
  53    * @}
  54    * @name Initialization
  55    * @{
  56    */
  57
  58   /**
  59    * Process the REQUEST variables and preset the some variables
  60    * @return void
  61    */
  62   protected function processRequestVariables() { }
  63
  64   /***************************************************************************/
  65   /**
  66    * @}
  67    * @name Output
  68    * @{
  69    */
  70
  71   /**
  72    * Get the messages that have been produced. Returns HTML.
  73    * @return string
  74    */
  75   protected function getMessages() {
  76     if(count($this->asMessages) > 0) {
  77       return sprintf("<div class='err'>%s</p>\n",
  78         nl2br(q(join("\n", $this->asMessages))));
  79     }
  80   }
  81
  82   /**
  83    * Show the beginning of the control.
  84    * @return void
  85    */
  86   protected function beginShow() { }
  87
  88   /**
  89    * Show the control. Override this function to print your HTML code.
  90    * @return void
  91    */
  92   protected abstract function doShow();
  93
  94   /**
  95    * Show the end of the control.
  96    * @return void
  97    */
  98   protected function endShow() { }
  99
 100   /**
 101    * Show the full control. You don't need to override this function. Instead,
 102    * override doShow().
 103    * @return void
 104    */
 105   public function show() {
 106     $this->beginShow();
 107     $this->doShow();
 108     $this->endShow();
 109   }
 110 }
 111 ?>