Source for file instrument.php

Documentation is available at instrument.php

  1. <?php
  2. /**
  3. * Instrument object (extends dbo), with extra customisations for other links
  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 DBObjects
  11. */
  12.  
  13. /** Load ancillary functions */
  14. require_once 'inc/typeinfo.php';
  15. checkValidInclude();
  16.  
  17. require_once 'inc/bb/configreader.php';
  18.  
  19. /** parent object */
  20. require_once 'inc/formslib/dbrow.php';
  21. require_once 'inc/formslib/idfield.php';
  22. require_once 'inc/formslib/textfield.php';
  23. require_once 'inc/formslib/textarea.php';
  24. require_once 'inc/formslib/commentfield.php';
  25. require_once 'inc/formslib/checkbox.php';
  26. require_once 'inc/formslib/radiolist.php';
  27. require_once 'inc/formslib/exampleentries.php';
  28. require_once 'inc/bookings/timeslotrule.php';
  29.  
  30. /**
  31. * Instrument object (extends dbo), with extra customisations for other links
  32. *
  33. * @package    Bumblebee
  34. * @subpackage DBObjects
  35. */
  36. class Instrument extends DBRow {
  37.  
  38.   var $_slotrule;
  39.  
  40.   function Instrument($id) {
  41.     $conf = ConfigReader::getInstance();
  42.     //$this->DEBUG=10;
  43.     $this->DBRow('instruments', $id);
  44.     $this->editable = 1;
  45.     $this->deleteFromTable = 0;
  46.     $f = new IdField('id', T_('Instrument ID'));
  47.     $f->editable = 0;
  48.     $this->addElement($f);
  49.     $f = new TextField('name', T_('Name'));
  50.     $attrs = array('size' => '48');
  51.     $f->required = 1;
  52.     $f->isValidTest = 'is_nonempty_string';
  53.     $f->setAttr($attrs);
  54.     $this->addElement($f);
  55.     $f = new TextField('longname', T_('Description'));
  56.     $f->required = 1;
  57.     $f->isValidTest = 'is_nonempty_string';
  58.     $f->setAttr($attrs);
  59.     $this->addElement($f);
  60.     $f = new TextField('location', T_('Location'));
  61.     $f->required = 1;
  62.     $f->isValidTest = 'is_nonempty_string';
  63.     $f->setAttr($attrs);
  64.     $this->addElement($f);
  65.     $f = new TextField('usualopen', T_('Calendar start time (HH:MM)'));
  66.     $f->required = 1;
  67.     $f->defaultValue = $conf->value('instruments', 'usualopen');
  68.     $f->isValidTest = 'is_valid_time';
  69.     $f->setAttr($attrs);
  70.     $this->addElement($f);
  71.     $f = new TextField('usualclose', T_('Calendar end time (HH:MM)'));
  72.     $f->required = 1;
  73.     $f->defaultValue = $conf->value('instruments', 'usualclose');
  74.     $f->isValidTest = 'is_valid_time';
  75.     $f->setAttr($attrs);
  76.     $this->addElement($f);
  77.     $f = new TextField('calprecision', T_('Precision of calendar display (seconds)'));
  78.     $f->required = 1;
  79.     $f->defaultValue = $conf->value('instruments', 'usualprecision');
  80.     $f->isValidTest = 'is_number';
  81.     $f->setAttr($attrs);
  82.     $this->addElement($f);
  83.     $f = new TextField('caltimemarks', T_('Time-periods per HH:MM displayed'));
  84.     $f->required = 1;
  85.     $f->defaultValue = $conf->value('instruments', 'usualtimemarks');
  86.     $f->isValidTest = 'is_number';
  87.     $f->setAttr($attrs);
  88.     $this->addElement($f);
  89.     $f = new TextField('callength', T_('Number of weeks displayed in calendar'));
  90.     $f->required = 1;
  91.     $f->defaultValue = $conf->value('instruments', 'usualcallength');
  92.     $f->isValidTest = 'is_number';
  93.     $f->setAttr($attrs);
  94.     $this->addElement($f);
  95.     $f = new TextField('calhistory', T_('Number of weeks history shown'));
  96.     $f->required = 1;
  97.     $f->defaultValue = $conf->value('instruments', 'usualcalhistory');
  98.     $f->isValidTest = 'is_number';
  99.     $f->setAttr($attrs);
  100.     $this->addElement($f);
  101.     $f = new TextField('calfuture', T_('Number of days into the future'));
  102.     $f->required = 1;
  103.     $f->defaultValue = $conf->value('instruments', 'usualcalfuture');
  104.     $f->isValidTest = 'is_number';
  105.     $f->setAttr($attrs);
  106.     $this->addElement($f);
  107.     $f = new TextArea('calendarcomment', T_('Advisory text'),
  108.           T_('Displayed at the bottom of instrument calendar and on booking form. HTML permitted.'));
  109.     $f->setAttr(array('rows' =>5, 'cols' => 30));
  110.     $f->required = 0;
  111.     $this->addElement($f);
  112.  
  113.     // associate with a charging class
  114.     $f = new RadioList('class', T_('Charging class'));
  115.     $f->connectDB('instrumentclass', array('id', 'name'));
  116.     $classexample = new ExampleEntries('id','instruments','class','name',3);
  117.     $classexample->separator = '; ';
  118.     $f->setFormat('id', '%s', array('name'), ' (%40.40s)', $classexample);
  119.     $newclassname = new TextField('name','');
  120.     $newclassname->namebase = 'newclass-';
  121.     $newclassname->setAttr(array('size' => 24));
  122.     $newclassname->isValidTest = 'is_nonempty_string';
  123.     $newclassname->suppressValidation = 0;
  124.     $f->list->append(array('-1',T_('Create new:').' '), $newclassname);
  125.     $f->setAttr($attrs);
  126.     $f->extendable = 1;
  127.     $f->required = 1;
  128.     $f->isValidTest = 'is_valid_radiochoice';
  129.     $this->addElement($f);
  130.     $f = new TextField('halfdaylength', T_('Hours in a half-day'));
  131.     $f->required = 1;
  132.     $f->defaultValue = $conf->value('instruments', 'usualhalfdaylength');
  133.     $f->isValidTest = 'is_number';
  134.     $f->setAttr($attrs);
  135.     $this->addElement($f);
  136.     $f = new TextField('fulldaylength', T_('Hours in a full-day'));
  137.     $f->required = 1;
  138.     $f->defaultValue = $conf->value('instruments', 'usualfulldaylength');
  139.     $f->isValidTest = 'is_number';
  140.     $f->setAttr($attrs);
  141.     $this->addElement($f);
  142.  
  143.     // create the timeslot rule information required
  144.     $f = new CommentField('timeslotpicturecomment', T_('Instrument timeslots'),
  145.                               T_('These fields describe when the instrument is available.'));
  146.     $f->value = T_('Format: HH:MM-HH:MM/n-x%,comment');
  147.     $this->addElement($f);
  148.     $f = new TextField('timeslotpicture', T_('Time slot picture'));
  149.     $f->required = 1;
  150.     $f->hidden = 1;
  151.     $f->defaultValue = $conf->value('instruments', 'usualtimeslotpicture');
  152.     $f->isValidTest = 'is_set';
  153.     $f->setAttr($attrs);
  154.     $this->addElement($f);
  155.     $weekstart = new SimpleDate(time());
  156.     $weekstart->weekRound();
  157.     for ($day=0; $day<7; $day++) {
  158.       $today = clone($weekstart);
  159.       $today->addDays($day);
  160.       $f = new TextArea('tsr-'.$day, $today->dowStr(), T_('Slots in day, one per line'));
  161.       $f->sqlHidden = 1;
  162.       $f->setAttr(array('rows' =>3, 'cols' => 30));
  163.       $f->required = 1;
  164.       $this->addElement($f);
  165.     }
  166.  
  167.     $f = new TextField('mindatechange', T_('Minimum notice for booking change (hours)'));
  168.     $f->required = 1;
  169.     $f->defaultValue = $conf->value('instruments', 'usualmindatechange');
  170.     $f->isValidTest = 'is_number';
  171.     $f->setAttr($attrs);
  172.     $this->addElement($f);
  173.     $f = new TextField('supervisors', T_('Instrument supervisors'), T_('comma separated list of usernames'));
  174.     $f->required = 0;
  175.     $f->setAttr($attrs);
  176.     $this->addElement($f);
  177.     $f = new CheckBox('emailonbooking', T_('Email supervisors when booking'));
  178.     $f->defaultValue = 0;
  179.     $f->setAttr($attrs);
  180.     $this->addElement($f);
  181.  
  182.     $this->fill();
  183.     $this->dumpheader = 'Instrument object';
  184.   }
  185.  
  186.   function fill() {
  187.     parent::fill();
  188.     //now edit the time slot representation fields
  189.     $this->_calcSlotRepresentation();
  190.   }
  191.  
  192.   function sync() {
  193.     //first construct a timeslot field from the submitted data, then do the sync
  194.     $newslotrule = $this->_calcNewSlotRule();
  195.     if ($this->fields['timeslotpicture']->value != $newslotrule /*&& $this->id > -1*/) {
  196.       $this->log('Instrument::sync(): indulging in timeslotrule munging: <br />'.
  197.                     $newslotrule .'<br/>'.$this->fields['timeslotpicture']->value);
  198.       $this->fields['timeslotpicture']->set($newslotrule);
  199.       $this->fields['timeslotpicture']->changed = 1;
  200.       $this->changed = $this->changed || ($this->id > -1);
  201.       // reflect back the data, this is good for checking that it's right, as TimeSlotRule
  202.       // will drop bits it doesn't understand or doesn't like.
  203.       //$this->_calcSlotRepresentation();
  204.     } else {
  205.       //?
  206.     }
  207.    //$this->DEBUG=10;
  208.    return parent::sync();
  209.   }
  210.  
  211.   function _calcSlotRepresentation() {
  212.     $this->_slotrule = new TimeSlotRule($this->fields['timeslotpicture']->getValue());
  213.     for ($day=0; $day<7; $day++) {
  214.       $this->fields['tsr-'.$day]->value = '';
  215.       //preDump($this->_slotrule->slots[$day]);
  216.       $prevpicture = '';
  217.       foreach ($this->_slotrule->slots[$day] as $key => $slot) {
  218.         if (is_numeric($key) && $slot->picture != $prevpicture) {
  219.           $prevpicture = $slot->picture;
  220.           //preDump($slot);
  221.           $this->log('Added picture '. $slot->picture);
  222.           $this->fields['tsr-'.$day]->value .= $slot->picture."\n";
  223.         }
  224.       }
  225.     }
  226.   }
  227.  
  228.   function _calcNewSlotRule() {
  229.     $newslot = '';
  230.     for ($day=0; $day<7; $day++) {
  231.       //preDump($this->fields['tsr-'.$day]->value);
  232.       $lines = preg_split('/[\n\r]+/', $this->fields['tsr-'.$day]->value);
  233.       // get rid of blanks
  234.       $lines = preg_grep('/^\s*$/', $lines, PREG_GREP_INVERT);
  235.       $rejects = preg_grep('{^\d\d:\d\d\-\d\d:\d\d/(\d+|\*)(\-\d+%)?(,.+)?$}', $lines,PREG_GREP_INVERT);
  236.       if (count($rejects) > 0) {
  237.         //then this input is invalid
  238.         $this->fields['tsr-'.$day]->isValid = 0;
  239.         $this->isValid = 0;
  240.         //preDump($rejects);
  241.       }
  242.       $newslot .= '['.$day.']<'.join($lines,';').'>';
  243.       $this->log('Calculated picture '. $newslot);
  244.     }
  245.     return $newslot;
  246.   }
  247.  
  248.   function display() {
  249.     return $this->displayAsTable();
  250.   }
  251.  

Documentation generated on Tue, 06 Mar 2007 10:01:40 +0000 by phpDocumentor 1.3.0