added new class mod_roomReservationControl (a abstract class for user defined control...

[iserv-mod-room-reservation.git] / includes / mod_roomReservationControl.inc

diff --git a/includes/mod_roomReservationControl.inc b/includes/mod_roomReservationControl.inc
new file mode 100644 (file)
index 0000000..3806137
--- /dev/null
+++ b/includes/mod_roomReservationControl.inc
@@ -0,0 +1,111 @@
+<?php
+/**\r
+ * @file mod_roomReservationControl.inc\r
+ * Class that represents an abstract control\r
+ * @author Roland Hieber (roland.hieber@wilhelm-gym.net)\r
+ * @date 25.07.2008\r
+ * \r
+ * Copyright © 2007 Roland Hieber\r
+ *\r
+ * Permission is hereby granted, free of charge, to any person obtaining\r
+ * copy of this software and associated documentation files (the "Software"),\r
+ * to deal in the Software without restriction, including without limitation\r
+ * the rights to use, copy, modify, merge, publish, distribute, sublicense,\r
+ * and/or sell copies of the Software, and to permit persons to whom the\r
+ * Software is furnished to do so, subject to the following conditions:\r
+ * \r
+ * The above copyright notice and this permission notice shall be included in\r
+ * all copies or substantial portions of the Software.\r
+ *\r
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\r
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\r
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\r
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\r
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\r
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN\r
+ * THE SOFTWARE.\r
+ */\r
+\r
+/** @todo document */
+abstract class mod_roomReservationControl {
+  /** (array of strings) Errors that occur while processing the form */ 
+  protected $asMessages;
+  /** (mod_roomReservationConfig) Reference to the configuration object */
+  protected $oCfg;
+  
+  /***************************************************************************/
+  /**
+   * @name Constructor
+   * @{
+   * Constructor
+   * @param $oCfg (reference to mod_roomReservationConfig) Reference to the
+   *  configuration
+   * @return mod_roomReservationBookingTable
+   */
+  public function __construct(mod_roomReservationConfig &$oCfg) {
+    rrAddCss(".blue .treeview .err { color:red !important; }");
+    $this->oCfg = $oCfg;
+    $this->processRequestVariables();
+  }
+ 
+  /***************************************************************************/
+  /**
+   * @}
+   * @name Initialization
+   * @{
+   */
+
+  /**
+   * Process the REQUEST variables and preset the some variables
+   * @return void
+   */
+  protected function processRequestVariables() { }
+  
+  /***************************************************************************/
+  /**
+   * @}
+   * @name Output
+   * @{
+   */
+
+  /**
+   * Get the messages that have been produced. Returns HTML.
+   * @return string
+   */
+  protected function getMessages() {
+    if(count($this->asMessages) > 0) {
+      return sprintf("<div class='err'>%s</p>\n",
+        nl2br(q(join("\n", $this->asMessages))));
+    }
+  }
+
+  /**
+   * Show the beginning of the control.
+   * @return void
+   */
+  protected function beginShow() { }
+  
+  /**
+   * Show the control. Override this function to print your HTML code.
+   * @return void
+   */
+  protected abstract function doShow();
+  
+  /**
+   * Show the end of the control.
+   * @return void
+   */
+  protected function endShow() { }
+
+  /**
+   * Show the full control. You don't need to override this function. Instead,
+   * override doShow(). 
+   * @return void
+   */
+  public function show() {
+    $this->beginShow();
+    $this->doShow();
+    $this->endShow();
+  }
+}
+?>
\ No newline at end of file