phpDocumentor phpDocumentor
Errors
[ class tree: phpDocumentor ] [ index: phpDocumentor ] [ all elements ]
phpDocumentor
Packages:
phpDocumentor
Converters
Cpdf
HTML_TreeMenu
Smarty
tests
XML_Beautifier

Source for file Errors.inc

Documentation is available at Errors.inc

  1. <?php
  2. /**
  3.  * Error handling for phpDocumentor
  4.  *
  5.  * phpDocumentor :: automatic documentation generator
  6.  * 
  7.  * PHP versions 4 and 5
  8.  *
  9.  * Copyright (c) 2001-2006 Gregory Beaver
  10.  * 
  11.  * LICENSE:
  12.  * 
  13.  * This library is free software; you can redistribute it
  14.  * and/or modify it under the terms of the GNU Lesser General
  15.  * Public License as published by the Free Software Foundation;
  16.  * either version 2.1 of the License, or (at your option) any
  17.  * later version.
  18.  * 
  19.  * This library is distributed in the hope that it will be useful,
  20.  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  21.  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  22.  * Lesser General Public License for more details.
  23.  * 
  24.  * You should have received a copy of the GNU Lesser General Public
  25.  * License along with this library; if not, write to the Free Software
  26.  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
  27.  *
  28.  * @package    phpDocumentor
  29.  * @subpackage Errors
  30.  * @author     Greg Beaver <[email protected]>
  31.  * @copyright  2001-2006 Gregory Beaver
  32.  * @license    http://www.opensource.org/licenses/lgpl-license.php LGPL
  33.  * @version    CVS: $Id: Errors.inc,v 1.8 2006/08/16 17:08:32 cellog Exp $
  34.  * @filesource
  35.  * @link       http://www.phpdoc.org
  36.  * @link       http://pear.php.net/PhpDocumentor
  37.  * @see        parserDocBlock, parserInclude, parserPage, parserClass
  38.  * @see        parserDefine, parserFunction, parserMethod, parserVar
  39.  * @since      0.4
  40.  */
  41. /**
  42.  * warning triggered when inheritance could be from more than one class
  43.  */
  44. define("PDERROR_MULTIPLE_PARENT",1);
  45. /**
  46.  * warning triggered when parent class doesn't exist
  47.  */
  48. define("PDERROR_PARENT_NOT_FOUND",2);
  49. /**
  50.  * warning triggered when an {@inline tag} is not terminated (no } before the * / ending the comment)
  51.  */
  52. define("PDERROR_UNTERMINATED_INLINE_TAG",3);
  53. /**
  54.  * warning triggered when inheritance could be from more than one class
  55.  */
  56. define("PDERROR_CLASS_EXISTS",4);
  57. /**
  58.  * warning triggered when inheritance could be from more than one class
  59.  */
  60. define("PDERROR_INHERITANCE_CONFLICT",5);
  61. /**
  62.  * warning triggered when a converter is passed to {@link phpDocumentor_IntermediateParser::addConverter()} that is not a class
  63.  */
  64. define("PDERROR_CONVERTER_NOT_FOUND",6);
  65. /**
  66.  * warning triggered when a converter is passed to {@link phpDocumentor_IntermediateParser::addConverter()} that is not a class
  67.  */
  68. define("PDERROR_NO_CONVERTERS",7);
  69. /**
  70.  * warning triggered when the arguments to @access are neither public nor private
  71.  */
  72. define("PDERROR_ACCESS_WRONG_PARAM",8);
  73. /**
  74.  * warning triggered when there are multiple @access tags in a docblock
  75.  */
  76. define("PDERROR_MULTIPLE_ACCESS_TAGS",9);
  77. /**
  78.  * warning triggered when there are multiple @return tags in a docblock
  79.  */
  80. define("PDERROR_MULTIPLE_RETURN_TAGS",10);
  81. /**
  82.  * warning triggered when there are multiple @var tags in a docblock
  83.  */
  84. define("PDERROR_MULTIPLE_VAR_TAGS",11);
  85. /**
  86.  * warning triggered when there are multiple @package tags in a docblock
  87.  */
  88. define("PDERROR_MULTIPLE_PACKAGE_TAGS",12);
  89. /**
  90.  * warning triggered when there are multiple @subpackage tags in a docblock
  91.  */
  92. define("PDERROR_MULTIPLE_SUBPACKAGE_TAGS",13);
  93. /**
  94.  * warning triggered when the package or subpackage name is illegal
  95.  */
  96. define("PDERROR_ILLEGAL_PACKAGENAME",14);
  97. /**
  98.  * warning triggered when there a @package tag is used in a function, define, method, var or include
  99.  */
  100. define("PDERROR_OVERRIDDEN_PACKAGE_TAGS",15);
  101. /**
  102.  * warning triggered when there a @subpackage tag is used in a function, define, method, var or include
  103.  */
  104. define("PDERROR_OVERRIDDEN_SUBPACKAGE_TAGS",16);
  105. /**
  106.  * warning triggered when classes in the same package have the same name
  107.  */
  108. define("PDERROR_CLASS_CONFLICT",17);
  109. /**
  110.  * warning triggered when classes in the same package have the same name
  111.  */
  112. define("PDERROR_UNKNOWN_TAG",18);
  113. /**
  114.  * warning triggered when there are multiple @name tags in a docblock
  115.  */
  116. define("PDERROR_MULTIPLE_NAME_TAGS",19);
  117. /**
  118.  * warning triggered when there are multiple @name tags in a docblock
  119.  */
  120. define("PDERROR_PACKAGEOUTPUT_DELETES_PARENT_FILE",20);
  121. /**
  122.  * warning triggered when there are multiple @name tags in a docblock
  123.  */
  124. define("PDERROR_GLOBAL_NOT_FOUND",21);
  125. /**
  126.  * warning triggered when there are multiple @name tags in a docblock
  127.  */
  128. define("PDERROR_MULTIPLE_GLOBAL_TAGS",22);
  129. /**
  130.  * warning triggered when there are multiple @name tags in a docblock
  131.  */
  132. define("PDERROR_MALFORMED_GLOBAL_TAG",23);
  133. /**
  134.  * warning triggered when an @ignore tag is used in a DocBlock preceding a method, variable, include, or global variable
  135.  */
  136. define("PDERROR_IGNORE_TAG_IGNORED",24);
  137. /**
  138.  * warning triggered when a duplicate element is encountered that will be ignored by the documentor
  139.  */
  140. define("PDERROR_ELEMENT_IGNORED",25);
  141. /**
  142.  * warning triggered when an entire page is ignored because of @access private
  143.  */
  144. define("PDERROR_PARSEPRIVATE",26);
  145. /**
  146.  * warning triggered when an entire page is ignored because of @access private
  147.  */
  148. define("PDERROR_UNKNOWN_COMMANDLINE",27);
  149. /**
  150.  * warning triggered when an entire page is ignored because of @access private
  151.  */
  152. define("PDERROR_NEED_WHITESPACE",28);
  153. /**
  154.  * warning triggered when an entire page is ignored because of @access private
  155.  */
  156. define("PDERROR_CLASS_PARENT_NOT_FOUND",29);
  157. /**
  158.  * warning triggered when a getClassByPackage is called and can't find the class
  159.  */
  160. define("PDERROR_CLASS_NOT_IN_PACKAGE",30);
  161. /**
  162.  * warning triggered when a { @source } inline tag is used in a docblock not preceding a function
  163.  */
  164. define("PDERROR_SOURCE_TAG_FUNCTION_NOT_FOUND",31);
  165. /**
  166.  * warning triggered when a docblock template is never turned off with /**#@-* / (no space)
  167.  */
  168. define("PDERROR_DB_TEMPLATE_UNTERMINATED",32);
  169. /**
  170.  * warning triggered when a docblock has an unmatched &lt;ol&gt; or &lt;ul&gt;
  171.  */
  172. define("PDERROR_UNMATCHED_LIST_TAG",33);
  173. /**
  174.  * warning triggered when another tag is nested in &lt;b&gt; - not allowed in phpDocumentor
  175.  */
  176. define("PDERROR_CANT_NEST_IN_B",34);
  177. /**
  178.  * warning triggered when a docbook tag is not properly matched
  179.  */
  180. define("PDERROR_UNMATCHED_TUTORIAL_TAG",35);
  181. /**
  182.  * warning triggered when an inline tag is found inside an xml tag name in a package page
  183.  */
  184. define("PDERROR_CANT_HAVE_INLINE_IN_TAGNAME",36);
  185. /**
  186.  * warning triggered when a tutorial is referenced via @tutorial/{ @tutorial} and is not found
  187.  */
  188. define("PDERROR_TUTORIAL_NOT_FOUND",37);
  189. /**
  190.  * warning triggered when a tutorial lists itself as a child tutorial
  191.  */
  192. define("PDERROR_TUTORIAL_IS_OWN_CHILD",38);
  193. /**
  194.  * warning triggered when a tutorial's child lists the parent tutorial as a child tutorial
  195.  */
  196. define("PDERROR_TUTORIAL_IS_OWN_GRANDPA",39);
  197. /**
  198.  * warning triggered when a tutorial's child in the .ini file doesn't exist in the
  199.  * package and subpackage of the parent
  200.  */
  201. define("PDERROR_CHILD_TUTORIAL_NOT_FOUND",40);
  202. /**
  203.  * warning triggered when a <pdffunction:funcname /> tag is used in the PDF
  204.  * Converter and no funcname is present (<pdffunction: />)
  205.  */
  206. define("PDERROR_PDFFUNCTION_NO_FUNC",41);
  207. /**
  208.  * warning triggered when a <pdffunction:funcname /> tag is used in the PDF
  209.  * Converter and funcname is not a {@link Cezpdf} method
  210.  */
  211. define("PDERROR_PDF_METHOD_DOESNT_EXIST",42);
  212. /**
  213.  * warning triggered when a <pdffunction:funcname arg=$tempvar/> tag is used in the PDF
  214.  * Converter and "tempvar" is not set from the return of a previous pdffunction tag
  215.  */
  216. define("PDERROR_PDF_TEMPVAR_DOESNT_EXIST",43);
  217. /**
  218.  * warning triggered when a subsection's title is asked for, but the subsection is not found
  219.  */
  220. define("PDERROR_TUTORIAL_SUBSECTION_NOT_FOUND",44);
  221. /**
  222.  * warning triggered when a subsection's title is asked for, but the subsection is not found
  223.  */
  224. define("PDERROR_UNTERMINATED_ATTRIB",45);
  225. /**
  226.  * warning triggered when no @package tag is used in a page-level or class-level DocBlock
  227.  */
  228. define("PDERROR_NO_PACKAGE_TAG",46);
  229. /**
  230.  * warning triggered when no @access private tag is used in a global variable/method/var
  231.  * with _ as first char in name and --pear was specified
  232.  */
  233. define("PDERROR_PRIVATE_ASSUMED",47);
  234. /**
  235.  * warning triggered when an example's path from @example /path/to/example.php
  236.  * is not found
  237.  */
  238. define("PDERROR_EXAMPLE_NOT_FOUND",48);
  239. /**
  240.  * warning triggered when an example's path from @example /path/to/example.php
  241.  * is not found
  242.  */
  243. define("PDERROR_NO_CONVERTER_HANDLER",49);
  244. /**
  245.  * warning triggered when an example's path from @example /path/to/example.php
  246.  * is not found
  247.  */
  248. define("PDERROR_INLINETAG_IN_SEE",50);
  249. /**
  250.  * warning triggered when an id attribute in a tutorial docbook tag is not
  251.  * an {@}id} inline tag
  252.  */
  253. define("PDERROR_ID_MUST_BE_INLINE",51);
  254. /**
  255.  * warning triggered when an {@}internal}} tag is not closed
  256.  */
  257. define("PDERROR_INTERNAL_NOT_CLOSED",52);
  258. /**
  259.  * warning triggered when an {@}source} tag is found in a short description
  260.  */
  261. define("PDERROR_SOURCE_TAG_IGNORED",53);
  262. /**
  263.  * warning triggered when a child converter doesn't override getFormattedClassTrees()
  264.  */
  265. define("PDERROR_CONVERTER_OVR_GFCT",54);
  266. /**
  267.  * warning triggered when a package is already associated with a category, and
  268.  * a new association is found
  269.  */
  270. define("PDERROR_PACKAGECAT_SET",55);
  271. /**
  272.  * warning triggered when text in a docblock list is not contained in
  273.  * an <<li>> opening tag
  274.  */
  275. define("PDERROR_TEXT_OUTSIDE_LI",56);
  276. /**
  277.  * warning triggered when a DocBlock html tag is unclosed
  278.  */
  279. define("PDERROR_UNCLOSED_TAG",57);
  280. /**
  281.  * warning triggered by @filesource, if PHP < 4.3.0
  282.  */
  283. define("PDERROR_TAG_NOT_HANDLED",58);
  284. /**
  285.  * warning triggered by sourcecode="on", if PHP < 4.3.0
  286.  */
  287. define("PDERROR_SOURCECODE_IGNORED",59);
  288. /**
  289.  * warning triggered by an empty tag
  290.  */
  291. define("PDERROR_MALFORMED_TAG",60);
  292. /**
  293.  * warning triggered by more than 1 @category tag
  294.  */
  295. define("PDERROR_MULTIPLE_CATEGORY_TAGS",61);
  296. /**
  297.  * warning triggered by {@}inheritdoc} in a non-inheritable situation
  298.  */
  299. define("PDERROR_INHERITDOC_DONT_WORK_HERE",62);
  300. /**
  301.  * warning triggered by @example path/to/example with no title
  302.  */
  303. define("PDERROR_EMPTY_EXAMPLE_TITLE",63);
  304. /**
  305.  * warning triggered by non-existent template directory
  306.  */
  307. define("PDERROR_TEMPLATEDIR_DOESNT_EXIST",64);
  308. /**
  309.  * warning triggered by an unterminated entity in a tutorial
  310.  */
  311. define("PDERROR_UNTERMINATED_ENTITY",65);
  312. /**
  313.  * warning triggered by an unterminated entity in a tutorial
  314.  */
  315. define("PDERROR_BEAUTIFYING_FAILED",66);
  316. /**
  317.  * warning triggered by a function with no name
  318.  *
  319.  * <pre>
  320.  * function ($params)
  321.  * {
  322.  * }
  323.  * </pre>
  324.  * triggers this error
  325.  */
  326. define("PDERROR_FUNCTION_HAS_NONAME",67);
  327. /**
  328.  * warning triggered by a page-level docblock preceding a source element
  329.  *
  330.  * <code>
  331.  * <?php
  332.  * /**
  333.  *  * Page-level DocBlock
  334.  *  * @package pagepackage
  335.  *  *{@*} 
  336.  * include 'file.php';
  337.  * </code>
  338.  */
  339. define("PDERROR_DOCBLOCK_CONFLICT", 68);
  340. /**
  341.  * warning triggered when a file does not contain a page-level docblock
  342.  */
  343. define("PDERROR_NO_PAGE_LEVELDOCBLOCK", 69);
  344. /**
  345.  * warning triggered when the first docblock in a file with a @package tag
  346.  * precedes a class.  In this case, the class gets the docblock.
  347.  */
  348. define("PDERROR_DOCBLOCK_GOES_CLASS", 70);
  349. /**
  350.  * warning triggered in tutorial parsing if there is a missing {@id} inline tag
  351.  */
  352. define("PDERROR_NO_DOCBOOK_ID", 71);
  353. /**
  354.  * warning triggered if someone brilliant tries "class X extends X {"
  355.  */
  356. define("PDERROR_CANNOT_EXTEND_SELF", 72);
  357. /**
  358.  * warning triggered by improper "@uses {@link blah}"
  359.  */
  360. define("PDERROR_DUMB_USES",73);
  361. /**
  362.  * warning triggered if <<ul>> is nested inside <<ul>> and not <<li>>
  363.  */
  364. define("PDERROR_UL_IN_UL", 74);
  365. /**
  366.  * warning triggered if a command line option does not have a valid value passed in
  367.  */
  368. define("PDERROR_INVALID_VALUES", 75);
  369. /**
  370.  * warning triggered when {@}internal}} is nested inside another {@}internal}}
  371.  */
  372. define("PDERROR_NESTED_INTERNAL", 76);
  373. /**
  374.  * warning triggered when @todo is used on an include element
  375.  */
  376. define("PDERROR_NOTODO_INCLUDE", 77);
  377.  
  378. /**
  379.  * Error messages for phpDocumentor parser warnings
  380.  * @global array $GLOBALS['phpDocumentor_warning_descrip'] 
  381.  * @name $phpDocumentor_warning_descrip
  382.  */
  383. $GLOBALS['phpDocumentor_warning_descrip'] =
  384.     array(
  385.         PDERROR_MULTIPLE_PARENT => 'Class %s has multiple possible parents, package inheritance aborted',
  386.         PDERROR_PARENT_NOT_FOUND => 'Class %s parent %s not found',
  387.         PDERROR_INHERITANCE_CONFLICT => 'Class %s in file %s has multiple possible parents named %s.  Cannot resolve name conflict,'."\n".' try ignoring a file that contains the conflicting parent class',
  388.         PDERROR_UNKNOWN_TAG => 'Unknown tag "@%s" used',
  389.         PDERROR_IGNORE_TAG_IGNORED => '@ignore tag used for %s element "%s" will be ignored',
  390.         PDERROR_ELEMENT_IGNORED => "\n".'duplicate %s element "%s" in file %s will be ignored.'."\n".'Use an @ignore tag on the original if you want this case to be documented.',
  391.         PDERROR_PARSEPRIVATE => "entire page %s ignored because of @access private.\nChoose -pp to enable parsing of private elements",
  392.         PDERROR_CLASS_PARENT_NOT_FOUND => "class %s in package %s parent not found in @see parent::%s",
  393.         PDERROR_CLASS_NOT_IN_PACKAGE => "class %s was not found in package %s",
  394.         PDERROR_DB_TEMPLATE_UNTERMINATED => "docblock template never terminated with /**#@-*/",
  395.         PDERROR_PDF_METHOD_DOESNT_EXIST => '<pdffunction:%s /> called, but pdf method "%s" doesn\'t exist',
  396.         PDERROR_TUTORIAL_NOT_FOUND => "tutorial \"%s\" not found, does it exist?",
  397.         PDERROR_CHILD_TUTORIAL_NOT_FOUND => 'child tutorial "%s" listed in %s not found in parent package "%s" subpackage "%s"',
  398.         PDERROR_TUTORIAL_SUBSECTION_NOT_FOUND => 'tutorial %s subsection "%s" doesn\'t exist, but its title was asked for',
  399.         PDERROR_NO_PACKAGE_TAG => 'no @package tag was used in a DocBlock for %s %s',
  400.         PDERROR_PRIVATE_ASSUMED => '%s "%s" is assumed to be @access private because its name starts with _, but has no @access tag',
  401.         PDERROR_EXAMPLE_NOT_FOUND => 'example file "%s" does not exist',
  402.         PDERROR_SOURCE_TAG_IGNORED => '{@source} can only be used in the long description, not in the short description: "%s"',
  403.         PDERROR_PACKAGECAT_SET => 'package %s is already in category %s, will now replace with category %s',
  404.         PDERROR_SOURCECODE_IGNORED => 'sourcecode command-line option is ignored for PHP versions < 4.3.0',
  405.         PDERROR_INHERITDOC_DONT_WORK_HERE => '{@inheritdoc} can only be used in the docblock of a child class',
  406.         PDERROR_EMPTY_EXAMPLE_TITLE => 'Example file found at "%s" has no title, using "%s"',
  407.         PDERROR_DOCBLOCK_CONFLICT => 'Page-level DocBlock precedes "%s %s", use another DocBlock to document the source element',
  408.         PDERROR_NO_PAGE_LEVELDOCBLOCK => 'File "%s" has no page-level DocBlock, use @package in the first DocBlock to create one',
  409.         PDERROR_DOCBLOCK_GOES_CLASS => 'DocBlock would be page-level, but precedes class "%s", use another DocBlock to document the file',
  410.         PDERROR_NO_DOCBOOK_ID => 'Tutorial section %s "%s" has no id="{@id subsection}" tag ({@id} for refentry)',
  411.         PDERROR_BEAUTIFYING_FAILED => 'Beautifying failed: %s',
  412.         PDERROR_NOTODO_INCLUDE => '@todo on an include element is ignored (line %s, file %s)',
  413.         );
  414.  
  415.  
  416.  
  417. //********************************************************
  418.  
  419.  
  420.  
  421. /**
  422.  * Error messages for phpDocumentor parser errors
  423.  * @global array $GLOBALS['phpDocumentor_error_descrip'] 
  424.  * @name $phpDocumentor_error_descrip
  425.  */
  426. $GLOBALS['phpDocumentor_error_descrip'] = 
  427.     array(
  428.         PDERROR_UNTERMINATED_INLINE_TAG => 'Inline tag {@%s} in tag %s is unterminated, "%s"',
  429.         PDERROR_CLASS_EXISTS => 'Class %s already exists in package "%s"',
  430.         PDERROR_CONVERTER_NOT_FOUND => 'Converter %s specified by --output command-line option is not a class',
  431.         PDERROR_NO_CONVERTERS => 'No Converters have been specified by --output command-line option',
  432.         PDERROR_ACCESS_WRONG_PARAM => '@access was passed neither "public" nor "private."  Was passed: "%s"',
  433.         PDERROR_MULTIPLE_ACCESS_TAGS => 'DocBlock has multiple @access tags, illegal. ignoring additional tag "@access %s"',
  434.         PDERROR_MULTIPLE_RETURN_TAGS => 'DocBlock has multiple @return tags, illegal. ignoring additional tag "@return %s %s"',
  435.         PDERROR_MULTIPLE_VAR_TAGS => 'DocBlock has multiple @var tags, illegal. ignoring additional tag "@var %s %s"',
  436.         PDERROR_MULTIPLE_PACKAGE_TAGS => 'DocBlock has multiple @package tags, illegal. ignoring additional tag "@package %s"',
  437.         PDERROR_MULTIPLE_SUBPACKAGE_TAGS => 'DocBlock has multiple @subpackage tags, illegal. ignoring additional tag "@subpackage %s"',
  438.         PDERROR_ILLEGAL_PACKAGENAME => '@%s tag has illegal %s name "%s"',
  439.         PDERROR_OVERRIDDEN_PACKAGE_TAGS => '%s %s\'s DocBlock has @package tag, illegal. ignoring tag "@package %s"',
  440.         PDERROR_OVERRIDDEN_SUBPACKAGE_TAGS => '"%s" %s\'s DocBlock has @subpackage tags, illegal. ignoring tag "@subpackage %s"',
  441.         PDERROR_CLASS_CONFLICT => 'class "%s" has multiple declarations in package %s, in file %s and file %s, documentation will have output errors!',
  442.         PDERROR_MULTIPLE_NAME_TAGS => 'DocBlock has multiple @name tags, illegal. ignoring additional tag "@name %s"',
  443.         PDERROR_PACKAGEOUTPUT_DELETES_PARENT_FILE => '-po (packageoutput) option deletes parent file "%s" containing class "%s."'."\n".'  Try using --defaultpackagename (-dn) %s to include the parent file in the same package as the class',
  444.         PDERROR_GLOBAL_NOT_FOUND => 'global variable %s specified in @global tag was never found',
  445.         PDERROR_MULTIPLE_GLOBAL_TAGS => '@global define tag already used for global variable "%s", ignoring @global %s',
  446.         PDERROR_MALFORMED_GLOBAL_TAG => 'incorrect @global syntax.  Should be @global vartype $varname or @global vartype description',
  447.         PDERROR_UNKNOWN_COMMANDLINE => 'Unknown command-line option "%s" encountered, use phpdoc -h for help',
  448.         PDERROR_NEED_WHITESPACE => 'phpDocumentor programmer error - wordparser whitespace set to false in handleDocBlock, notify developers.  You should never see this error',
  449.         PDERROR_SOURCE_TAG_FUNCTION_NOT_FOUND => '{@source} tag used in a docblock that isn\'t preceding a function',
  450.         PDERROR_UNMATCHED_LIST_TAG => 'unmatched ol or ul tag in DocBlock, parsing will be incorrect',
  451.         PDERROR_CANT_NEST_IN_B => 'Can\'t nest a code, pre, ul, or ol tag in a b tag in phpDocumentor DocBlock (%s tag nested)',
  452.         PDERROR_UNMATCHED_TUTORIAL_TAG => 'While parsing extended documentation, "%s" tag was matched with "%s" endtag, missing endtag'."\ntag contents:\"%s\"",
  453.         PDERROR_CANT_HAVE_INLINE_IN_TAGNAME => 'Can\'t have an inline tag inside a package page XML tag!',
  454.         PDERROR_TUTORIAL_IS_OWN_CHILD => 'Tutorial %s lists itself as its own child in %s, illegal',
  455.         PDERROR_TUTORIAL_IS_OWN_GRANDPA => 'Tutorial %s\'s child %s lists %s as its child in %s, illegal',
  456.         PDERROR_PDFFUNCTION_NO_FUNC => 'Invalid pdffunction syntax: "<pdffunction: />", should be "<pdffunction:functionname [arg="value"...]/>"',
  457.         PDERROR_PDF_TEMPVAR_DOESNT_EXIST => '<pdffunction:%s arg=%s /> called but temporary variable "%s" doesn\'t exist',
  458.         PDERROR_UNTERMINATED_ATTRIB => 'Tutorial tag %s attribute %s is unterminated, current value "%s"',
  459.         PDERROR_NO_CONVERTER_HANDLER => 'Handler for element of type "%s" called, but %s is not a method of %s',
  460.         PDERROR_INLINETAG_IN_SEE => 'Inline tags are not allowed in a @see tag',
  461.         PDERROR_ID_MUST_BE_INLINE => '<%s id="%s"> must be <%s id="{@id %s}">',
  462.         PDERROR_INTERNAL_NOT_CLOSED => '{@internal was never terminated with }}',
  463.         PDERROR_CONVERTER_OVR_GFCT => 'Converter "%s" must override getFormattedClassTrees() but doesn\'t',
  464.         PDERROR_TEXT_OUTSIDE_LI => 'Text cannot be outside of li tag in a DocBlock list, parsing will be incorrect',
  465.         PDERROR_UNCLOSED_TAG => 'Unclosed %s tag in DocBlock, parsing will be incorrect',
  466.         PDERROR_TAG_NOT_HANDLED => '"%s" tag is not available in PHP versions less than 4.3.0, tag ignored',
  467.         PDERROR_MALFORMED_TAG => '"%s" tag was used without any parameters, illegal',
  468.         PDERROR_MULTIPLE_CATEGORY_TAGS => 'package has multiple @category tags, ignoring "@category %s"',
  469.         PDERROR_TEMPLATEDIR_DOESNT_EXIST => 'template directory "%s" does not exist',
  470.         PDERROR_UNTERMINATED_ENTITY => 'entity &%s is unterminated',
  471.         PDERROR_FUNCTION_HAS_NONAME => 'function has no name (PHP error - test your file before parsing!)',
  472.         PDERROR_CANNOT_EXTEND_SELF => 'class %s cannot extend itself - TEST YOUR CODE BEFORE PARSING',
  473.         PDERROR_DUMB_USES => '@uses can only link to string data',
  474.         PDERROR_UL_IN_UL => 'ul/ol tags cannot be directly nested inside ul/ol, nest inside li',
  475.         PDERROR_INVALID_VALUES => 'command %s was passed "%s" but must be one of %s',
  476.         PDERROR_NESTED_INTERNAL => '{@internal}} cannot be nested inside {@internal}}',
  477.         );
  478.  
  479. /**
  480.  * encapsulates warning information
  481.  * @package phpDocumentor
  482.  * @subpackage Errors
  483.  */
  484. class RecordWarning
  485. {
  486.     /**
  487.      * name of global variable that descriptors for this warning/error is kept
  488.      * @var string 
  489.      */
  490.     var $type = 'phpDocumentor_warning_descrip';
  491.     /**
  492.      * file this error occurred in
  493.      * @var string 
  494.      */
  495.     var $file = false;
  496.     /**
  497.      * line number of the file this error occurred in
  498.      * @var integer 
  499.      */
  500.     var $linenum;
  501.     /**
  502.      * error string
  503.      * @var string 
  504.      */
  505.     var $data;
  506.     /**
  507.      * error number
  508.      * @see Errors.inc
  509.      * @var string 
  510.      */
  511.     var $num;
  512.     /**
  513.      * @param string $file filename this error occurred in ({@link $file})
  514.      * @param integer $linenum line number this error occurred on ({@link $linenum})
  515.      * @param integer $num Error number defined in {@link Errors.inc}
  516.      * @param string $data... variable number of strings, up to 4, to sprintf based on the error number
  517.      */
  518.     function RecordWarning($file,$linenum,$num)
  519.     {
  520.         $this->file = $file;
  521.         $this->linenum = $linenum;
  522.         $a = array('','','','');
  523.         if (func_num_args()>3)
  524.         {
  525.             for($i=3;$i<func_num_args();$i++)
  526.             {
  527.                 $a[$i - 3] = func_get_arg($i);
  528.             }
  529.         }
  530.  
  531.         $this->num = $num;
  532.         $this->data = sprintf($GLOBALS[$this->type][$this->num],$a[0],$a[1],$a[2],$a[3]);
  533.         $this->output();
  534.     }
  535.     
  536.     /**
  537.      * prints the warning
  538.      */
  539.     function output($string = false)
  540.     {
  541.         if ($string)
  542.         {
  543.             if ($this->file)
  544.             return "WARNING in $this->file on line $this->linenum: $this->data\n";
  545.             else
  546.             return "WARNING: $this->data\n";
  547.         }
  548.         if ($this->file)
  549.         phpDocumentor_out("WARNING in $this->file on line $this->linenum: $this->data\n");
  550.         else
  551.         phpDocumentor_out("WARNING: $this->data\n");
  552.         flush();
  553.     }
  554. }
  555.  
  556. /**
  557.  * encapsulates error information
  558.  * @package phpDocumentor
  559.  * @subpackage Errors
  560.  */
  561. class RecordError extends RecordWarning
  562. {
  563.     /**
  564.      * name of global variable that descriptors for this warning/error is kept
  565.      * @var string 
  566.      */
  567.     var $type = 'phpDocumentor_error_descrip';
  568.  
  569.     /**
  570.      * prints the error
  571.      */
  572.     function output($string = false)
  573.     {
  574.         if ($string)
  575.         {
  576.             if ($this->file)
  577.             return "\n\tERROR in $this->file on line $this->linenum: $this->data\n";
  578.             else
  579.             return "\n\tERROR: $this->data\n";
  580.         }
  581.         if ($this->file)
  582.         phpDocumentor_out("\n\tERROR in $this->file on line $this->linenum: $this->data\n");
  583.         else
  584.         phpDocumentor_out("\n\tERROR: $this->data\n");
  585.         flush();
  586.     }
  587. }
  588.  
  589. /**
  590.  * contains all the errors/warnings
  591.  * @see $errors, $warnings
  592.  * @package phpDocumentor
  593.  * @subpackage Errors
  594.  */
  595. class ErrorTracker
  596. {
  597.     /**
  598.      * array of {@link RecordError}s
  599.      * @var array 
  600.      */
  601.     var $errors = array();
  602.     /**
  603.      * array of {@link RecordWarning}s
  604.      * @var array 
  605.      */
  606.     var $warnings = array();
  607.     /**
  608.      * @var string 
  609.      */
  610.     var $curfile = '';
  611.     /**
  612.      * @var integer 
  613.      */
  614.     var $linenum = 0;
  615.     
  616.     /**
  617.      * index in {@link $errors} of last error triggered
  618.      * @var integer|false
  619.      */
  620.     var $lasterror = false;
  621.     
  622.     /**
  623.      * index in {@link $warnings} of last warning triggered
  624.      * @var integer|false
  625.      */
  626.     var $lastwarning = false;
  627.     
  628.     /**
  629.      * This function subscribes to two events in the Parser in order to keep track of line number information and file name.
  630.      * @param integer $num parser-passed event (see {@link PHPDOCUMENTOR_EVENT_NEWLINENUM, PHPDOCUMENTOR_EVENT_NEWFILE})
  631.      * @param mixed $data either a line number if $num is PHPDOCUMENTOR_EVENT_NEWLINENUM or a file name if $num is PHPDOCUMENTOR_EVENT_NEWFILE
  632.      */
  633.     function handleEvent($num,$data)
  634.     {
  635.         switch($num)
  636.         {
  637.             case PHPDOCUMENTOR_EVENT_NEWLINENUM :
  638.                 $this->linenum = $data;
  639.             break;
  640.             case PHPDOCUMENTOR_EVENT_NEWFILE :
  641.                 $this->linenum = 0;
  642.                 $this->curfile = $data;
  643.             break;
  644.             // debugging
  645.             case 1000000635 :
  646.                 phpDocumentor_out($this->curfile.' has '.$this->linenum.' lines'."\n");
  647.                 flush();
  648.             break;
  649.         }
  650.     }
  651.  
  652.     /**
  653.      * add a new warning to the {@link $warnings} array
  654.      * @param integer $num error number from {@link Errors.inc}
  655.      * @param string $data... up to 4 string parameters to sprintf() into the error string for error number $num
  656.      */
  657.     function addWarning($num)
  658.     {
  659.         $a = array('','','','');
  660.         if (func_num_args()>1)
  661.         {
  662.             for($i=1;$i<func_num_args();$i++)
  663.             {
  664.                 $a[$i - 1] = func_get_arg($i);
  665.             }
  666.         }
  667.         $this->warnings[] = new RecordWarning($this->curfile,$this->linenum,$num,$a[0],$a[1],$a[2],$a[3]);
  668.         $this->lastwarning = count($this->warnings) - 1;
  669.     }
  670.  
  671.     /**
  672.      * add a new error to the {@link $errors} array
  673.      * @param integer $num error number from {@link Errors.inc}
  674.      * @param string $data... up to 4 string parameters to sprintf() into the error string for error number $num
  675.      */
  676.     function addError($num)
  677.     {
  678.         $a = array('','','','');
  679.         if (func_num_args()>1)
  680.         {
  681.             for($i=1;$i<func_num_args();$i++)
  682.             {
  683.                 $a[$i - 1] = func_get_arg($i);
  684.             }
  685.         }
  686.         $this->errors[] = new RecordError($this->curfile,$this->linenum,$num,$a[0],$a[1],$a[2],$a[3]);
  687.         $this->lasterror = count($this->errors) - 1;
  688.     }
  689.     
  690.     /**
  691.      * add a new error to the {@link $errors} array and returns the error string
  692.      * @param integer $num error number from {@link Errors.inc}
  693.      * @param string $data... up to 4 string parameters to sprintf() into the error string for error number $num
  694.      */
  695.     function addErrorReturn($num)
  696.     {
  697.         $a = array('','','','');
  698.         if (func_num_args()>1)
  699.         {
  700.             for($i=1;$i<func_num_args();$i++)
  701.             {
  702.                 $a[$i - 1] = func_get_arg($i);
  703.             }
  704.         }
  705.         $this->errors[] = new RecordError($this->curfile,$this->linenum,$num,$a[0],$a[1],$a[2],$a[3],false);
  706.         $this->lasterror = count($this->errors) - 1;
  707.     }
  708.     
  709.     /**
  710.      * Get sorted array of all warnings in parsing/conversion
  711.      * @return array 
  712.      */
  713.     function &returnWarnings()
  714.     {
  715.         usort($this->warnings,array($this,"errorsort"));
  716.         return $this->warnings;
  717.     }
  718.     
  719.     /**
  720.      * Get sorted array of all non-fatal errors in parsing/conversion
  721.      * @return array 
  722.      */
  723.     function &returnErrors()
  724.     {
  725.         usort($this->errors,array($this,"errorsort"));
  726.         return $this->errors;
  727.     }
  728.     
  729.     /**
  730.      * @access private
  731.      * @param RecordError|RecordWarning
  732.      * @param RecordError|RecordWarning
  733.      */
  734.     function errorsort($a, $b)
  735.     {
  736.         if (!$a->file) return -1;
  737.         if (!$b->file) return 1;
  738.         if ($a->file == $b->file)
  739.         {
  740.             if ($a->linenum == $b->linenum) return 0;
  741.             if ($a->linenum < $b->linenum) return -1;
  742.             return 1;
  743.         }
  744.         return strnatcasecmp($a->file,$b->file);
  745.     }
  746.     
  747.     /**
  748.      * Get the error message of the last error
  749.      * @return string 
  750.      */
  751.     function returnLastError()
  752.     {
  753.         return $this->errors[$this->lasterror]->output(true);
  754.     }
  755.  
  756.     /**
  757.      * Get the warning message of the last warning
  758.      * @return string 
  759.      */
  760.     function returnLastWarning()
  761.     {
  762.         return $this->warnings[$this->lastwarning]->output(true);
  763.     }
  764. }
  765.  
  766. /**
  767.  * @global ErrorTracker $GLOBALS['phpDocumentor_errors'] 
  768.  * @name $phpDocumentor_errors
  769.  */
  770. $GLOBALS['phpDocumentor_errors'] = new ErrorTracker;
  771.  
  772. /**
  773.  * @param integer $num error number from {@link Errors.inc}
  774.  * @param string $data... up to 4 string parameters to sprintf() into the error string for error number $num
  775.  * @see ErrorTracker::addError()
  776.  */
  777. function addError($num)
  778. {
  779.     global $phpDocumentor_errors;
  780.     $a = array('','','','');
  781.     if (func_num_args()>1)
  782.     {
  783.         for($i=1;$i<func_num_args();$i++)
  784.         {
  785.             $a[$i - 1] = func_get_arg($i);
  786.         }
  787.     }
  788.     $phpDocumentor_errors->addError($num,$a[0],$a[1],$a[2],$a[3]);
  789. }
  790.  
  791. /**
  792.  * like {@link addError()} but exits parsing
  793.  * @param integer $num error number from {@link Errors.inc}
  794.  * @param string $data... up to 4 string parameters to sprintf() into the error string for error number $num
  795.  * @global ErrorTracker repository for all errors generated by phpDocumentor
  796.  * @see ErrorTracker::addError()
  797.  */
  798. function addErrorDie($num)
  799. {
  800.     global $phpDocumentor_errors;
  801.     $a = array('','','','');
  802.     if (func_num_args()>1)
  803.     {
  804.         for($i=1;$i<func_num_args();$i++)
  805.         {
  806.             $a[$i - 1] = func_get_arg($i);
  807.         }
  808.     }
  809.     $phpDocumentor_errors->addErrorReturn($num,$a[0],$a[1],$a[2],$a[3]);
  810.     die($phpDocumentor_errors->returnLastError());
  811. }
  812.  
  813. /**
  814.  * @param integer $num warning number from {@link Errors.inc}
  815.  * @param string $data... up to 4 string parameters to sprintf() into the error string for error number $num
  816.  * @global ErrorTracker repository for all errors generated by phpDocumentor
  817.  * @see ErrorTracker::addWarning()
  818.  */
  819. function addWarning($num)
  820. {
  821.     global $phpDocumentor_errors;
  822.     $a = array('','','','');
  823.     if (func_num_args()>1)
  824.     {
  825.         for($i=1;$i<func_num_args();$i++)
  826.         {
  827.             $a[$i - 1] = func_get_arg($i);
  828.         }
  829.     }
  830.  
  831.     $phpDocumentor_errors->addWarning($num,$a[0],$a[1],$a[2],$a[3]);
  832. }
  833. ?>
Documentation generated on Tue, 24 Oct 2006 09:22:26 -0500 by phpDocumentor 1.3.1