inc/mod_roomReservationRoom.inc

   1 <?php
   2 /**
   3  * @file mod_roomReservationRoom.inc
   4  * Container class for the representation of a room
   5  * @author Roland Hieber (roland.hieber@wilhelm-gym.net)
   6  * @date 28.12.2007
   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 /**
  30  * Container class for the representation of a room
  31  */
  32 class mod_roomReservationRoom {
  33
  34   /** (string) Name of the room */
  35   protected $strName;
  36   /** (string) Room number */
  37   protected $strRoomNo;
  38   /** (string) Floor */
  39   protected $strFloor;
  40   /** (string) Building */
  41   protected $strBuilding;
  42   /** (string) Location */
  43   protected $strLocation;
  44
  45   /***************************************************************************/
  46   /**
  47    * @name Constructor
  48    * @{
  49    * Constructor.
  50    * @param $strName (string) Name of the room
  51    * @return rmRoom
  52    */
  53   public function __construct($strName, $strRoomNo = "", $strFloor = "",
  54     $strBuilding = "", $strLocation = "") {
  55     $this->setName($strName);
  56     $this->setRoomNo($strRoomNo);
  57     $this->setFloor($strFloor);
  58     $this->setBuilding($strBuilding);
  59     $this->setLocation($strLocation);
  60   }
  61
  62   /***************************************************************************/
  63   /**
  64    * @}
  65    * @name Access to attributes
  66    * @{
  67    */
  68
  69   /**
  70    * Set the name of the room
  71    * @param $str (string)
  72    * @return void
  73    */
  74   public function setName($str) { $this->strName = $str; }
  75
  76   /**
  77    * Set the room number
  78    * @param $str (string)
  79    * @return void
  80    */
  81   public function setRoomNo($str) { $this->strRoomNo = $str; }
  82
  83   /**
  84    * Set the floor
  85    * @param $str (string)
  86    * @return void
  87    */
  88   public function setFloor($str) { $this->strFloor = $str; }
  89
  90   /**
  91    * Set the building
  92    * @param $str (string)
  93    * @return void
  94    */
  95   public function setBuilding($str) { $this->strBuilding = $str; }
  96
  97   /**
  98    * Set the location
  99    * @param $str (string)
 100    * @return void
 101    */
 102   public function setLocation($str) { $this->strLocation = $str; }
 103
 104   /**
 105    * Get the name of the room
 106    * @return string
 107    */
 108   public function getName() { return $this->strName; }
 109
 110   /**
 111    * Get the room number
 112    * @return string
 113    */
 114   public function geRoomNo() { return $this->strRoomNo; }
 115
 116   /**
 117    * Get the floor
 118    * @return string
 119    */
 120   public function getFloor() { return $this->strFloor; }
 121
 122   /**
 123    * Get the building
 124    * @return string
 125    */
 126   public function getBuilding() { return $this->strBuilding; }
 127
 128   /**
 129    * Get the location
 130    * @return string
 131    */
 132   public function getLocation() { return $this->strLocation; }
 133
 134   /**
 135    * Conversion to string
 136    * @return string
 137    */
 138   public function __toString() { return $this->getName(); /* name is key */ }
 139   /**@}*/
 140 }
 141 ?>