home *** CD-ROM | disk | FTP | other *** search
/ Total Network Tools 2002 / NextStepPublishing-TotalNetworkTools2002-Win95.iso / Archive / Web Server / PHP.EXE / pear / PHPDoc / warning / PhpdocWarning.php
Encoding:
PHP Script  |  2001-02-18  |  2.3 KB  |  69 lines
  1. <?php
  2. /**
  3. * Container for all kind of Warnings the parser/analyser recognizes
  4. * 
  5. * The base of the report generator module is this container. It's currently 
  6. * pretty simple and will change later on...
  7. *
  8. * @version  $Id: PhpdocWarning.php,v 1.3 2001/02/18 16:31:09 uw Exp $
  9. */
  10. class PhpdocWarning extends PhpdocObject {
  11.     
  12.     /**
  13.     * Hash of documentation failures.
  14.     *
  15.     * @var  array    
  16.     */
  17.     var $doc_warnings = array();
  18.     
  19.     /**
  20.     * Counter containing the number of documentation warnings.
  21.     *
  22.     * @var  integer
  23.     * @see  getNumDocWarnings(), getNumWarnings()
  24.     */
  25.     var $num_doc_warnings = 0;
  26.     
  27.     /**
  28.     * Adds a warning to the list of class documentation failures.
  29.     *
  30.     * @param    string  Name of the file that containts the error
  31.     * @param    string  Kind of the element that caused the error: module, class, function, variable, use, const
  32.     * @param    string  Name of the class/function/... that caused the warning
  33.     * @param    string  Warning message itself
  34.     * @param    string  Type of the error: missing, mismatch, syntax, ...
  35.     * @access   public
  36.     * @see      addDocWarning()
  37.     */
  38.     function addDocWarning($file, $elementtype, $elementname, $warning, $type = "missing") {
  39.  
  40.         $this->doc_warnings[$file][$elementtype][] =    array(
  41.                                                                 "name"    => $elementname,
  42.                                                                 "type"    => $type,
  43.                                                                 "msg"        => $warning
  44.                                                              );
  45.         $this->num_doc_warnings++;
  46.         
  47.     } // end func addDocWarning
  48.  
  49.     /**
  50.     * Returns a list of warnings.
  51.     *
  52.     * @return    array    $warnings
  53.     * @access    public
  54.     */        
  55.     function getWarnings() {
  56.         return $this->doc_warnings;
  57.     } // end func getParserWarnings
  58.     
  59.     /**
  60.     * Returns the total number of documentation warnings.
  61.     * @access    public
  62.     * @see    getNumParserWarnings(), getNumWarnings()
  63.     */
  64.     function getNumDocWarnings() {
  65.         return $this->num_doc_warnings;
  66.     } // end func getNumDocWarnings
  67.     
  68. } // end class PhpdocWarning
  69. ?>