Source for file Buffer.class.php

Documentation is available at Buffer.class.php

  1. <?php
  2. /**
  3.  * Gumbo Library Framework
  4.  *
  5.  * LICENSE
  6.  * This library is being released under the terms of the New BSD License.  A
  7.  * copy of the license is packaged with the software (LICENSE.txt).  If no
  8.  * copy is found, a copy of the license template can be found at:
  9.  * http://www.opensource.org/licenses/bsd-license.php
  10.  * 
  11.  * @category Gumbo
  12.  * @package Buffer
  13.  * @copyright Copyright (c) 2007, iBayou, Michael Luster
  14.  * @license http://www.opensource.org/licenses/bsd-license.php New BSD License
  15.  * @author Michael Luster <mluster79@yahoo.com>
  16.  * @link http://sourceforge.net/projects/phpgumbo
  17.  * @version 0.0.1
  18.  */
  19.  
  20. /**
  21.  * Buffer Interface
  22.  * 
  23.  * This Interface was designed to be a simple Wrapper to the ob_* functions
  24.  * in PHP.  Each method will show an example of the function it was meant to
  25.  * wrap.  There are more advanced functions available, but the intent was to
  26.  * be simple.  Future Buffer Interfaces will include advanced features.
  27.  *
  28.  * @category Gumbo
  29.  * @package Buffer
  30.  * @copyright Copyright (c) 2007, iBayou, Michael Luster
  31.  * @license http://www.opensource.org/licenses/bsd-license.php New BSD License
  32.  * @author Michael Luster <mluster79@yahoo.com>
  33.  * @link http://sourceforge.net/projects/phpgumbo
  34.  * @desc Buffer Interface
  35.  * @version 0.0.1
  36.  */
  37.  
  38. interface Gumbo_Interface_Buffer {
  39.     
  40.     /** ACTION METHODS **/
  41.     /**
  42.      * Cleans the output buffer: ob_clean()
  43.      */
  44.     public function clean ();
  45.     
  46.     /**
  47.      * Flushes the contents of the buffer to the browser: ob_flush()
  48.      */
  49.     public function flush ();
  50.     
  51.     
  52.     
  53.     /** ACCESSOR METHODS **/
  54.     /**
  55.      * Returns the contents of the buffer: ob_get_contents()
  56.      * @param bool $clean cleans the buffer after getting the contents
  57.      * @return string 
  58.      */
  59.     public function contents ($clean=false);
  60.     
  61.     /**
  62.      * Returns the size of the buffer: ob_get_length()
  63.      * @return int 
  64.      */
  65.     public function size ();
  66.     
  67. }
  68.  
  69. ?>