Source for file File.class.php

Documentation is available at File.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 Debug
  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.  * Debug File Report Class
  22.  *
  23.  * @category Gumbo
  24.  * @package Debug
  25.  * @copyright Copyright (c) 2007, iBayou, Michael Luster
  26.  * @license http://www.opensource.org/licenses/bsd-license.php New BSD License
  27.  * @author Michael Luster <mluster79@yahoo.com>
  28.  * @link http://sourceforge.net/projects/phpgumbo
  29.  * @desc Debug File Report Class
  30.  * @version 0.0.1
  31.  */
  32.  
  33. gumbo_load ("Debug_Report");
  34. gumbo_load ("Date");
  35.  
  36. class Gumbo_Debug_Report_File extends Gumbo_Debug_Report {
  37.     
  38.     /** @var string $_file Debug File */
  39.     private $_file;
  40.     
  41.     
  42.     
  43.     /**
  44.      * Constructor
  45.      * @param string $file (full path)
  46.      */
  47.     public function __construct ($file=null) {
  48.         if (defined ("GUMBO_DEBUG_FILE")) { $this->setFile (GUMBO_DEBUG_FILE); }
  49.         if (!is_null ($file)) { $this->setFile ($file); }
  50.     }
  51.     
  52.     
  53.     
  54.     /** ACTION METHODS **/
  55.     /**
  56.      * Runs the Report
  57.      * @param num $start_time initial start time of script debugger
  58.      * @throws Gumbo_Exception
  59.      * @uses Gumbo_Date
  60.      */
  61.     public function run ($start_time=null) {
  62.         try {
  63.             // verify precondition
  64.             if (!$this->getFile ()) {
  65.                 throw new Gumbo_Exception ("Debug File Undefined");
  66.             }
  67.             
  68.             $fp = @fopen ($this->getFile (), "a+");
  69.             $date = new Gumbo_Date ();
  70.             fwrite ($fp, "\n" . $date->get () . "\n");
  71.             
  72.             foreach ($this->getMessages () as $mess) {
  73.                 $mess->setSeconds ($start_time);
  74.                 
  75.                 $txt = $mess->getSeconds () . "||" . $mess->getMessage () . "||";
  76.                 $txt .= $mess->getFile () . "||" . $mess->getLine () . "||";
  77.                 $txt .= $mess->getFunction () . "||" . $mess->getClass () . "\n";
  78.                 fwrite ($fp, $txt);
  79.                 
  80.                 $start_time = $mess->getTime ();
  81.             }
  82.             
  83.             fwrite ($fp, "\n");
  84.             fclose ($fp);
  85.         } catch (Gumbo_Exception $e) {
  86.             $e->setFunction (__METHOD__);
  87.             gumbo_trigger ($e);
  88.         }
  89.     }
  90.     
  91.     
  92.     
  93.     /** MUTATOR METHODS **/
  94.     /**
  95.      * Sets the Debug File Path
  96.      * @param string $file 
  97.      * @throws Gumbo_Exception
  98.      */
  99.     public function setFile ($file) {
  100.         try {
  101.             // verify precondition
  102.             if (!is_string ($file)) {
  103.                 throw new Gumbo_Exception ("Invalid Argument 'file:str' => {$file}:" . gettype ($file));
  104.             }
  105.             
  106.             $this->_file = $file;
  107.         } catch (Gumbo_Exception $e) {
  108.             $e->setFunction (__METHOD__);
  109.             gumbo_trigger ($e);
  110.         }
  111.     }
  112.     
  113.     
  114.     
  115.     /** ACCESSOR METHODS **/
  116.     /**
  117.      * Returns the Debug File name
  118.      * @return string 
  119.      */
  120.     public function getFile () {
  121.         return $this->_file;
  122.     }
  123.     
  124. }
  125.  
  126. ?>