Source for file daterange.php

Documentation is available at daterange.php

  1. <?php
  2. /**
  3. * DateRange display/data reflection class
  4. *
  5. * A class to handle a simple date range from a form and reflect all other entered data
  6. *
  7. * @author    Stuart Prescott
  8. * @copyright  Copyright Stuart Prescott
  9. * @license    http://opensource.org/licenses/gpl-license.php GNU Public License
  10. * @version    $Id$
  11. * @package    Bumblebee
  12. * @subpackage DBObjects
  13. */
  14.  
  15. /** Load ancillary functions */
  16. require_once 'inc/typeinfo.php';
  17. checkValidInclude();
  18.  
  19. /** date manipulation routines */
  20. require_once 'inc/date.php';
  21. /** quick select javascript object */
  22. require_once 'inc/jsquickwalk.php';
  23. /** parent object */
  24. require_once 'inc/formslib/nondbrow.php';
  25. require_once 'inc/formslib/datefield.php';
  26.  
  27. /** default is current time period */
  28. define('DR_CURRENT',  1);
  29. /** default is next time period */
  30. define('DR_NEXT',     2);
  31. /** default is previous time period */
  32. define('DR_PREVIOUS', 4);
  33.  
  34. /** default time period is one day */
  35. define('DR_DAY',      8);
  36. /** default time period is one week */
  37. define('DR_WEEK',    16);
  38. /** default time period is one month */
  39. define('DR_MONTH',   32);
  40. /** default time period is one quarter (3 months) (alternative) */
  41. define('DR_QTR',     64);
  42. /** default time period is one quarter (3 months) */
  43. define('DR_QUARTER', 64);
  44. /** default time period is one year */
  45. define('DR_YEAR',   128);
  46.  
  47. /**
  48. * DateRange display/data reflection class
  49. *
  50. * A class to handle a simple date range from a form and reflect all other entered data
  51. *
  52. * @author    Stuart Prescott
  53. * @copyright  Copyright Stuart Prescott
  54. * @license    http://opensource.org/licenses/gpl-license.php GNU Public License
  55. * @version    $Id$
  56. * @package    Bumblebee
  57. * @subpackage DBObjects
  58. */
  59. class DateRange extends nonDBRow {
  60.   /** @var boolean   include data in hidden fields if not shown  */
  61.   var $reflectData = 1;
  62.   /** @var boolean   include a submit button in the output  */
  63.   var $includeSubmitButton = 1;
  64.  
  65.   function DateRange($name, $longname, $description) {
  66.     parent::nonDBRow($name, $longname, $description);
  67.     //$this->DEBUG=10;
  68.     $startdate = new DateField('startdate', T_('Start period beginning of'),
  69.                           T_('Period starts at the beginning of this day'));
  70.     $startdate->isValidTest = 'is_valid_date';
  71.     $this->addElement($startdate);
  72.     $stopdate  = new DateField('stopdate', T_('Finish period end of'),
  73.                           T_('Period finishes at the end of this day'));
  74.     $stopdate->isValidTest = 'is_valid_date';
  75.     $this->addElement($stopdate);
  76.   }
  77.  
  78.   /**
  79.    * Calculate a sensible range
  80.    *
  81.    * this is calculated from the 'DR_*' data that we have above
  82.    *
  83.    * @param integer $which     DR_NEXT, DR_CURRENT, DR_PREVIOUS
  84.    * @param integer $range     DR_DAY, DR_WEEK, etc...
  85.    * @param integer $basetime  what date is "current" date
  86.    * @return array  (SimpleDate startdate, SimpleDate stopdate)
  87.    */
  88.   function _calcRange($which, $range, $basetime) {
  89.     $start = clone($basetime);
  90.     $stop  = clone($start);
  91.     switch ($range) {
  92.       case DR_YEAR:
  93.         $start->yearRound();
  94.         $stop = clone($start);
  95.         switch ($which) {
  96.           case DR_NEXT:
  97.             $start->addTimeParts(0,0,0,0,0,1);
  98.             $stop->addTimeParts(0,0,0,0,0,2);
  99.             break;
  100.           case DR_PREVIOUS:
  101.             $start->addTimeParts(0,0,0,0,0,-1);
  102.             break;
  103.           case DR_CURRENT:
  104.             $stop->addTimeParts(0,0,0,0,0,1);
  105.         }
  106.         break;
  107.       case DR_QUARTER:
  108.         $start->quarterRound();
  109.         $stop = clone($start);
  110.         switch ($which) {
  111.           case DR_NEXT:
  112.             $start->addTimeParts(0,0,0,0,3);
  113.             $stop->addTimeParts(0,0,0,0,6);
  114.             break;
  115.           case DR_PREVIOUS:
  116.             $start->addTimeParts(0,0,0,0,-3);
  117.             break;
  118.           case DR_CURRENT:
  119.             $stop->addTimeParts(0,0,0,0,3);
  120.         }
  121.         break;
  122.       case DR_MONTH:
  123.         $start->monthRound();
  124.         $stop = clone($start);
  125.         switch ($which) {
  126.           case DR_NEXT:
  127.             $start->addTimeParts(0,0,0,0,1);
  128.             $stop->addTimeParts(0,0,0,0,2);
  129.             break;
  130.           case DR_PREVIOUS:
  131.             $start->addTimeParts(0,0,0,0,-1);
  132.             break;
  133.           case DR_CURRENT:
  134.             $stop->addTimeParts(0,0,0,0,1);
  135.         }
  136.         break;
  137.       case DR_WEEK:
  138.         $start->weekRound();
  139.         $stop = clone($start);
  140.         switch ($which) {
  141.           case DR_NEXT:
  142.             $start->addTimeParts(0,0,0,7);
  143.             $stop->addTimeParts(0,0,0,14);
  144.             break;
  145.           case DR_PREVIOUS:
  146.             $start->addTimeParts(0,0,0,-7);
  147.             break;
  148.           case DR_CURRENT:
  149.             $stop->addTimeParts(0,0,0,0,7);
  150.         }
  151.         break;
  152.       case DR_DAY:
  153.         $start->dayRound();
  154.         $stop = clone($start);
  155.         switch ($which) {
  156.           case DR_NEXT:
  157.             $start->addTimeParts(0,0,0,1);
  158.             $stop->addTimeParts(0,0,0,2);
  159.             break;
  160.           case DR_PREVIOUS:
  161.             $start->addTimeParts(0,0,0,-1);
  162.             break;
  163.           case DR_CURRENT:
  164.             $stop->addTimeParts(0,0,0,0,1);
  165.         }
  166.         break;
  167.     }
  168.     $stop->addDays(-1);
  169.     return array('startdate'=>$start, 'stopdate'=>$stop);
  170.   }
  171.  
  172.   /**
  173.    * what default values should be in the boxes
  174.    *
  175.    * this is calculated from the 'DR_*' data that we have above
  176.    *
  177.    * @param integer $which     DR_NEXT, DR_CURRENT, DR_PREVIOUS
  178.    * @param integer $range     DR_DAY, DR_WEEK, etc...
  179.    * @param integer $basetime  what date is "current" date
  180.    * @return array  (html javascript, forwards-backwards button html)
  181.    */
  182.   function setDefaults($which, $range, $basetime=0) {
  183.     $start = new SimpleDate($basetime ? $basetime : time());
  184.     $daterange = $this->_calcRange($which, $range, $start);
  185.     $this->fields['startdate']->setDate($daterange['startdate']->dateString());
  186.     $this->fields['stopdate']->setDate($daterange['stopdate']->dateString());
  187.     $this->extrarows = array();
  188.     $rangePile = array($daterange);
  189.     $nextrange = $daterange;
  190.     $prevrange = $daterange;
  191.     $maxRanges  = 10;             //FIXME: hardcoded magic number
  192.     for ($i=0; $i<$maxRanges; $i++) {
  193.       $nextrange = $this->_calcRange(DR_NEXT,     $range, $nextrange['startdate']);
  194.       $prevrange = $this->_calcRange(DR_PREVIOUS, $range, $prevrange['startdate']);
  195.       array_unshift($rangePile, $prevrange);
  196.       array_push   ($rangePile, $nextrange);
  197.     }
  198.     //preDump($rangePile);
  199.     $jswalk = new JSQuickWalk($this->namebase,'&laquo; '.T_('Previous'), T_('Next').' &raquo;', array('startdate', 'stopdate'), $rangePile, $maxRanges);
  200.     //preDump($jswalk);
  201.     //$this->extrarows[] = array('', $prevRange[0]->dateString().$prevRange[1]->dateString());
  202.     //$this->extrarows[] = array('', $nextRange[0]->dateString().$nextRange[1]->dateString());
  203.     $this->extrarows[] = array($jswalk->displayJS(),
  204.                         $jswalk->displayBack().' | '.$jswalk->displayFwd());
  205.   }
  206.  
  207.  
  208.   function display($PD=NULL) {
  209.     $t = '';
  210.     if ($this->reflectData) {
  211.       foreach ($PD as $key => $val) {
  212.         $t .= '<input type="hidden" name="'.$key.'" value="'.xssqw($val).'" />';
  213.       }
  214.     }
  215.     $t .= $this->displayInTable(2);
  216.     if ($this->includeSubmitButton) {
  217.       $t .= '<input type="submit" name="submit" value="Go" />';
  218.     }
  219.     return $t;
  220.   }
  221.  
  222.   function getStart() {
  223.     return $this->fields['startdate']->date;
  224.   }
  225.  
  226.   function getStop() {
  227.     return $this->fields['stopdate']->date;
  228.   }
  229. } //dateRange
  230.  
  231. ?>

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