Source for file consume.php

Documentation is available at consume.php

  1. <?php
  2. /**
  3. * Edit/create/delete consumables records
  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 Actions
  11. *
  12. *  path (bumblebee root)/inc/actions/consume.php
  13. */
  14.  
  15. /** Load ancillary functions */
  16. require_once 'inc/typeinfo.php';
  17. checkValidInclude();
  18.  
  19. /** ConsumableUse object */
  20. require_once 'inc/bb/consumableuse.php';
  21. /** Consumable object */
  22. require_once 'inc/bb/consumable.php';
  23. /** User object */
  24. require_once 'inc/bb/user.php';
  25. /** DateRange object */
  26. require_once 'inc/bb/daterange.php';
  27. /** date manipulation routines */
  28. require_once 'inc/date.php';
  29. /** list of choices */
  30. require_once 'inc/formslib/anchortablelist.php';
  31. /** parent object */
  32. require_once 'inc/actions/actionaction.php';
  33.  
  34. /**
  35. * Edit/create/delete consumables records
  36. * @package    Bumblebee
  37. * @subpackage Actions
  38. */
  39. class ActionConsume extends ActionAction {
  40.  
  41.   /**
  42.   * Initialising the class
  43.   *
  44.   * @param  BumblebeeAuth $auth  Authorisation object
  45.   * @param  array $pdata   extra state data from the call path
  46.   * @return void nothing
  47.   */
  48.   function ActionConsume($auth, $pdata) {
  49.     parent::ActionAction($auth, $pdata);
  50.     $this->mungeInputData();
  51.   }
  52.  
  53.   function go() {
  54.     if (isset($this->PD['list'])) {
  55.       $daterange = new DateRange('daterange', T_('Select date range'),
  56.                       T_('Enter the dates over which you want to report consumable use'));
  57.       $daterange->update($this->PD);
  58.       $daterange->checkValid();
  59.       if ($daterange->newObject || !$daterange->isValid) {
  60.         $daterange->setDefaults(DR_PREVIOUS, DR_QUARTER);
  61.         echo $daterange->display($this->PD);
  62.       } elseif (isset($this->PD['consumableid'])) {
  63.         $this->listConsumeConsumable($this->PD['consumableid'], $daterange);
  64.       } elseif (isset($this->PD['user'])) {
  65.         $this->listConsumeUser($this->PD['user'], $daterange);
  66.       }
  67.     } elseif (isset($this->PD['delete'])) {
  68.       if ($this->readOnly) {
  69.         $this->readOnlyError();
  70.       } else {
  71.         $this->delete();
  72.       }
  73.     } elseif (
  74.                 (! isset($this->PD['id'])) &&
  75.                 (
  76.                   (! isset($this->PD['user'])) || (! isset($this->PD['consumableid']))
  77.                 )
  78.              ) {
  79.       if (! isset($this->PD['user'])) {
  80.         $this->selectConsumeUser();
  81.       }
  82.       if (! isset($this->PD['consumableid'])) {
  83.         $this->selectConsumeConsumable();
  84.       }
  85.     } else {
  86.       if ($this->readOnly) $this->_dataCleanse(array('id', 'user', 'consumableid'));
  87.       $this->edit();
  88.     }
  89.     echo "<br /><br /><a href='".makeURL('consume')."'>".T_('Return to consumable use list')."</a>";
  90.   }
  91.  
  92.   /**
  93.   * Select which user is consuming the item
  94.   */
  95.   function selectConsumeUser() {
  96.     $path = array();
  97.     if (isset($this->PD['consumableid'])) {
  98.       $path['consumableid'] = $this->PD['consumableid'];
  99.     }
  100.     $userselect = new AnchorTableList(T_('Users'), T_('Select which user is consuming'));
  101.     $userselect->deleted = false;  // don't show deleted users
  102.     $userselect->connectDB("users", array('id', 'name', 'username'));
  103.     $userselect->hrefbase = makeURL('consume', array_merge($path, array('user' => '__id__')));
  104.     $userselect->setFormat('id', '%s', array('name'), ' %s', array('username'));
  105.  
  106.     if (isset($this->PD['consumableid']) && $this->PD['consumableid'] > 0) {
  107.       echo '<p>'.sprintf(T_('<a href="%s">View listing</a> for selected consumable'),
  108.                   makeURL('consume', array_merge($path, array('list'=>1))))."</p>\n";
  109.     }
  110.     echo $userselect->display();
  111.     echo '<br />';
  112.   }
  113.  
  114.   /**
  115.   * Select what item is being consumed
  116.   */
  117.   function selectConsumeConsumable() {
  118.     $path = array();
  119.     if (isset($this->PD['user'])) {
  120.       $path['user'] = $this->PD['user'];
  121.     }
  122.     $consumableselect = new AnchorTableList(T_('Consumables'), T_('Select which Consumables to use'));
  123.     $consumableselect->deleted = false;   // don't show deleted consumables
  124.     $consumableselect->connectDB('consumables', array('id', 'name', 'longname'));
  125.     $consumableselect->hrefbase = makeURL('consume', array_merge($path, array('consumableid' => '__id__')));
  126.     $consumableselect->setFormat('id', '%s', array('name'), ' %50.50s', array('longname'));
  127.  
  128.     if (isset($this->PD['user']) && $this->PD['user'] > 0) {
  129.       echo '<p>'.sprintf(T_('<a href="%s">View listing</a> for selected user'),
  130.                   makeURL('consume', array_merge($path, array('list'=>1))))."</p>\n";
  131.     }
  132.     echo $consumableselect->display();
  133.   }
  134.  
  135.   function edit() {
  136.     $recordid = isset($this->PD['id']) ? $this->PD['id'] : -1;
  137.     $userid   = isset($this->PD['user']) ? $this->PD['user'] : -1;
  138.     $consumableid = isset($this->PD['consumableid']) ? $this->PD['consumableid'] : -1;
  139.     $uid = $this->auth->uid;
  140.     $ip = $this->auth->getRemoteIP();
  141.     $today = new SimpleDate(time());
  142.     $rec = new ConsumableUse($recordid, $userid, $consumableid,
  143.                               $uid, $ip, $today->dateString());
  144.     $rec->update($this->PD);
  145.     $rec->checkValid();
  146.     echo $this->reportAction($rec->sync(),
  147.           array(
  148.               STATUS_OK =>   ($recordid < 0 ? T_('Consumption recorded')
  149.                                             : T_('Consumption record updated')),
  150.               STATUS_ERR =>  T_('Consumption record could not be changed:').' '.$rec->errorMessage
  151.           )
  152.         );
  153.     echo $rec->display();
  154.     if ($rec->id < 0) {
  155.       $submit = T_('Record consumable use');
  156.       $delete = '0';
  157.     } else {
  158.       $submit = T_('Update entry');
  159.       $delete = T_('Delete entry');
  160.     }
  161.     echo "<input type='submit' name='submit' value='$submit' />";
  162.     if ($delete) echo "<input type='submit' name='delete' value='$delete' />";
  163.   }
  164.  
  165.   function delete() {
  166.     $rec = new ConsumableUse($this->PD['id']);
  167.     echo $this->reportAction($rec->delete(),
  168.               array(
  169.                   STATUS_OK =>   T_('Consumption record deleted'),
  170.                   STATUS_ERR =>  T_('Consumption record could not be deleted:')
  171.                                   .'<br/><br/>'.$rec->errorMessage
  172.               )
  173.             );
  174.   }
  175.  
  176.   /**
  177.   * list the consumption records for this particular consumable
  178.   *
  179.   * @param integer $consumableID   table ID number of consumable to be displayed
  180.   * @param DateRange $daterange    time period over which consumption records are to be displayed
  181.   * @return void nothing
  182.   */
  183.   function listConsumeConsumable($consumableID, $daterange) {
  184.     $start = $daterange->getStart();
  185.     $stop  = $daterange->getStop();
  186.     $stop->addDays(1);
  187.     $consumable = new Consumable($consumableID);
  188.     echo '<p>'
  189.           .sprintf(T_('Consumption records for %s'), $consumable->fields['name']->value)
  190.           ."</p>\n";
  191.     $recselect = new AnchorTableList(T_('Consumption Record'),
  192.                               T_('Select the consumption record to view'), 3);
  193.     $recselect->deleted = NULL;
  194.     $recselect->setTableHeadings(array(T_('Date'), T_('User'), T_('Quantity')));
  195.     $recselect->connectDB('consumables_use',
  196.                           array(array('consumables_use.id','conid'), 'consumable', 'usewhen', 'username', 'name', 'quantity'),
  197.                           'consumable='.qw($consumableID)
  198.                               .' AND usewhen >= '.qw($start->dateTimeString())
  199.                               .' AND usewhen < '.qw($stop->dateTimeString()),
  200.                           'usewhen',
  201.                           array('consumables_use.id','conid'),
  202.                           NULL,
  203.                           array('users'=>'userid=users.id'));
  204.     $recselect->hrefbase = makeURL('consume', array('id'=>'__id__'));
  205.     $recselect->setFormat('conid', '%s', array('usewhen'), ' %s (%s)', array('name', 'username'), '%s', array('quantity'));
  206.  
  207.     echo $recselect->display();
  208.   }
  209.  
  210.   /**
  211.   * list the consumption records for this particular consumable
  212.   *
  213.   * @param integer $userID         table ID number of user to be displayed
  214.   * @param DateRange $daterange    time period over which consumption records are to be displayed
  215.   * @return void nothing
  216.   */
  217.   function listConsumeUser($userID, $daterange) {
  218.     $start = $daterange->getStart();
  219.     $stop  = $daterange->getStop();
  220.     $stop->addDays(1);
  221.     $user = new User($userID, true);
  222.     echo '<p>'
  223.         .sprintf(T_('Consumption records for %s (%s)'),
  224.               $user->fields['username']->value,
  225.               $user->fields['name']->value)
  226.         .")</p>\n";
  227.     $recselect = new AnchorTableList(T_('Consumption Record'),
  228.                     T_('Select the consumption record to view'), 3);
  229.     $recselect->deleted = NULL;
  230.     $recselect->setTableHeadings(array(T_('Date'), T_('Item'), T_('Quantity')));
  231.     $recselect->connectDB('consumables_use',
  232.                           array(array('consumables_use.id','conid'), 'consumable', 'usewhen', 'name', 'longname', 'quantity'),
  233.                           'userid='.qw($userID)
  234.                               .' AND usewhen >= '.qw($start->dateTimeString())
  235.                               .' AND usewhen < '.qw($stop->dateTimeString()),
  236.                           'usewhen',
  237.                           array('consumables_use.id','conid'),
  238.                           NULL,
  239.                           array('consumables'=>'consumable=consumables.id'));
  240.     $recselect->hrefbase = makeURL('consume', array('id'=>'__id__'));
  241.     $recselect->setFormat('conid', '%s', array('usewhen'), ' %s (%30.30s)', array('name', 'longname'), '%s', array('quantity'));
  242.  
  243.     echo $recselect->display();
  244.   }
  245. }
  246.  
  247. ?>

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