Source for file booking.php

Documentation is available at booking.php

  1. <?php
  2. /**
  3. * Object for an individual 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. require_once 'inc/bb/configreader.php';
  18.  
  19. /** date manipulation routines */
  20. require_once 'inc/date.php';
  21. /** parent object */
  22. require_once 'timeslot.php';
  23.  
  24. /**
  25. * Object for an individual booking
  26. *
  27. * @package    Bumblebee
  28. * @subpackage Bookings
  29. */
  30. class Booking extends TimeSlot {
  31.   /** @var integer    booking id number  */
  32.   var $id;
  33.   /** @var integer    percentage discount to be applied to the booking  */
  34.   var $discount;
  35.   /** @var string     log message for the instrument log book  */
  36.   var $log;
  37.   /** @var string     log message for the booking calendar  */
  38.   var $comments;
  39.   /** @var integer    project id number  */
  40.   var $project;
  41.   /** @var integer    user id number for user that will use instrument */
  42.   var $userid;
  43.   /** @var string     username of user for user that will use instrument */
  44.   var $username;
  45.   /** @var string     full name of user for user that will use instrument */
  46.   var $name;
  47.   /** @var string     email address for user that will use instrument */
  48.   var $useremail;
  49.   /** @var string     phone number for user that will use instrument */
  50.   var $userphone;
  51.   /** @var integer    user id number for user that booked the instrument */
  52.   var $masquserid;
  53.   /** @var integer    full name of user for user that booked the instrument */
  54.   var $masquser;
  55.   /** @var string     username of user for user that booked the instrument */
  56.   var $masqusername;
  57.   /** @var string     email address for user that booked the instrument */
  58.   var $masqemail;
  59.   /** @var string     instrument name */
  60.   var $instrumentName;
  61.   /** @var string     instrument description */
  62.   var $instrumentDescription;
  63.  
  64.   /**
  65.   *  Create a booking object
  66.   *
  67.   * @param array  $arr  key => value paids
  68.   */
  69.   function Booking($arr) {
  70.     $this->TimeSlot($arr['bookwhen'], $arr['stoptime'], $arr['duration']);
  71.     $isVacant = false;
  72.     $this->id = $arr['bookid'];
  73.     $this->discount = $arr['discount'];
  74.     $this->log = $arr['log'];
  75.     $this->comments = $arr['comments'];
  76.     $this->project = $arr['project'];
  77.     $this->userid = $arr['userid'];
  78.     $this->username = $arr['username'];
  79.     $this->name = $arr['name'];
  80.     $this->useremail = $arr['email'];
  81.     $this->userphone = $arr['phone'];
  82.     $this->masquserid = $arr['masquserid'];
  83.     $this->masquser = $arr['masquser'];
  84.     $this->masqusername = $arr['masqusername'];
  85.     $this->masqemail = $arr['masqemail'];
  86.     $this->instrumentName = $arr['instrumentname'];
  87.     $this->instrumentDescription = $arr['instrumentdescription'];
  88.  
  89.     #echo "Booking from ".$this->start->dateTimeString()." to ".$this->stop->dateTimeString()."<br />\n";
  90.     $this->baseclass='booking';
  91.   }
  92.  
  93.   /**
  94.   * display the booking as a list of settings
  95.   *
  96.   * @param boolean   $displayAdmin   show admin-only information (discount etc)
  97.   * @param boolean   $displayOwner   show owner-only information (project etc)
  98.   * @return string html representation of booking
  99.   */
  100.   function display($displayAdmin, $displayOwner) {
  101.     return $this->displayInTable(2, $displayAdmin, $displayOwner);
  102.   }
  103.  
  104.   /**
  105.   * display the booking as a list of settings
  106.   *
  107.   * @param boolean   $displayAdmin   show admin-only information (discount etc)
  108.   * @param boolean   $displayOwner   show owner-only information (project etc)
  109.   * @return string html representation of booking
  110.   */
  111.   function displayInTable($cols, $displayAdmin, $displayOwner) {
  112.     $t = '<tr><td>'.T_('Booking ID').'</td><td>'.$this->id.'</td></tr>'."\n"
  113.        . '<tr><td>'.T_('Start').'</td><td>'.$this->start->getShortDateTimeString().'</td></tr>'."\n"
  114.         . '<tr><td>'.T_('Stop').'</td><td>'.$this->stop->getShortDateTimeString().'</td></tr>'."\n"
  115.         . '<tr><td>'.T_('Duration').'</td><td>'.$this->duration->getShortString()/*.$bookinglength*/.'</td></tr>'."\n"
  116.        . '<tr><td>'.T_('User').'</td><td><a href="mailto:'.xssqw($this->useremail).'">'.xssqw($this->name).'</a> ('.xssqw($this->username).')</td></tr>'."\n"
  117.        . '<tr><td>'.T_('Comments').'</td><td>'.xssqw($this->comments).'</td></tr>'."\n"
  118.        . '<tr><td>'.T_('Log').'</td><td>'.xssqw($this->log).'</td></tr>'."\n";
  119.     if ($displayAdmin) {
  120.       if ($this->masquser) {
  121.         $t .= '<tr><td>'.T_('Booked by').'</td><td><a href="mailto:'.xssqw($this->masqemail).'">'.xssqw($this->masquser).'</a> ('.xssqw($this->masqusername).')</td></tr>'."\n";
  122.       }
  123.     }
  124.     if ($displayAdmin || $displayOwner) {
  125.       $t .= '<tr><td>'.T_('Project').'</td><td>'.xssqw($this->project).'</td></tr>'."\n";
  126.       if ($this->discount) {
  127.         $t .= '<tr><td>'.T_('Discount').'</td><td>'.xssqw($this->discount).'</td></tr>'."\n";
  128.       }
  129.     }
  130.     return $t;
  131.   }
  132.  
  133.   /**
  134.   * display the booking as a single cell in a calendar
  135.   *
  136.   * @return string html representation of booking
  137.   */
  138.   function displayInCell(/*$isadmin=0*/) {
  139.     $conf = ConfigReader::getInstance();
  140.     $BasePath = $conf->BasePath;
  141.     $start = isset($this->displayStart) ? $this->displayStart : $this->start;
  142.     $stop  = isset($this->displayStop)  ? $this->displayStop  : $this->stop;
  143.     if ($this->freeBusyOnly) {
  144.       static $freeBusyStr = null;
  145.       static $busyStr = null;
  146.       if ($freeBusyStr === null) {
  147.         $freeBusyStr = T_('Busy from %s to %s');
  148.         $busyStr     = T_('busy');
  149.       }
  150.       $timedescription = sprintf($freeBusyStr, $start->getShortDateTimeString(), $stop->shortDateTimeString());
  151.       return "<div title='$timedescription'>$busyStr</div>";
  152.     }
  153.     static $viewEditStr = null;
  154.     if ($viewEditStr === null) $viewEditStr = T_('View or edit booking from %s to %s');
  155.     $timedescription = sprintf($viewEditStr, $start->getShortDateTimeString(), $stop->getShortDateTimeString());
  156.     //$timedescription = $this->start->timeString().' - '.$this->stop->timeString();
  157.     $isodate = $start->dateString();
  158.     $t = '';
  159.     $t .= "<div style='float:right;'><a href='$this->href&amp;isodate=$isodate&amp;bookid=$this->id' "
  160.               ."title='$timedescription' class='but'><img src='$BasePath/theme/images/editbooking.png' "
  161.               ."alt='$timedescription' class='calicon' /></a></div>";
  162.     // Finally include details of the booking:
  163.     $t .= '<div class="calbookperson">'
  164.          .'<a href="mailto:'.xssqw($this->useremail).'">'
  165.          .xssqw($this->name).'</a></div>';
  166.     if ($conf->value('calendar', 'showphone', false)) {
  167.       $t .= '<div class="calphone">'
  168.           .xssqw($this->userphone)
  169.           .'</div>';
  170.     }
  171.     if ($this->comments) {
  172.       $t .= '<div class="calcomment">'
  173.           .xssqw($this->comments)
  174.           .'</div>';
  175.     }
  176.     return $t;
  177.   }
  178.  
  179.   /**
  180.   * work out the title (start and stop times) for the booking for display
  181.   *
  182.   * @return string title
  183.   */
  184.   function generateBookingTitle() {
  185.     static $bookingStr = null;
  186.     if ($bookingStr === null) $bookingStr = T_('Booking from %s - %s');
  187.  
  188.     $start = isset($this->displayStart) ? $this->displayStart : $this->start;
  189.     $stop  = isset($this->displayStop)  ? $this->displayStop  : $this->stop;
  190.     return sprintf($bookingStr, $start->getShortDateTimeString(), $stop->getShortDateTimeString());
  191.   }
  192.  
  193.   /**
  194.   * construct a long description of the time slot for pop-ups
  195.   *
  196.   * @return string description
  197.   */
  198.   function generateLongDescription($short=false) {
  199.     $s = '';
  200.     if (! $short && isset($this->children) && is_array($this->children)) {
  201.       $list = array();
  202.       foreach ($this->children as $b) {
  203.         $list[] = $b->generateLongDescription(true);
  204.       }
  205.       #print $s;
  206.       $s = '<table class="popup">'. join($list, "") .'</table>';
  207.     } elseif ($short) {
  208.       $instrument = $this->instrumentName;
  209.       $user = $this->name;
  210.       $start = isset($this->displayStart) ? $this->displayStart : $this->start;
  211.       $stop  = isset($this->displayStop)  ? $this->displayStop  : $this->stop;
  212.       $starttime = $start->getShortTimeString();
  213.       $stoptime  = $stop->getShortTimeString();
  214.       $s = "<tr><td>$instrument</td><td>$user</td><td>$starttime</td><td>$stoptime</td></tr>";
  215.     } else {
  216.       $s = '<table class="popup">'. $this->displayInTable(2, false, false) .'</table>';
  217.     }
  218.  
  219.     #print $s;
  220.     return $s;
  221.   }
  222.  

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