Source for file bufferedaction.php

Documentation is available at bufferedaction.php

  1. <?php
  2. /**
  3. * Primitive class that allows output to be suppressed
  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/bufferedaction.php
  13. */
  14.  
  15. /** Load ancillary functions */
  16. require_once 'inc/typeinfo.php';
  17. checkValidInclude();
  18.  
  19. require_once 'inc/bb/configreader.php';
  20.  
  21. /** status codes for success/failure of database actions */
  22. require_once 'inc/statuscodes.php';
  23. /** parent object */
  24. require_once 'inc/actions/actionaction.php';
  25.  
  26. /**
  27. * Primitive class that allows output to be suppressed
  28. * @package    Bumblebee
  29. * @subpackage Actions
  30. */
  31. class BufferedAction extends ActionAction  {
  32.   /**
  33.   * data stream to be buffered then output
  34.   * @var string 
  35.   */
  36.   var $bufferedStream;
  37.   /**
  38.   * filename to suggest to the browser for saving the stream
  39.   * @var string 
  40.   */
  41.   var $filename;
  42.   /**
  43.   * error message (if any) for display instead of the stream
  44.   * @var string 
  45.   */
  46.   var $errorMessage;
  47.   /**
  48.   * mime type for instructing the browser what to do with the stream
  49.   * @var string 
  50.   */
  51.   var $mimetype = 'text/plain';
  52.   /**
  53.   * whether the file is to be displayed by the browser automatically or offered to be saved
  54.   * @var boolean 
  55.   */
  56.   var $inline = true;
  57.  
  58.   /**
  59.   * Initialising the class
  60.   *
  61.   * @param  BumblebeeAuth $auth  Authorisation object
  62.   * @param  array $pdata   extra state data from the call path
  63.   * @return void nothing
  64.   */
  65.   function BufferedAction($auth, $pdata) {
  66.     parent::ActionAction($auth, $pdata);
  67.     $this->mungeInputData();
  68.     $this->ob_flush_ok = 0;
  69.   }
  70.  
  71.   /**
  72.   * Unbuffer the stream and allow the data to be output
  73.   */
  74.   function unbuffer() {
  75.     // only run this once.
  76.     if (! $this->ob_flush_ok) {
  77.       $this->ob_flush_ok = 1;
  78.       ob_end_flush();
  79.     }
  80.   }
  81.  
  82.   /**
  83.   * Unbuffer the stream and get ready to drop the error message to the user
  84.   * @param string $err error message to be output
  85.   */
  86.   function unbufferForError($err) {
  87.     $this->errorMessage = '<p>'.$err.'</p>';
  88.     $this->unbuffer();
  89.     return STATUS_ERR;
  90.   }
  91.  
  92.   /**
  93.   * Send the data back to the user now
  94.   */
  95.   function sendBufferedStream() {
  96.     $this->outputTextFile($this->filename, $this->bufferedStream);
  97.   }
  98.  
  99.   /**
  100.   * send headers to the browser with the filename and the mimetype
  101.   * @param string $filename the suggested filename to give to the browser
  102.   */
  103.   function startOutputTextFile($filename) {
  104.     header('Content-type: '.$this->mimetype);
  105.     $disposition = ($this->inline ? 'inline' : 'attachment');
  106.     header("Content-Disposition: $disposition; filename=$filename");
  107.   }
  108.  
  109.   /**
  110.   * Dump a data stream to the user
  111.   * @param string $filename the suggested filename to give to the browser
  112.   * @param string $stream the data stream to be sent
  113.   */
  114.   function outputTextFile($filename, $stream) {
  115.     $this->startOutputTextFile($filename);
  116.     echo $stream;
  117.   }
  118.  
  119.   /**
  120.   * Save the datastream to a local file
  121.   * @param string $filename the filename to save the data to on the server
  122.   * @param string $stream the data stream to be saved
  123.   */
  124.   function saveTextFile($filename, $stream) {
  125.     $fp = fopen($filename, 'w');
  126.     fputs($fp, $stream);
  127.     fclose($fp);
  128.   }
  129.  
  130.   /**
  131.   * Work out an appropriate (and hopefully unique) filename for the data
  132.   * Uses the Config option in bumblebee.ini [export]::filename
  133.   * The following parameters are replaced: __date__ __action__ __what__
  134.   *
  135.   * @param string $action the action verb
  136.   * @param string $what the nature of the export
  137.   * @param string $ext  the file extension (pdf, csv etc) without the dot.
  138.   */
  139.   function getFilename($action, $what, $ext) {
  140.     $conf = ConfigReader::getInstance();
  141.     $name = $conf->value('export', 'filename');
  142.     $name = preg_replace('/__date__/', strftime('%Y%m%d-%H%M%S', time()), $name);
  143.     $name = preg_replace('/__action__/', $action, $name);
  144.     $name = preg_replace('/__what__/', $what, $name);
  145.     return $name.'.'.$ext;
  146.   }
  147.  
  148. } //class BufferedAction
  149.  
  150. ?>

Documentation generated on Tue, 06 Mar 2007 10:00:56 +0000 by phpDocumentor 1.3.0