Source for file timeslot.php

Documentation is available at timeslot.php

  1. <?php
  2. /**
  3. * Booking/Vacancy base object -- designed to be inherited by Vacancy and Booking
  4. *
  5. * @author    Stuart Prescott
  6. * @copyright  Copyright Stuart Prescott
  7. * @license    http://opensource.org/licenses/gpl-license.php GNU Public License
  8. * @version    $Id$
  9. * @package    Bumblebee
  10. * @subpackage Bookings
  11. */
  12.  
  13. /** Load ancillary functions */
  14. require_once 'inc/typeinfo.php';
  15. checkValidInclude();
  16.  
  17. /** date manipulation routines */
  18. require_once 'inc/date.php';
  19.  
  20. /**
  21. * Booking/Vacancy base object -- designed to be inherited by Vacancy and Booking
  22. *
  23. * @package    Bumblebee
  24. * @subpackage Bookings
  25. */
  26. class TimeSlot {
  27.   /** @var SimpleDate   start of the slot as used for calculating graphical representation   */
  28.   var $start;
  29.   /** @var SimpleDate   end of the slot as used for calculating graphical representation  */
  30.   var $stop;
  31.   /** @var SimpleDate   date the start is on (i.e. $start with time of 00:00:00)   */
  32.   var $_dayStart = NULL;
  33.   /** @var SimpleDate   date the end is on (i.e. $stop with time of 00:00:00)  */
  34.   var $_dayStop = NULL;
  35.   /** @var SimpleTime   unused?  */
  36.   var $duration;
  37.   /** @var string       href to current page */
  38.   var $href = '';
  39.   /** @var string       html/css class to use for display */
  40.   var $baseclass;
  41.   /** @var boolean      time slot is disabled (instrument is unavailable)  */
  42.   var $isDisabled=0;
  43.   /** @var boolean      instrument is vacant  */
  44.   var $isVacant = 0;
  45.   /** @var boolean      timeslot is the start of a booking (bookings can go fro mone day to another)  */
  46.   var $isStart = 0;
  47.   /** @var SimpleDate   start of the slot for when time should be displayed   */
  48.   var $displayStart;
  49.   /** @var SimpleDate   end of the slot for when time should be displayed  */
  50.   var $displayStop;
  51.   /** @var boolean      start time is arbitrary from truncation due to db lookup */
  52.   var $arb_start = false;
  53.   /** @var boolean      stop time is arbitrary from truncation due to db lookup */
  54.   var $arb_stop  = false;
  55.   /** @var TimeSlotRule timeslot definitions */
  56.   var $slotRule;
  57.   /** @var boolean      only show free/busy information for the slot */
  58.   var $freeBusyOnly = false;
  59.  
  60.   /**
  61.   *  Create a new timeslot to be superclassed by Booking or Vacancy object
  62.   *
  63.   * @param mixed  $start    start time and date (SimpleDate or string or ticks)
  64.   * @param mixed  $stop     stop time and date (SimpleDate or string or ticks)
  65.   * @param mixed  $duration duration of the slot (SimpleTime or string or ticks, 0 to autocalc)
  66.   */
  67.   function TimeSlot($start, $stop, $duration=0) {
  68.     $this->start = new SimpleDate($start);
  69.     $this->stop = new SimpleDate($stop);
  70.     if ($duration==0) {
  71.       $this->duration = new SimpleTime($this->stop->ticks - $this->start->ticks);
  72.     } else {
  73.       $this->duration = new SimpleTime($duration);
  74.     }
  75.   }
  76.  
  77.   /**
  78.   *  Set the start/stop times of the slot
  79.   *
  80.   * @param SimpleDate  $start    start time and date
  81.   * @param SimpleDate  $stop     stop time and date
  82.   * @param SimpleTime  $duration duration of the slot
  83.   */
  84.   function _TimeSlot_SimpleDate($start, $stop, $duration) {
  85.     $this->start = $start;
  86.     $this->stop = $stop;
  87.     $this->duration = $duration;
  88.   }
  89.  
  90.   /**
  91.   * display the timeslot as a short table row
  92.   */
  93.   function displayShort() {
  94.     return '<tr><td>'.get_class($this)
  95.             .'</td><td>'.$this->start->dateTimeString()
  96.             .'</td><td>'.$this->stop->dateTimeString()
  97.             .'</td><td>'.(is_object($this->displayStart) ? $this->displayStart->dateTimeString() : 'NULL')
  98.             .'</td><td>'.(is_object($this->displayStop)  ? $this->displayStop->dateTimeString()  : 'NULL')
  99.             .'</td><td>'.$this->isStart
  100.             .'</td></tr>'."\n";
  101.   }
  102.  
  103.   function dayStart() {
  104.     if ($this->_dayStart !== NULL) {
  105.       #echo "start hit ";
  106.       return $this->_dayStart;
  107.     }
  108.       #echo "start miss ";
  109.     $this->_dayStart = clone($this->start);
  110.     $this->_dayStart->dayRound();
  111.     return $this->_dayStart;
  112.   }
  113.  
  114.   function dayStop() {
  115.     if ($this->_dayStop !== NULL) {
  116.       #echo "stop hit ";
  117.       return $this->_dayStop;
  118.     }
  119.       #echo "stop miss ";
  120.     $this->_dayStop = clone($this->stop);
  121.     $this->_dayStop->dayRound();
  122.     return $this->_dayStop;
  123.   }
  124.  
  125.   /**
  126.   * construct a long description of the time slot for pop-ups
  127.   *
  128.   * @return string description
  129.   */
  130.   function generateLongDescription() {
  131.     return "";
  132.   }
  133.  
  134.   /**
  135.   * work out the title (start and stop times) for the vacancy for display
  136.   *
  137.   * @return string title
  138.   */
  139.   function generateBookingTitle() {
  140.     return "";
  141.   }
  142.  

Documentation generated on Tue, 06 Mar 2007 10:02:03 +0000 by phpDocumentor 1.3.0