Source for file Email.class.php

Documentation is available at Email.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 Email 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 Email Report Class
  30.  * @version 0.0.1
  31.  */
  32.  
  33. gumbo_load ("Debug_Report");
  34. gumbo_load ("Date");
  35. gumbo_load ("Valid_Web");
  36.  
  37. class Gumbo_Debug_Report_Email extends Gumbo_Debug_Report {
  38.  
  39.     /** @var string $_email address to send Debug Report */
  40.     private $_email;
  41.  
  42.  
  43.  
  44.     /**
  45.      * Constructor
  46.      * @param string $email 
  47.      */
  48.     public function __construct ($email=null) {
  49.         if (defined ("GUMBO_DEBUG_EMAIL")) { $this->setEmail (GUMBO_DEBUG_EMAIL); }
  50.         if (!is_null ($email)) { $this->setEmail ($email); }
  51.     }
  52.  
  53.  
  54.  
  55.     /** ACTION METHODS **/
  56.     /**
  57.      * Runs the Report
  58.      * @param num $start_time initial start time of script debugger
  59.      * @throws Gumbo_Exception
  60.      * @uses Gumbo_Date
  61.      */
  62.     public function run ($start_time=null) {
  63.         try {
  64.             // verify precondition
  65.             if (!$this->getEmail ()) {
  66.                 throw new Gumbo_Exception ("Debug Email Undefined");
  67.             }
  68.             
  69.             $txt = null;
  70.             foreach ($this->getMessages () as $mess) {
  71.                 $mess->setSeconds ($start_time);
  72.                 
  73.                 $txt .= $mess->getSeconds () . "||" . $mess->getMessage () . "||";
  74.                 $txt .= $mess->getFile () . "||" . $mess->getLine () . "||";
  75.                 $txt .= $mess->getFunction () . "||" . $mess->getClass () . "\n";
  76.                 
  77.                 $start_time = $mess->getTime ();
  78.             }
  79.             
  80.             $date = new Gumbo_Date ();
  81.             @mail ($this->getEmail (), "Debug Report: " . $date->get (), $txt);
  82.         } catch (Gumbo_Exception $e) {
  83.             $e->setFunction (__METHOD__);
  84.             gumbo_trigger ($e);
  85.         }
  86.     }
  87.  
  88.  
  89.  
  90.     /** MUTATOR METHODS **/
  91.     /**
  92.      * Sets the Debug Email Address
  93.      * @param string $email 
  94.      * @throws Gumbo_Exception
  95.      * @uses Gumbo_Valid_Web
  96.      */
  97.     public function setEmail ($email) {
  98.         try {
  99.             // verify precondition
  100.             if (!is_string ($email)) {
  101.                 throw new Gumbo_Exception ("Invalid Argument 'email:str' => {$email}:" . gettype ($email));
  102.             }
  103.             $valid = new Gumbo_Valid_Web ();
  104.             if (!$valid->isEmail ($email)) {
  105.                 throw new Gumbo_Exception ("Invalid Email Address: {$email}");
  106.             }
  107.                 
  108.             $this->_email = $email;
  109.         } catch (Gumbo_Exception $e) {
  110.             $e->setFunction (__METHOD__);
  111.             gumbo_trigger ($e);
  112.         }
  113.     }
  114.  
  115.  
  116.  
  117.     /** ACCESSOR METHODS **/
  118.     /**
  119.      * Returns the Debug Email
  120.      * @return string 
  121.      */
  122.     public function getEmail () {
  123.         return $this->_email;
  124.     }
  125.  
  126. }
  127.  
  128. ?>