Source for file bookingdata.php

Documentation is available at bookingdata.php

  1. <?php
  2. /**
  3. * Obtains booking data from the database
  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. /** loads data into Booking objects */
  18. require_once 'booking.php';
  19.  
  20. /**
  21. * Obtains booking data from the database
  22. *
  23. * Can be used either to find all bookings that are within a time period
  24. * or to look for a specific booking id. Note that when using time periods
  25. * to define the query, a booking is within the query time if *any* part of
  26. * the booking period overlaps with *any* part of the query period.
  27. *
  28. * Can optionally exclude deleted bookings from the list.
  29. *
  30. * @package    Bumblebee
  31. * @subpackage Bookings
  32. */
  33. class BookingData {
  34.   /** @var string   start of the query (SQL date-time string)  */
  35.   var $start;
  36.   /** @var string   stop of the query (SQL date-time string)  */
  37.   var $stop;
  38.   /** @var integer  instrument id number of interest  */
  39.   var $instrument;
  40.   /** @var integer  specific booking that is of interest */
  41.   var $id;
  42.   /** @var array    list of Booking objects returned for time period */
  43.   var $bookinglist;
  44.   /** @var Booking  single Booking object returned for id match */
  45.   var $booking;
  46.   /** @var boolean  sql errors are fatal */
  47.   var $fatal_sql = 1;
  48.   /** @var boolean  include deleted bookings in listing */
  49.   var $includeDeleted = 0;
  50.  
  51.   /**
  52.   * Obtain the booking listing within defined parameters
  53.   *
  54.   * @param array  $arr    data => value pairs where data can be
  55.   *                        start, stop, instrument, id
  56.   */
  57.   function BookingData($arr, $includeDeleted=false) {
  58.     if ($start = issetSet($arr,'start')) {
  59.       $this->start = $start->dateTimeString();
  60.     }
  61.     if ($stop = issetSet($arr,'stop')) {
  62.       $this->stop = $stop->dateTimeString();
  63.     }
  64.     $this->instrument  = issetSet($arr,'instrument');
  65.     $this->id  = issetSet($arr,'id');
  66.     $this->includeDeleted = $includeDeleted;
  67.     $this->_fill();
  68.   }
  69.  
  70.   /**
  71.   * Interrogate the database to get the bookings
  72.   *
  73.   * @global string  prefix prepended to all table names in database
  74.   */
  75.   function _fill() {
  76.     global $TABLEPREFIX;
  77.     $q = 'SELECT bookings.id AS bookid,bookwhen,duration,'
  78.         .'DATE_ADD(bookwhen, INTERVAL duration HOUR_SECOND) AS stoptime,'
  79.         .'discount,log,comments,projectid,'
  80.         .'userid,'
  81.         .'users.name AS name, '
  82.         .'users.username AS username, '
  83.         .'users.email AS email, '
  84.         .'users.phone AS phone, '
  85.         .'bookedby AS masquserid, '
  86.         .'masq.name AS masquser, '
  87.         .'masq.username AS masqusername, '
  88.         .'masq.email AS masqemail, '
  89.         .'projects.name AS project, '
  90.         .'instruments.name AS instrumentname, '
  91.         .'instruments.longname AS instrumentdescription '
  92.         .'FROM '.$TABLEPREFIX.'bookings AS bookings '
  93.         .'LEFT JOIN '.$TABLEPREFIX.'users AS users ON '
  94.             .'bookings.userid=users.id '
  95.         .'LEFT JOIN '.$TABLEPREFIX.'users AS masq ON '
  96.             .'bookings.bookedby=masq.id '
  97.         .'LEFT JOIN '.$TABLEPREFIX.'projects AS projects ON '
  98.             .'bookings.projectid=projects.id '
  99.         .'LEFT JOIN '.$TABLEPREFIX.'instruments AS instruments ON '
  100.             .'bookings.instrument=instruments.id '
  101.         .'WHERE '.($this->includeDeleted ? '' : 'bookings.deleted<>1 AND ');
  102.     if ($this->id) {
  103.       $q .= 'bookings.id='.qw($this->id);
  104.     } else {
  105.       $q .= 'bookings.userid<>0 AND ';
  106.       if (is_array($this->instrument)) {
  107.         $q .= 'bookings.instrument IN ('.join(array_qw($this->instrument),',').') ';
  108.       } else {
  109.         $q .= 'bookings.instrument='.qw($this->instrument).' ';
  110.       }
  111.  
  112.       $q .= 'HAVING (bookwhen <= '.qw($this->start).' AND stoptime > '.qw($this->start).') '
  113.             .'OR (bookwhen < '.qw($this->stop).' AND stoptime >= '.qw($this->stop).') '
  114.             .'OR (bookwhen >= '.qw($this->start).' AND stoptime <= '.qw($this->stop).')'
  115.            .' ORDER BY bookwhen';
  116.       if (is_array($this->instrument)) {
  117.         $q .= ', duration DESC';
  118.       }
  119.     }
  120.  
  121.     if ($this->id) {
  122.       $g = db_get_single($q, $this->fatal_sql);
  123.       $this->booking = new Booking($g);
  124.     } else {
  125.       $this->bookinglist = array();
  126.       $sql = db_get($q, $this->fatal_sql);
  127.       while ($g = db_fetch_array($sql)) {
  128.         $this->bookinglist[] = new Booking($g);
  129.       }
  130.     }
  131.   }
  132.  
  133.   /**
  134.   * obtain the list of bookings
  135.   * @return array  list of Booking objects
  136.   */
  137.   function dataArray() {
  138.     return $this->bookinglist;
  139.   }
  140.  
  141.   /**
  142.   * obtain the bookings
  143.   * @return Booking booking object
  144.   */
  145.   function dataEntry() {
  146.     return $this->booking;
  147.   }
  148.  
  149. } //class BookingData
  150.  
  151. /**
  152. * Find the next booking already in the database
  153. *
  154. * @package    Bumblebee
  155. * @subpackage Bookings
  156. */
  157. class NextBooking {
  158.   /** @var string   start of the query (SQL date-time string)  */
  159.   var $start;
  160.   /** @var mixed    instrument id number or list of ids of interest  */
  161.   var $instrument;
  162.   /** @var SimpleDate  start of the next booking (null if none) */
  163.   var $booking = null;
  164.   /** @var boolean  sql errors are fatal */
  165.   var $fatal_sql = 1;
  166.   /** @var boolean  include deleted bookings in listing */
  167.   var $includeDeleted = 0;
  168.  
  169.   /**
  170.   * Obtain the booking listing within defined parameters
  171.   *
  172.   * @param SimpleDate  $start       start date for searching for the next booking
  173.   * @param mixed       $instrument  id for the instrument to check or list of ids
  174.   */
  175.   function NextBooking($start, $instrument) {
  176.     $s = new SimpleDate($start);
  177.     $this->start       = $s->dateTimeString();
  178.     $this->instrument  = $instrument;
  179.     $this->_fill();
  180.   }
  181.  
  182.   /**
  183.   * Interrogate the database to get the bookings
  184.   *
  185.   * @global string  prefix prepended to all table names in database
  186.   */
  187.   function _fill() {
  188.     global $TABLEPREFIX;
  189.     $q = 'SELECT bookings.id AS bookid, '
  190.         .'bookwhen '
  191.         .'FROM '.$TABLEPREFIX.'bookings AS bookings '
  192.         .'WHERE bookings.userid<>0 AND ';
  193.     if (is_array($this->instrument)) {
  194.       $q .= 'bookings.instrument IN ('.join(array_qw($this->instrument),',').') ';
  195.     } else {
  196.       $q .= 'bookings.instrument='.qw($this->instrument).' ';
  197.     }
  198.     $q .= 'AND bookwhen > '.qw($this->start).' '
  199.         .'ORDER BY bookwhen '
  200.         .'LIMIT 1';
  201.  
  202.     $g = db_get_single($q, $this->fatal_sql);
  203.     if (is_array($g)) {
  204.       $this->booking = new SimpleDate($g['bookwhen']);
  205.     }
  206.   }
  207.  

Documentation generated on Tue, 06 Mar 2007 10:00:48 +0000 by phpDocumentor 1.3.0