Source for file emaillist.php

Documentation is available at emaillist.php

  1. <?php
  2. /**
  3. * email lists for instrument users
  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/emaillist.php
  13. */
  14.  
  15. /** Load ancillary functions */
  16. require_once 'inc/typeinfo.php';
  17. checkValidInclude();
  18.  
  19. /** TextBox object */
  20. require_once 'inc/formslib/textfield.php';
  21. /** CheckBox object */
  22. require_once 'inc/formslib/checkbox.php';
  23. /** CheckBoxTableList object */
  24. require_once 'inc/formslib/checkboxtablelist.php';
  25. /** db interrogation list object */
  26. require_once 'inc/formslib/dblist.php';
  27. /** form object */
  28. require_once 'inc/formslib/nondbrow.php';
  29. /** export status codes and formats */
  30. require_once 'inc/export/exporttypes.php';
  31. /** parent object */
  32. require_once 'inc/actions/actionaction.php';
  33.  
  34.  
  35. /**
  36. * Generate a list of email addresses for users of particular instruments
  37. *
  38. * An Action to find out what instruments the lists should be prepared for
  39. * and then return the email list.
  40. * Designed to be use as a per instrument "announce" list.
  41. *
  42. * @todo //TODO: should this class should be split some more, with some of the details abstracted?
  43. * @package    Bumblebee
  44. * @subpackage Actions
  45. */
  46. class ActionEmailList extends ActionAction {
  47.   /**
  48.   * forces SQL errors to be fatal
  49.   * @var    boolean 
  50.   */
  51.   var $fatal_sql = 1;
  52.  
  53.   /**
  54.   * Initialising the class
  55.   *
  56.   * @param  BumblebeeAuth $auth  Authorisation object
  57.   * @param  array $pdata   extra state data from the call path
  58.   * @return void nothing
  59.   */
  60.   function ActionEmailList($auth, $pdata) {
  61.     parent::ActionAction($auth, $pdata);
  62.     $this->mungeInputData();
  63.   }
  64.  
  65.   function go() {
  66.     if (! isset($this->PD['selectlist'])) {
  67.       $this->selectLists();
  68.     } else {
  69.       $this->returnLists();
  70.     }
  71.   }
  72.  
  73.   /**
  74.   * Generate an HTML form for the user to select which email lists should be used
  75.   *
  76.   * - do DB look-ups on what instruments exist
  77.   * - construct a table of checkboxes to allow the user to select the lists
  78.   *
  79.   * @return void nothing
  80.   */
  81.   function selectLists() {
  82.     $selectRow = new nonDBRow('listselect', T_('Select email lists'),
  83.               T_('Select which email lists you want to return'));
  84.     $select = new CheckBoxTableList(T_('Instrument'), T_('Select which instrument to view'));
  85.     $hidden = new TextField('instrument');
  86.     $select->addFollowHidden($hidden);
  87.     $announce = new CheckBox('announce', T_('Announce'));
  88.     $select->addCheckBox($announce);
  89.     $unbook = new CheckBox('unbook', T_('Unbook'));
  90.     $select->addCheckBox($unbook);
  91.     //$select->numSpareCols = 1;
  92.     $select->connectDB('instruments', array('id', 'name', 'longname'));
  93.     $select->setFormat('id', '%s', array('name'), " %50.50s", array('longname'));
  94.     $select->addSelectAllFooter(true);
  95.     $selectRow->addElement($select);
  96.     $separator = new TextField('separator', T_('Value separator'),
  97.                 T_('Separates the returned values so you can paste them into your email client'));
  98.     $separator->defaultValue = ',';
  99.     $separator->setattr(array('size' => '2'));
  100.     $selectRow->addElement($separator);
  101.     echo $selectRow->displayInTable(4);
  102.     echo '<input type="hidden" name="selectlist" value="1" />';
  103.     echo '<input type="submit" name="submit" value="'.T_('Select').'" />';
  104.   }
  105.  
  106.  
  107.   /**
  108.   * Generate the email lists
  109.   *
  110.   * - work out which instruments the user has requested for inclusion
  111.   * - construct an SQL query to get the email list
  112.   * - return the formatted data to the user
  113.   *
  114.   * @return void nothing
  115.   */
  116.   function returnLists() {
  117.     $where = array('0');  //start the WHERE with 0 in case nothing was selected (always get valid SQL)
  118.     $namebase = 'Instrument-';
  119.     for ($j=0; isset($this->PD[$namebase.$j.'-row']); $j++) {
  120.       $instr = issetSet($this->PD,$namebase.$j.'-instrument');
  121.       //echo "$j ($instr) => ($unbook, $announce)<br />";
  122.       if (issetSet($this->PD,$namebase.$j.'-announce')) {
  123.         $where[] ='(permissions.instrid='.qw($instr).' AND permissions.announce='.qw(1).')' ;
  124.       }
  125.       if (issetSet($this->PD,$namebase.$j.'-unbook')) {
  126.         $where[] = '(permissions.instrid='.qw($instr).' AND permissions.unbook='.qw(1).')' ;
  127.       }
  128.     }
  129.     #echo "Gathering email addresses: $q<br />";
  130.     $fields = array(new sqlFieldName('email', 'Email Address'));
  131.     $restriction = 'users.deleted<>1 AND (' .join($where, ' OR '). ')';  //don't return deleted users
  132.     $list = new DBList('permissions', $fields, $restriction, true);
  133.     $list->join[] = (array('table' => 'users', 'condition' => 'users.id=permissions.userid'));
  134.     $list->setFormat('%s', array('email'));
  135.     $list->fill();
  136.     if (count($list->data) == 0) {
  137.       echo '<p>No email addresses found</p>';
  138.     } else {
  139.       $list->formatList();
  140.       $this->PD['separator'] = stripslashes($this->PD['separator']);
  141.       if ($this->PD['separator'] == '\n') {
  142.         $this->PD['separator'] = "\n";
  143.       } elseif ($this->PD['separator'] == '\t') {
  144.         $this->PD['separator'] = "\t";
  145.       }
  146.       echo join(array_xssqw($list->formatdata), xssqw($this->PD['separator']).'<br />');
  147.     }
  148.   }
  149.  
  150. }
  151. ?>

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