Source for file jsquickwalk.php

Documentation is available at jsquickwalk.php

  1. <?php
  2. /**
  3. * Create a pair of forward/back javascript links to allow the user to move forward and back through a sequence of date periods
  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 Misc
  11. */
  12.  
  13. /** Load ancillary functions */
  14. require_once 'inc/typeinfo.php';
  15. checkValidInclude();
  16.  
  17. /** date manipulation routines */
  18. require_once 'inc/date.php';
  19.  
  20. /**
  21. * Create a pair of forward/back javascript links to allow the user to move forward and back through a sequence of date periods
  22. *
  23. * @package    Bumblebee
  24. * @subpackage Misc
  25. */
  26. class JSQuickWalk {
  27.   /**
  28.   * unqiue name in the javascript namespace for these functions (prepended to everything)
  29.   * @var string 
  30.   */
  31.   var $namebase;
  32.   /**
  33.   * name for the "back" link
  34.   * @var string 
  35.   */
  36.   var $back;
  37.   /**
  38.   * name for the "forward" link
  39.   * @var string 
  40.   */
  41.   var $fwd;
  42.   /**
  43.   * html text-input id's for the two date elements
  44.   * @var array 
  45.   */
  46.   var $keys;
  47.   /**
  48.   * dates to use in the sequence
  49.   * @var array 
  50.   */
  51.   var $values;
  52.   /**
  53.   * initial position in sequence
  54.   * @var integer 
  55.   */
  56.   var $counter;
  57.  
  58.   /**
  59.   * Constructor
  60.   * @param string $namebase added to javascript namespace for uniqueness
  61.   * @param string $back     label for 'previous' button
  62.   * @param string $fwd      label for 'next' button
  63.   * @param array  $keys     list of js id tags for the text boxes to alter
  64.   * @param array  $values   list of dates to use in the sequence
  65.   * @param integer $counter  initial position in sequence
  66.   */
  67.   function JSQuickWalk($namebase, $back, $fwd, $keys, $values, $counter) {
  68.     $this->namebase = $namebase;
  69.     $this->back = $back;
  70.     $this->fwd  = $fwd;
  71.     $this->keys = $keys;
  72.     $this->values = $values;
  73.     $this->counter = $counter;
  74.   }
  75.   
  76.   /**
  77.   * generate the javascript for the +/- links
  78.   * @return string javascript embedded in html for necessary functions and data
  79.   */
  80.   function displayJS() {
  81.     $eol="\n";
  82.     $t = '<script type="text/javascript">'.$eol
  83.         .'<!--'.$eol;
  84.     $t .= $this->namebase.'walkarray = new Array();'.$eol;
  85.     for ($i=0; $i<count($this->values); $i++) {
  86.       $t .= $this->namebase.'walkarray['.$i.']= new Array();'.$eol;
  87.       foreach ($this->keys as $k) {
  88.         $t .= $this->namebase.'walkarray['.$i.']["'.$k.'"]="'
  89.                                     .$this->values[$i][$k]->dateString().'";'.$eol;
  90.       }
  91.     }
  92.     $c = $this->namebase.'walkcounter';
  93.     $t .= 'var '.$c.'='.$this->counter.';'.$eol;
  94.     $t .= 'function '.$this->namebase.'walkfwd() {'.$eol
  95.          .'  rightForm = "bumblebeeform";'
  96.          //.'  alert("FOO"+'.$c.')'.$eol
  97.          .'  ('.$c.' < '.(count($this->values)-1).' && '.$c.'++);'.$eol;
  98.     foreach ($this->keys as $k) {
  99.       $t .= '  document.forms[rightForm].'.$this->namebase.$k.'.value='
  100.                               .$this->namebase.'walkarray['.$c.']["'.$k.'"];'.$eol;
  101.     }
  102.     
  103. //         .'  alert('.$c.'['..'])'.$eol
  104.          //.'  return false;'
  105.     $t .= '}'.$eol;
  106.  
  107.     $t .= 'function '.$this->namebase.'walkback() {'.$eol
  108.          .'  rightForm = "bumblebeeform";'
  109.          .'  ('.$c.' > 0 && '.$c.'--);'.$eol;
  110.     foreach ($this->keys as $k) {
  111.       $t .= '  document.forms[rightForm].'.$this->namebase.$k.'.value='
  112.                               .$this->namebase.'walkarray['.$c.']["'.$k.'"];'.$eol;
  113.     }
  114.     $t .= '}'.$eol;
  115.     $t .= '-->'.$eol
  116.          .'</script>'.$eol;
  117.     return $t;
  118.   }
  119.   
  120.   /**
  121.   * generate the forward link
  122.   * @return string html link to fire the forwards event
  123.   */
  124.   function displayFwd() {
  125.     return '<a href="javascript:'.$this->namebase.'walkfwd()">'
  126.             .$this->fwd.'</a>';
  127.   }
  128.   
  129.   /**
  130.   * generate the back link
  131.   * @return string html link to fire the previous event
  132.   */
  133.   function displayBack() {
  134.     return '<a href="javascript:'.$this->namebase.'walkback()">'
  135.             .$this->back.'</a>';
  136.   }
  137.  
  138. }

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