Source for file message.class.php

Documentation is available at message.class.php

  1. <?php   /*
  2.    *@=@=@=@ START LICENSE @=@=@=@*
  3.    Copyright or © or Copr. Stéphane TRICHET and Nicolas SOTRON
  4.    
  5.    stephane.t@simpliciweb.net and nicolas.s@simpliciweb.net
  6.    
  7.    This software is a computer program whose purpose is to make a
  8.    web hosting platform
  9.    
  10.    This software is governed by the CeCILL  license under French law and
  11.    abiding by the rules of distribution of free software.  You can  use, 
  12.    modify and/ or redistribute the software under the terms of the CeCILL
  13.    license as circulated by CEA, CNRS and INRIA at the following URL
  14.    "http://www.cecill.info". 
  15.    
  16.    As a counterpart to the access to the source code and  rights to copy,
  17.    modify and redistribute granted by the license, users are provided only
  18.    with a limited warranty  and the software's author,  the holder of the
  19.    economic rights,  and the successive licensors  have only  limited
  20.    liability. 
  21.    
  22.    In this respect, the user's attention is drawn to the risks associated
  23.    with loading,  using,  modifying and/or developing or reproducing the
  24.    software by the user in light of its specific status of free software,
  25.    that may mean  that it is complicated to manipulate,  and  that  also
  26.    therefore means  that it is reserved for developers  and  experienced
  27.    professionals having in-depth computer knowledge. Users are therefore
  28.    encouraged to load and test the software's suitability as regards their
  29.    requirements in conditions enabling the security of their systems and/or 
  30.    data to be ensured and,  more generally, to use and operate it in the 
  31.    same conditions as regards security. 
  32.    
  33.    The fact that you are presently reading this means that you have had
  34.    knowledge of the CeCILL license and that you accept its terms.
  35.    *@=@=@=@ END   LICENSE @=@=@=@*
  36.  
  37. */?><?php  
  38. /**
  39.  * Message Class
  40.  * 
  41.  * 
  42.  * @author SimpliciWeb
  43.  * @version $Id: message.class.php 804 2008-01-08 17:05:37Z stephanet $
  44.  * @package Common
  45.  * @subpackage Start
  46.  */    
  47.  
  48. /**
  49.  * Type of error : SILENT
  50.  *
  51.  */
  52. define('NET_ERROR_SILENT',         'S');
  53. /**
  54.  * Type of error : HTML
  55.  *
  56.  */
  57. define('NET_ERROR_HTML',           'H');
  58. /**
  59.  * Type of error : Internal
  60.  *
  61.  */
  62. define('NET_ERROR_INTERNAL',       'I');
  63.  
  64.  
  65. /**
  66.  * Generate an error loged to the PLICI logs /log
  67.  *
  68.  * @param bool $p_as_got_an_error   TRUE = log the error, FALSE = do nothing
  69.  * @param string $p_error_id 
  70.  * @return bool $p_as_got_an_error
  71.  */
  72. function onErrorThrow($p_as_got_an_error, $p_error_id)/*, $p_fonction_name , $file_name_or_design_id , 
  73.                         $error_type = NET_ERROR_HTML, $array_params_for_error = array()) */{
  74.     if (!$p_as_got_an_error)
  75.         return $p_as_got_an_error; 
  76.     
  77.         $current_message_error = $p_error_id;
  78.     
  79.         // quoi qu'il arrive on met une version courte de l'erreur dans le log
  80.         $prefix_msg_error = "";//"[".date("D M d G:i:s Y")."] "."PLICI[".$_SERVER['HTTP_HOST']."] : "; 
  81.         
  82.         $error_msg_to_log = $prefix_msg_error.$p_error_id."\n";
  83.         foreach(debug_backtrace() as $value) {
  84.             $file = $value['file'];
  85.             $line = "(line: ".$value['line'].")";
  86.             $function = $value['function'];
  87.             if (isset($value['args']) && is_array($value['args'])) {
  88.                 $function .= '("';
  89.                 foreach($value['args'] as $keyargs => $valueargs) {
  90.                     if ($keyargs>0)
  91.                         $function .= ",";
  92.                         
  93.                     if (!is_object($valueargs))
  94.                         $function .= $valueargs;
  95.                     else
  96.                         $function .= get_class($valueargs);
  97.                     
  98.                 }
  99.                 $function .= '")';
  100.             } else
  101.                 $function .= '(none)';
  102.                 
  103.             $error_msg_to_log .=  $prefix_msg_error."         ".$line."  ".$file."\n";
  104.             $error_msg_to_log .=  $prefix_msg_error."         Fct :".$function."\n";
  105.         }
  106.         
  107.         if (mysql_errno()>0)
  108.             $error_msg_to_log .=  mysql_error()."\n";
  109.         
  110.         trigger_error($error_msg_to_log);
  111.  
  112.  
  113.     
  114.         // Si on doit setter une erreur vers l'HTML on le fait ici
  115.         global $g_object_loader;
  116.         $g_object_message =& $g_object_loader->getMessage();
  117.         //echo_net("error, $p_error_id, $current_message_error");
  118.         $g_object_message->addError("error", $p_error_id, $p_error_id);
  119.         
  120.         
  121.     return $p_as_got_an_error; 
  122. }
  123.  
  124. /**
  125.  * Any class wich extend ObjectCached can use a function cache using xRemembered, etc.
  126.  *
  127.  * @author SimpliciWeb
  128.  * @version $Id: message.class.php 804 2008-01-08 17:05:37Z stephanet $
  129.  * @package Common
  130.  * @subpackage Start
  131.  */
  132.  
  133. class Message {
  134.  
  135.     /**
  136.      * Pushed errors
  137.      *
  138.      * @var array 
  139.      */
  140.     var $errors         = array();
  141.     /**
  142.      * SiteInformation Object
  143.      *
  144.      * @var siteInformation 
  145.      */
  146.     var $m_object_siteinformation = NULL;
  147.     /**
  148.      * There is an error
  149.      *
  150.      * @var bool 
  151.      */
  152.     var $there_is_an_error  = false;
  153.     
  154.     /**
  155.      * Stop the message system
  156.      *
  157.      * @var bool 
  158.      */
  159.     var $m_is_registering = false;
  160.     /**
  161.      * Error registered
  162.      *
  163.      * @var array 
  164.      */
  165.     var $m_array_error_registered = NULL;
  166.     /**
  167.      * Error registered by id
  168.      *
  169.      * @var array 
  170.      */
  171.     var $m_array_error_registered_by_iderror = NULL;
  172.  
  173.     /**
  174.      * Constructor, init the requests and objects
  175.      *
  176.      * @return Message 
  177.      */
  178.     function Message() {
  179.  
  180.         global $g_object_loader;
  181.         $this->m_object_siteinformation =& $g_object_loader->getSiteInformation();
  182.         
  183.         
  184.     }
  185.  
  186.  
  187.  
  188.     /**
  189.      * Get messages to assign
  190.      *
  191.      * @param string $message 
  192.      */
  193.     function getMessagesToAssign(&$message) {
  194.     
  195.             $this->xMakeErrorMessage($message, $this->errors);
  196.  
  197.     }
  198.  
  199.     /**
  200.      * Format the errors messages
  201.      *
  202.      * @access private
  203.      * @param string $r_message 
  204.      * @param array $array_erros 
  205.      */
  206.     function xMakeErrorMessage(&$r_message, $array_erros ) {
  207.  
  208.  
  209.         $r_message = "";
  210.         for ($i=0; $i < sizeof($array_erros);$i++) {
  211.  
  212.             if ($i>0)
  213.             $r_message .="<BR>";
  214.  
  215.             $r_message .=$array_erros[$i];
  216.         }
  217.     }
  218.  
  219.  
  220.     /**
  221.      * Enable Error Message registering
  222.      *
  223.      * @return bool 
  224.      */
  225.     function startDisablingError() {
  226.         $this->m_array_error_registered = array();
  227.         $this->m_array_error_registered_by_iderror = array();
  228.         $this->m_is_registering = true;
  229.         return false;
  230.     }
  231.  
  232.     /**
  233.      * Disable Error Message registering
  234.      *
  235.      * @return bool 
  236.      */
  237.     function endDisablingError() {
  238.         $this->m_is_registering = false;
  239.         
  240.         return false;
  241.     }
  242.  
  243.     /**
  244.      * Get the messages during disabling
  245.      *
  246.      * Used in import/export to not show errors directly but to show it after
  247.      * 
  248.      * @return string 
  249.      */
  250.     function getMessagesDuringDisabling() {
  251.         $r_error_message = "";
  252.         $this->xMakeErrorMessage($r_error_message, $this->m_array_error_registered);
  253.         return $r_error_message;        
  254.     }
  255.  
  256.  
  257.     /**
  258.      * Return if a message has been encountred
  259.      *
  260.      * @return bool 
  261.      */
  262.     function thereIsAnError() {
  263.         if ($this->there_is_an_error) {
  264.             $this->there_is_an_error = false;
  265.             return true;
  266.         } 
  267.         return false;
  268.     }
  269.  
  270.  
  271.     /**
  272.      * Add an error
  273.      *
  274.      * @param string $p_type 
  275.      * @param string $p_id 
  276.      * @param string $current_message_error 
  277.      * @return string 
  278.      */
  279.     function addError($p_type, $p_id, $current_message_error) {
  280.         $this->there_is_an_error = true;
  281.  
  282.         
  283.  
  284.         if ($this->m_is_registering) {
  285.             $this->m_array_error_registered[sizeof($this->m_array_error_registered)] = $current_message_error;
  286.             $this->m_array_error_registered_by_iderror[$p_id] = $current_message_error;
  287.         } else {
  288.             if (!in_array($current_message_error,$this->errors)) {
  289.                 $this->errors[sizeof($this->errors)] = $current_message_error;
  290.             }
  291.         }
  292.         
  293.         return $current_message_error;
  294.  
  295.     }
  296.  
  297.  
  298.  
  299. }
  300.  
  301.  
  302.  
  303. ?>

Documentation generated on Tue, 25 Mar 2008 15:35:14 +0100 by phpDocumentor 1.3.2