Source for file IntermediateParser.inc

Documentation is available at IntermediateParser.inc

  1. <?php
  2. /**
  3.  * The phpDocumentor_IntermediateParser Class
  4.  *
  5.  * The Intermediary Data Parser (intermediate between Parse and Converter)
  6.  *
  7.  * phpDocumentor :: automatic documentation generator
  8.  *
  9.  * PHP versions 4 and 5
  10.  *
  11.  * Copyright (c) 2002-2006 Gregory Beaver
  12.  *
  13.  * LICENSE:
  14.  *
  15.  * This library is free software; you can redistribute it
  16.  * and/or modify it under the terms of the GNU Lesser General
  17.  * Public License as published by the Free Software Foundation;
  18.  * either version 2.1 of the License, or (at your option) any
  19.  * later version.
  20.  *
  21.  * This library is distributed in the hope that it will be useful,
  22.  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  23.  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  24.  * Lesser General Public License for more details.
  25.  *
  26.  * You should have received a copy of the GNU Lesser General Public
  27.  * License along with this library; if not, write to the Free Software
  28.  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
  29.  *
  30.  * @package    phpDocumentor
  31.  * @author     Gregory Beaver <cellog@php.net>
  32.  * @copyright  2002-2006 Gregory Beaver
  33.  * @license    http://www.opensource.org/licenses/lgpl-license.php LGPL
  34.  * @version    CVS: $Id: IntermediateParser.inc 317234 2011-09-24 05:03:55Z ashnazg $
  35.  * @filesource
  36.  * @link       http://www.phpdoc.org
  37.  * @link       http://pear.php.net/PhpDocumentor
  38.  * @since      1.1
  39.  */
  40. /** The phpDocumentor_IntermediateParser Class
  41.  *
  42.  * This class performs the work of organizing raw data from the parser in the
  43.  * format of descendants of the {@link parserElement} class.  This is also where
  44.  * processing of package pages occurs, in
  45.  * {@link phpDocumentor_IntermediateParser::handleClass()} for class-level
  46.  * packages and {@link phpDocumentor_IntermediateParser::handleDocBlock()} for
  47.  * page-level packages.
  48.  *
  49.  * Most of the work of this parser goes to matching up
  50.  * DocBlocks with the elements that they are documenting.  Since DocBlocks are
  51.  * passed before the element they document, the last DocBlock is stored in
  52.  * {@link phpDocumentor_IntermediateParser::$last} and then placed into the
  53.  * $docblock parameter of the parserElement
  54.  * descendant object.
  55.  *  @author Gregory Beaver
  56.  *  @version $Id: IntermediateParser.inc 317234 2011-09-24 05:03:55Z ashnazg $
  57.  *  @copyright 2002 Gregory Beaver
  58.  *  @package     phpDocumentor
  59.  */
  60. {
  61.     /**
  62.      * @var parserDocBlock 
  63.      */
  64.     var $last;
  65.  
  66.     /**
  67.      * type of the last parser Element handled
  68.      *
  69.      * This is used in handleDocBlock to determine whether a DocBlock is a
  70.      * page-level DocBlock in conjunction with the {@link parserData::$clean}
  71.      * var.  A page-level DocBlock is alwaysthe first DocBlock in a file, and
  72.      * must be followed by another DocBlock.  The first test is handled by
  73.      * parserData::$clean, which is set to false on the first encounter of an
  74.      * element, and the second test is handled by this variable, which must be
  75.      * equal to "docblock"
  76.      * @see handleDocBlock()
  77.      * @var string 
  78.      */
  79.     var $lasttype = '';
  80.  
  81.     /**
  82.      * Name of the class currently being parsed.
  83.      * It is only used (and only valid) when phpDocumentor_IntermediateParser is
  84.      * parsing a class
  85.      * @var string 
  86.      */
  87.     var $cur_class = '';
  88.  
  89.     /**
  90.      * type of the current parser Element being handled
  91.      *
  92.      * This is used by {@link HandleEvent()} to set the {@link $lasttype} var,
  93.      * which is used to detect page-level DocBlocks
  94.      * @var string 
  95.      */
  96.     var $type = '';
  97.  
  98.     /**
  99.      * set in {@link Setup.inc.php} to the value of the parseprivate commandline
  100.      * option.  If this option is true, elements with an @access private tag
  101.      * will be parsed and displayed
  102.      * @tutorial phpDocumentor.howto.pkg#using.command-line.parseprivate
  103.      * @var boolean 
  104.      */
  105.     var $parsePrivate = false;
  106.  
  107.     /**
  108.      * this variable is used to prevent parsing of elements with an @ignore tag
  109.      * @see $packageoutput
  110.      * @see $parsePrivate
  111.      */
  112.     var $private_class = false;
  113.  
  114.     /**
  115.      * used to set the output directory
  116.      * @see setTargetDir()
  117.      */
  118.     var $targetDir;
  119.  
  120.     /**
  121.      * used to set the template base directory
  122.      * @see setTemplateBase()
  123.      */
  124.     var $templateBase;
  125.  
  126.     /**
  127.      * array of parsed package pages
  128.      *
  129.      * used by {@link Convert()} to convert all package pages into output
  130.      * @var array 
  131.      */
  132.     var $package_pages = array();
  133.  
  134.     /**
  135.      * @var array array of all {@link parserData} containing page information
  136.      */
  137.     var $pages = array();
  138.     /**
  139.      * Put away a page that has been @ignored or @access private if
  140.      * !{@link $parsePrivate}
  141.      *
  142.      * When a page has @access private in its DocBlock, it is placed here
  143.      * instead of in {@link $pages}, to allow for proper Class parsing.  Since
  144.      * classes and pages are parsed as if they were separate, this array allows
  145.      * public classes on private pages to retrieve information needed about the
  146.      * page that holds the class and to {@link addPageIfNecessary()} to the
  147.      * $pages array
  148.      * @var array 
  149.      */
  150.     var $privatepages = array();
  151.     /**
  152.      * Keeps track of packages of classes that have parent classes in another
  153.      * package.  Used in automatic linking.
  154.      *
  155.      * This array is updated by {@link addPackageParent()}, which is called in
  156.      * {@link Classes::processChild()} to keep track of classes that descend
  157.      * from classes in different packages.  In other words, if class foo is in
  158.      * package one, and class bar is in package two, an entry
  159.      * $package_parents['two'] = 'one' will be made.
  160.      * @var array Format: packagename => parentpackagename
  161.      * @see Converter::getLink()
  162.      */
  163.     var $package_parents = array();
  164.  
  165.     /**
  166.      * Used to determine the category for tutorials.
  167.      *
  168.      * <b>WARNING:</b> If more than one category exists, the last category
  169.      * encountered will overwrite the previous and will raise a big warning
  170.      * @var array Format: packagename => categoryname
  171.      */
  172.     var $packagecategories = array();
  173.  
  174.     /**
  175.      * list of all packages encountered while documenting.  Used in automatic
  176.      * linking.
  177.      *
  178.      * Converter::getLink() first checks if an ambiguous link is found in the
  179.      * current package.  If not, it then checks in parent packages, and if still
  180.      * not found, uses this array to check in the rest of the packages before
  181.      * giving up
  182.      * @var array Format: array(packagename => 1, packagename => 1,...)
  183.      * @see Converter::getLink()
  184.      */
  185.     var $all_packages = array();
  186.  
  187.     /**
  188.      * array of packages to parser and output documentation for, if not all
  189.      * packages should be documented
  190.      *
  191.      * Format:<br />
  192.      * array(package1,package2,...)<br />
  193.      * or false if not set
  194.      *
  195.      * Use this option to limit output similar to ignoring files.  If you have
  196.      * some temporary files that you don't want to specify by name but don't
  197.      * want included in output, set a package name for all the elements in your
  198.      * project, and set packageoutput to that name.  the default package will be
  199.      * ignored.  Parsing speed does not improve.  If you want to ignore files
  200.      * for speed reasons, use the ignore command-line option
  201.      * @tutorial phpDocumentor.howto.pkg#using.command-line.packageoutput
  202.      * @see Io
  203.      * @var false|array
  204.      */
  205.     var $packageoutput = false;
  206.  
  207.     /**
  208.      * the functions which handle output from the {@link Parser}
  209.      * @see handleEvent(), handleDocBlock(), handlePage(), handleClass()
  210.      * @see handleDefine(), handleFunction(), handleMethod(), handleVar()
  211.      * @see handlePackagePage(), handleInclude(), handleTutorial()
  212.      */
  213.     var $event_handlers = array(
  214.             'docblock' => 'handleDocBlock',
  215.             'page' => 'handlePage',
  216.             'class' => 'handleClass',
  217.             'define' => 'handleDefine',
  218.             'function' => 'handleFunction',
  219.             'method' => 'handleMethod',
  220.             'var' => 'handleVar',
  221.             'const' => 'handleConst',
  222.             'packagepage' => 'handlePackagePage',
  223.             'include' => 'handleInclude',
  224.             'global' => 'handleGlobal',
  225.             'tutorial' => 'handleTutorial',
  226.             );
  227.  
  228.     /**
  229.      * $data contains parsed structures for the current page being parsed
  230.      *
  231.      * In version 1.1+, $data is only used to store the current page information.
  232.      * All handling of documented elements is handled by the
  233.      * {@link ProceduralPages} and {@link Classes} classes.
  234.      * @var parserData 
  235.      */
  236.     var $data;
  237.  
  238.     /**
  239.      * set in {@link Setup.inc.php} to the value of the quitemode commandline
  240.      * option.
  241.      *
  242.      * If this option is true, informative output while parsing will not be
  243.      * displayed (documentation is unaffected)
  244.      * @var boolean 
  245.      * @tutorial phpDocumentor.howto.pkg#using.command-line.quiet
  246.      */
  247.     var $quietMode = false;
  248.  
  249.     /**
  250.      * set in {@link Setup.inc.php} to the value of the undocumentedElementWarnings commandline
  251.      * option.
  252.      *
  253.      * If this option is true, warnings about certain elements (classes, methods)
  254.      * that are not documented with DocBlocks will be shown while parsing,
  255.      * and will also be displayed in the errors.html page
  256.      * (other documentation is unaffected)
  257.      * @var boolean 
  258.      * @tutorial phpDocumentor.howto.pkg#using.command-line.undocumentedelements
  259.      */
  260.     var $undocumentedElementWarnings = false;
  261.  
  262.     /**
  263.      * used to keep track of inheritance at the smartest level possible for a
  264.      * dumb computer
  265.      * @var Classes 
  266.      */
  267.     var $classes = false;
  268.  
  269.     /**
  270.      * used to keep track of all elements in a procedural page.  Handles name
  271.      * conflicts with elegance
  272.      * @since 1.1
  273.      * @var ProceduralPages 
  274.      */
  275.     var $proceduralpages = false;
  276.  
  277.     /**
  278.      * an array of template names indexed by converter name
  279.      *
  280.      * For example, if the default HTMLframesConverter is using the DOM/l0l33t
  281.      * template, the array will be
  282.      * <code>$converters['frames'] = 'DOM/l0l33t'</code>
  283.      * @var array Format: array(Convertername1 => templatename)
  284.      * @see Converter
  285.      */
  286.     var $converters = false;
  287.     /**
  288.      * @var string Title of generated documentation, passed to Converters
  289.      */
  290.     var $title = '';
  291.  
  292.     var $uses = array();
  293.  
  294.     var $db_template;
  295.  
  296.     /**
  297.      * Stores parsed CHANGELOG/INSTALL/README files
  298.      * @var array Format: array(CHANGELOG => contents,
  299.      *                           INSTALL => contents,
  300.      *                           README => contents)
  301.      */
  302.     var $ric = array();
  303.  
  304.     /**
  305.      * Flag used to determine whether the last docblock
  306.      * was a page-level docblock.
  307.      * @var boolean 
  308.      * @access private
  309.      */
  310.     var $_lastDocBlockWasPageLevel false;
  311.  
  312.     /**
  313.      * Flag used to determine whether the Page-level
  314.      * DocBlock was declared in old or new style
  315.      * @var boolean 
  316.      * @access private
  317.      */
  318.     var $_oldPageLevel false;
  319.  
  320.     /**
  321.      * sets up basic data structures
  322.      * @param string Title of generated documentation, passed to Converters
  323.      * @see $title, $data, $classes, $proceduralpages
  324.      */
  325.     function phpDocumentor_IntermediateParser($title='Generated Documentation')
  326.     {
  327.         $this->title = $title;
  328.         $this->data = new parserData;
  329.         $this->classes = new Classes;
  330.         $this->proceduralpages = new ProceduralPages;
  331.     }
  332.  
  333.     /**
  334.      * Retrieve the relative path.  If the path contains "pear/" it will
  335.      * be used as the base, otherwise the Program_Root string will be used.
  336.      * @global array uses 'Program_Root' option to replace it with '' for
  337.      *                retrieving the source location of a file
  338.      * @param string path to file
  339.      * @return string 
  340.      * @see $sourceLocation
  341.      * @access private
  342.      */
  343.     function _getSourceLocation($sl$sourceloc)
  344.     {
  345.         global $_phpDocumentor_options;
  346.         if (empty($sl)) return false;
  347.         $sl str_replace('\\','/',$sl);
  348.         if (strpos($sl,'pear/'))
  349.         {
  350.             $sl substr($sl,strpos($sl,'pear/'5);
  351.             if (dirname($sl== '.')
  352.             {
  353.                 return 'PEAR';
  354.             }
  355.             return dirname($sl);
  356.         else
  357.         {
  358.             if (strpos(str_replace($_phpDocumentor_options['Program_Root'PATH_DELIMITER,'',$sourceloc),PATH_DELIMITER=== false)
  359.                 return '';
  360.             return dirname(str_replace($_phpDocumentor_options['Program_Root'PATH_DELIMITER,'',$sourceloc));
  361.         }
  362.     }
  363.  
  364.     /**
  365.      * Guess the package/subpackage based on subdirectory if the --pear option
  366.      *
  367.      * A file in pear/dir/file.php will be in package "dir."  A file in
  368.      * pear/dir/subdir/file.php will be in package "dir," subpackage "subdir."
  369.      * @param string full path of file
  370.      * @param template-ready source location Program_Root/dir/file.php
  371.      * @global array uses the 'pear' option to determine whether to guess based
  372.      *                on subdirectory
  373.      * @tutorial phpDocumentor.howto.pkg#using.command-line.pear
  374.      */
  375.     function _guessPackage($path$sourceloc)
  376.     {
  377.         global $_phpDocumentor_setting;
  378.         if (isset($_phpDocumentor_setting['pear']&& $_phpDocumentor_setting['pear'])
  379.         {
  380.             $subpath explode(PATH_DELIMITER$this->_getSourceLocation($path$sourceloc));
  381.             if (!empty($subpath[0]))
  382.             // can only have package and subpackage in this version
  383.                 $package $subpath[0];
  384.                 $subpackage '';
  385.                 if (isset($subpath[1])) $subpackage $subpath[1];
  386.                 return array($package,$subpackage);
  387.             else return array($this->package$this->subpackage);
  388.         else return array($this->package$this->subpackage);
  389.     }
  390.  
  391.     /**
  392.      * handles post-parsing of include/require/include_once/require_once
  393.      *
  394.      * This function sets {@link $data}->clean to false to tell the
  395.      * phpDocumentor_IntermediateParser that a page-level DocBlock can't be
  396.      * found after this point on this page.  It then sets the package
  397.      * to be the same as the page, and adds itself to the
  398.      * {@link ProceduralPages} class
  399.      * @param integer $event Event number from {@link Parser.inc}
  400.      * @param parserInclude $data 
  401.      */
  402.     function handleInclude($event,$data)
  403.     {
  404.         if ($this->_lastDocBlockWasPageLevel)
  405.         {
  406.             addWarning(PDERROR_DOCBLOCK_CONFLICT$data->getName()$data->getValue());
  407.             if (!$this->_oldPageLevel)
  408.             {
  409.                 unset($this->last);
  410.             }
  411.         }
  412.         $this->_lastDocBlockWasPageLevel false;
  413.         $this->data->clean = false;
  414.         // page was @ignored
  415.         if ($this->private_page)
  416.         {
  417.             unset($this->last);
  418.             return;
  419.         }
  420.         if (empty($this->last))
  421.         {
  422.             if (isset($this->db_template))
  423.             {
  424.                 // use the docblock template
  425.                 $this->last = phpDocumentor_clone($this->db_template);
  426.             }
  427.             else
  428.             {
  429.                 // we don't have a docblock, create an empty one to get rid of errors
  430.                 $this->last = new parserDocblock();
  431.             }
  432.         }
  433. //        $this->last->setLineNumber($data->getLineNumber());
  434.         if ($this->last->getKeyword('ignore'))
  435.         {
  436.             $this->last = false;
  437.             return;
  438. //            addWarning(PDERROR_IGNORE_TAG_IGNORED,'include',$data->getName().'('.$data->getValue().')');
  439.         }
  440.  
  441.         $this->last->overridePackage($this->category,$this->package,$this->subpackage,$data->getName(),'include');
  442.         $data->setDocBlock($this->last);
  443.         $this->proceduralpages->addInclude($data);
  444.         $this->last = false;
  445.     }
  446.  
  447.     /**
  448.      * handles post-parsing of global variables
  449.      *
  450.      * This function sets {@link $data}->clean to false to tell the
  451.      * phpDocumentor_IntermediateParser that a page-level DocBlock can't be
  452.      * found after this point on this page.  It then sets the package
  453.      * to be the same as the page, and adds itself to the
  454.      * {@link ProceduralPages} class
  455.      * @param integer $event Event number from {@link Parser.inc}
  456.      * @param parserGlobal $data 
  457.      */
  458.     function handleGlobal($event,$data)
  459.     {
  460.         if ($this->_lastDocBlockWasPageLevel)
  461.         {
  462.             addWarning(PDERROR_DOCBLOCK_CONFLICT'global variable'$data->getName());
  463.             if (!$this->_oldPageLevel)
  464.             {
  465.                 unset($this->last);
  466.             }
  467.         }
  468.         $this->_lastDocBlockWasPageLevel false;
  469.         $this->data->clean = false;
  470.         if ($this->private_page)
  471.         {
  472.             unset($this->last);
  473.             return;
  474.         }
  475.         if (empty($this->last))
  476.         {
  477.             if (isset($this->db_template))
  478.             {
  479.                 // use the docblock template
  480.                 $this->last = phpDocumentor_clone($this->db_template);
  481.             }
  482.             else
  483.             {
  484.                 // we don't have a docblock, create an empty one to get rid of errors
  485.                 $this->last = new parserDocblock();
  486.             }
  487.         }
  488. //        $this->last->setLineNumber($data->getLineNumber());
  489.         if ($this->last->getKeyword('ignore'))
  490.         {
  491.             addWarning(PDERROR_IGNORE_TAG_IGNORED,'global variable - just don\'t document the',$data->getName());
  492.             $this->last = false;
  493.             return;
  494.         }
  495.         $this->last->overridePackage($this->category,$this->package,$this->subpackage,$data->getName(),'global');
  496.         $data->setDocBlock($this->last);
  497.         if ($data->docblock->getKeyword('name'))
  498.         {
  499.             $a $data->docblock->getKeyword('name');
  500.             if (is_object($a)) $a $a->value;
  501.             $data->setName($a);
  502.         }
  503.         $this->proceduralpages->addGlobal($data);
  504.         $this->last = false;
  505.     }
  506.  
  507.     /**
  508.      * handles post-parsing of Package-level documentation pages.
  509.      *
  510.      * sets the {@link $package_pages}[$data->package] to $data
  511.      * @param integer $event Event number from {@link Parser.inc}
  512.      * @param parserPackagePage $data 
  513.      */
  514.     function handlePackagePage($event,$data)
  515.     {
  516.         $this->package_pages[$data->package&$data;
  517.         $this->last = false;
  518.     }
  519.  
  520.     /**
  521.      * handle post-parsing of Tutorials.
  522.      *
  523.      * This adds the parsed tutorial to the tutorial tree
  524.      * @uses $tutorials sets the value of tutorials to parameter $data
  525.      * @param integer $event Event Number
  526.      * @param parserTutorial $data 
  527.      * @since 1.2
  528.      */
  529.     function handleTutorial($event,$data)
  530.     {
  531.         if (isset($this->packagecategories[$data->package]))
  532.         {
  533.             $data->category $this->packagecategories[$data->package];
  534.         else
  535.         {
  536.             $data->category $GLOBALS['phpDocumentor_DefaultCategoryName'];
  537.         }
  538.         $this->tutorials[$data->package][$data->subpackage][$data->tutorial_type][$data->name$data;
  539.     }
  540.  
  541.     /**
  542.      * handles post-parsing of class vars
  543.      *
  544.      * This function sets up a @var tag if none is found, and aligns $data's
  545.      * $path var and packages to match the parent object
  546.      * @param integer $event Event number from {@link Parser.inc}
  547.      * @param parserVar $data 
  548.      */
  549.     function handleVar($event,$data)
  550.     {
  551.         global $_phpDocumentor_setting;
  552.         if ($this->private_class)
  553.         {
  554.             unset($this->last);
  555.             return;
  556.         }
  557.         if (empty($this->last))
  558.         {
  559.             if (isset($this->db_template))
  560.             {
  561.                 // use the docblock template
  562.                 $this->last = phpDocumentor_clone($this->db_template);
  563.             }
  564.             else
  565.             {
  566.                 // we don't have a docblock, create an empty one to get rid of errors
  567.                 $this->last = new parserDocblock();
  568.             }
  569.         }
  570. //        $this->last->setLineNumber($data->getLineNumber());
  571.         $this->last->overridePackage($this->category,$this->package,$this->subpackage,$data->getName(),'var');
  572.         $this->last->updateModifiers($data->getModifiers());
  573.  
  574.         if ($this->last->getKeyword('ignore'))
  575.         {
  576.             $this->last = false;
  577.             return;
  578. //            addWarning(PDERROR_IGNORE_TAG_IGNORED,'var',$this->cur_class.'::'.$data->getName());
  579.         }
  580.         if (!$this->last->var)
  581.         {
  582.             $this->last->addVar('mixed',new parserStringWithInlineTags);
  583.         }
  584.  
  585.         if (isset($_phpDocumentor_setting['pear']&& $_phpDocumentor_setting['pear'])
  586.         {
  587.             if (strpos($data->getName()'_'== && !$this->last->getKeyword('access'))
  588.             {
  589.                 addWarning(PDERROR_PRIVATE_ASSUMED,'class variable',$data->class.'::'.$data->getName());
  590.                 $this->last->addKeyword('access','private');
  591.                 $data->setDocBlock($this->last);
  592.             }
  593.         }
  594.         $data->setDocBlock($this->last);
  595.         $data->path $this->data->parent->path;
  596.         $this->classes->addVar($data);
  597.         $this->last = false;
  598.     }
  599.  
  600.     /**
  601.      * handles post-parsing of class constants
  602.      *
  603.      * This function aligns $data's
  604.      * $path var and packages to match the parent object
  605.      * @param integer $event Event number from {@link Parser.inc}
  606.      * @param parserVar $data 
  607.      */
  608.     function handleConst($event,$data)
  609.     {
  610.         global $_phpDocumentor_setting;
  611.         if ($this->private_class)
  612.         {
  613.             unset($this->last);
  614.             return;
  615.         }
  616.         if (empty($this->last))
  617.         {
  618.             if (isset($this->db_template))
  619.             {
  620.                 // use the docblock template
  621.                 $this->last = phpDocumentor_clone($this->db_template);
  622.             }
  623.             else
  624.             {
  625.                 // we don't have a docblock, create an empty one to get rid of errors
  626.                 $this->last = new parserDocblock();
  627.             }
  628.         }
  629. //        $this->last->setLineNumber($data->getLineNumber());
  630.         $this->last->overridePackage($this->category,$this->package,$this->subpackage,$data->getName(),'const');
  631.  
  632.         if ($this->last->getKeyword('ignore'))
  633.         {
  634.             $this->last = false;
  635.             return;
  636. //            addWarning(PDERROR_IGNORE_TAG_IGNORED,'var',$this->cur_class.'::'.$data->getName());
  637.         }
  638.         $data->setDocBlock($this->last);
  639.         $data->path $this->data->parent->path;
  640.         $this->classes->addConst($data);
  641.         $this->last = false;
  642.     }
  643.  
  644.     /**
  645.      * handles post-parsing of class methods
  646.      *
  647.      * This function first aligns $data's path and package to match the parent
  648.      * object, and also aligns the docblock's @param, @global, and @staticvar
  649.      * tags with the information parsed from the method source code.  It also
  650.      * checks to see if the method is a constructor and sets the $isConstructor
  651.      * flag.  If source code has been parsed by a {@}source} tag, the source is
  652.      * added to its docblock
  653.      *
  654.      * Finally, it adds the method to the {@link Classes} class.
  655.      * @param integer $event Event number from {@link Parser.inc}
  656.      * @param parserMethod $data 
  657.      */
  658.     function handleMethod($event,$data)
  659.     {
  660.         global $_phpDocumentor_setting;
  661.         if ($this->private_class)
  662.         {
  663.             unset($this->last);
  664.             return;
  665.         }
  666.  
  667.         if (empty($this->last))
  668.         {
  669.             if ($this->undocumentedElementWarnings)
  670.             {
  671.                 addWarning(PDERROR_UNDOCUMENTED_ELEMENT,'Method',$data->getName(),'method');
  672.             }
  673.             if (isset($this->db_template))
  674.             {
  675.                 // use the docblock template
  676.                 $this->last = phpDocumentor_clone($this->db_template);
  677.             }
  678.             else
  679.             {
  680.                 // we don't have a docblock, create an empty one to get rid of errors
  681.                 $this->last = new parserDocblock();
  682.             }
  683.         }
  684. //        $this->last->setLineNumber($data->getLineNumber());
  685.         if ($this->last->getKeyword('ignore'))
  686.         {
  687.             $this->last = false;
  688.             return;
  689. //            addWarning(PDERROR_IGNORE_TAG_IGNORED,'method',$this->cur_class.'::'.$data->getName());
  690.         }
  691.         $this->last->overridePackage($this->category,$this->package,$this->subpackage,$data->getName(),'method');
  692.         if ($data->hasSource())
  693.         {
  694.             $this->last->setSource($data->getSource()$data->getClass());
  695.         }
  696.         foreach($data->listParams(as $key => $param)
  697.         {
  698.             $update_params[$key$param;
  699.         }
  700.         foreach($data->listGlobals(as $param)
  701.         {
  702.             $update_globals[$param[1];
  703.         }
  704.         foreach($data->listStatics(as $param)
  705.         {
  706.             $update_statics[$param[0];
  707.         }
  708.         if (isset($update_params))
  709.         $this->last->updateParams($update_params);
  710.         if (isset($update_globals))
  711.         $this->last->updateGlobals($update_globals);
  712.         if (isset($update_statics))
  713.         $this->last->updateStatics($update_statics);
  714.         $this->last->updateModifiers($data->getModifiers());
  715.         unset($update_params);
  716.         unset($update_globals);
  717.         unset($update_statics);
  718.  
  719.         if ($data->getName(== $this->cur_class$data->setConstructor();
  720.         if ($data->getName(== '__construct'{
  721.             $data->setConstructor();
  722.         }
  723.         if ($data->getName(== '__destruct'{
  724.             $data->setDestructor();
  725.         }
  726.  
  727.         if (isset($_phpDocumentor_setting['pear']&& $_phpDocumentor_setting['pear'])
  728.         {
  729.             if (strpos($data->getName()'_'=== && substr($data->getName()1== $data->class)
  730.             // is destructor
  731.                 $data->setDestructor();
  732.             elseif (strpos($data->getName()'_'=== && !$this->last->getKeyword('access'))
  733.             {
  734.                 if (strpos($data->getName()'__'!== 0{
  735.                     addWarning(PDERROR_PRIVATE_ASSUMED,'method',$data->class.'::'.$data->getName().'()');
  736.                     $this->last->addKeyword('access','private');
  737.                     $data->setDocBlock($this->last);
  738.                 }
  739.             }
  740.         }
  741.         $data->setDocBlock($this->last);
  742.         $data->path $this->data->parent->path;
  743.         $this->classes->addMethod($data);
  744.         $this->last = false;
  745.     }
  746.  
  747.     /**
  748.      * handles post-parsing of functions
  749.      *
  750.      * This function sets {@link $data}->clean to false to tell the
  751.      * phpDocumentor_IntermediateParser that a page-level DocBlock can't be
  752.      * found after this point on this page.  It then sets the package to be the
  753.      * same as the page, aligns the docblock's @param, @global, and @staticvar
  754.      * tags with the information parsed from the function source code.
  755.      *
  756.      * If source code has been parsed by a {@}source} tag, the source is added
  757.      * to its docblock, and then the parserFunction adds itself to the
  758.      * {@link ProceduralPages} class
  759.      * @param integer $event Event number from {@link Parser.inc}
  760.      * @param parserFunction $data 
  761.      */
  762.     function handleFunction($event,$data)
  763.     {
  764.         if ($this->_lastDocBlockWasPageLevel)
  765.         {
  766.             addWarning(PDERROR_DOCBLOCK_CONFLICT'function'$data->getName());
  767.             if (!$this->_oldPageLevel)
  768.             {
  769.                 unset($this->last);
  770.             }
  771.         }
  772.         $this->_lastDocBlockWasPageLevel false;
  773.         $this->data->clean = false;
  774.         if ($this->private_page)
  775.         {
  776.             unset($this->last);
  777.             return;
  778.         }
  779.  
  780.         if (empty($this->last))
  781.         {
  782.             if (isset($this->db_template))
  783.             {
  784.                 // use the docblock template
  785.                 $this->last = phpDocumentor_clone($this->db_template);
  786.             }
  787.             else
  788.             {
  789.                 // we don't have a docblock, create an empty one to get rid of errors
  790.                 $this->last = new parserDocblock();
  791.             }
  792.         }
  793. //        $this->last->setLineNumber($data->getLineNumber());
  794.         if ($this->last->getKeyword('ignore'))
  795.         {
  796.             unset($this->last);
  797.             return;
  798.         }
  799.         $this->last->overridePackage($this->category,$this->package,$this->subpackage,$data->getName(),'function');
  800.  
  801.         foreach($data->listParams(as $key => $param)
  802.         {
  803.             $update_params[$key$param;
  804.         }
  805.         foreach($data->listGlobals(as $param)
  806.         {
  807.             $update_globals[$param[1];
  808.         }
  809.         foreach($data->listStatics(as $param)
  810.         {
  811.             $update_statics[$param[0];
  812.         }
  813.         if (isset($update_params))
  814.         $this->last->updateParams($update_params);
  815.         if (isset($update_globals))
  816.         $this->last->updateGlobals($update_globals);
  817.         if (isset($update_statics))
  818.         $this->last->updateStatics($update_statics);
  819.         unset($update_params);
  820.         unset($update_globals);
  821.         unset($update_statics);
  822.  
  823.         if ($data->hasSource())
  824.         {
  825.             $this->last->setSource($data->getSource());
  826.         }
  827.         if (count($this->last->params== && !count($data->listParams()))
  828.         {
  829.             // if the function has no parameters, and 1 @param, add it to the list as optional, default value is description from @param
  830.             $pars $this->last->listParams();
  831.             $data->addParam($pars[0]['var'],$pars[0]['data']->getString());
  832.         }
  833.         $data->setDocBlock($this->last);
  834.         $this->proceduralpages->addFunction($data);
  835.         $this->last = false;
  836.     }
  837.  
  838.     /**
  839.      * handles post-parsing of defines
  840.      *
  841.      * This function sets {@link $data}->clean to false to tell the
  842.      * phpDocumentor_IntermediateParser that a page-level DocBlock can't be
  843.      * found after this point on this page.  It then sets the package to be the
  844.      * same as the page and adds itself to the {@link ProceduralPages} class
  845.      * @param integer $event Event number from {@link Parser.inc}
  846.      * @param parserDefine $data 
  847.      */
  848.     function handleDefine($event,$data)
  849.     {
  850.         if ($this->_lastDocBlockWasPageLevel)
  851.         {
  852.             addWarning(PDERROR_DOCBLOCK_CONFLICT'define'$data->getName());
  853.             if (!$this->_oldPageLevel)
  854.             {
  855.                 unset($this->last);
  856.             }
  857.         }
  858.         $this->_lastDocBlockWasPageLevel false;
  859.         $this->data->clean = false;
  860.         if ($this->private_page)
  861.         {
  862.             unset($this->last);
  863.             return;
  864.         }
  865.         if (empty($this->last))
  866.         {
  867.             if (isset($this->db_template))
  868.             {
  869.                 // use the docblock template
  870.                 $this->last = phpDocumentor_clone($this->db_template);
  871.             }
  872.             else
  873.             {
  874.                 // we don't have a docblock, create an empty one to get rid of errors
  875.                 $this->last = new parserDocblock();
  876.             }
  877.         }
  878. //        $this->last->setLineNumber($data->getLineNumber());
  879.         if ($this->last->getKeyword('ignore'))
  880.         {
  881.             unset($this->last);
  882.             return;
  883.         }
  884.  
  885.         $this->last->overridePackage($this->category,$this->package,$this->subpackage,$data->getName(),'define');
  886.         $data->setDocBlock($this->last);
  887.         $this->proceduralpages->addDefine($data);
  888.         $this->last = false;
  889.     }
  890.  
  891.     /**
  892.      * handles post-parsing of classes
  893.      *
  894.      * This function sets {@link $data}->clean to false to tell the
  895.      * phpDocumentor_IntermediateParser that a page-level DocBlock can't be
  896.      * found after this point on this page.  It sets {@link $cur_class} to its
  897.      * name, and if an @ignore tag is found in the DocBlock, it sets
  898.      * {@link $private_class} to true, to prevent post-parsing of any of the
  899.      * class's vars or methods.  Then it checks for the existence of a package
  900.      * page for the class's package
  901.      * @param integer $event Event number from {@link Parser.inc}
  902.      * @param parserClass $data 
  903.      */
  904.     function handleClass($event,$data)
  905.     {
  906.         global $_phpDocumentor_setting;
  907.         if ($data->isInterface())
  908.         {
  909.             $objectType 'interface';
  910.         }
  911.         else
  912.         {
  913.             $objectType 'class';
  914.         }
  915.         if ($this->_lastDocBlockWasPageLevel)
  916.         {
  917.             if (!$this->_oldPageLevel)
  918.             {
  919.                 addWarning(PDERROR_DOCBLOCK_GOES_CLASS$data->getName());
  920.                 $doc new parserDocBlock;
  921.                 $doc->category $this->category;
  922.                 $doc->package $this->package;
  923.                 $doc->subpackage $this->subpackage;
  924.                 if (isset($_phpDocumentor_setting['sourcecode']&&
  925.                     $_phpDocumentor_setting['sourcecode']{
  926.                     $doc->canSource();
  927.                     $doc->addFileSource($this->data->parent->path$this->data->parent->source);
  928.                 }
  929.                 $this->data->setDocBlock($doc);
  930.                 unset($doc);
  931.                 if ($this->last{
  932.                     $this->last->cantSource();
  933.                 }
  934.             }
  935.         }
  936.         $this->_lastDocBlockWasPageLevel false;
  937.         $this->data->clean = false;
  938.         if (empty($this->last))
  939.         {
  940.             if ($this->undocumentedElementWarnings)
  941.             {
  942.                 addWarning(PDERROR_UNDOCUMENTED_ELEMENT,'Class',$data->getName(),'Class');
  943.             }
  944.             if (isset($this->db_template))
  945.             {
  946.                 // use the docblock template
  947.                 $this->last = phpDocumentor_clone($this->db_template);
  948.             }
  949.             else
  950.             {
  951.                 // we don't have a docblock, create an empty one to get rid of errors
  952.                 $this->last = new parserDocblock();
  953.             }
  954.             list($this->last->package$this->last->subpackage$this->_guessPackage($this->data->parent->path$this->data->parent->getSourceLocation('dummy'));
  955.             addWarning(PDERROR_NO_PACKAGE_TAG,$objectType,$data->getName(),$this->last->package);
  956.         else
  957.         {
  958.             if (!$this->last->getExplicitPackage())
  959.             {
  960.                 list($this->last->package$this->last->subpackage$this->_guessPackage($this->data->parent->path$this->data->parent->getSourceLocation('dummy'));
  961.                 addWarning(PDERROR_NO_PACKAGE_TAG,$objectType,$data->getName(),$this->last->package);
  962.             else
  963.             {
  964.                 if (isset($this->packagecategories[$this->package])
  965.                     && $this->packagecategories[$this->package!= $this->category)
  966.                     addWarning(PDERROR_PACKAGECAT_SET,$this->package,
  967.                                 $this->packagecategories[$this->package],
  968.                                 $this->category);
  969.                 $this->packagecategories[$this->package$this->category;
  970.             }
  971.         }
  972.         $this->last->updateModifiers($data->getModifiers());
  973. //        $this->last->setLineNumber($data->getLineNumber());
  974.         $data->setDocBlock($this->last);
  975.         $this->cur_class = $name $data->getName();
  976.         if ($this->last->getKeyword('ignore'))
  977.         {
  978.             $this->private_class = true;
  979.             unset($this->last);
  980.             return;
  981.         }
  982.         $data->path $this->data->parent->path;
  983.         $this->classes->addClass($data);
  984.         $this->private_class = false;
  985.         if ($this->last->package)
  986.         {
  987.             $this->parsePackagePage($this->last->package$this->data->parent->getPath());
  988.         }
  989.         $this->last = false;
  990.     }
  991.  
  992.     /**
  993.      * handles post-parsing of procedural pages
  994.      *
  995.      * this event is called at the start of a new page, before the Parser knows
  996.      * whether the page will contain any procedural pages or not
  997.      * @param integer $event Event number from {@link Parser.inc}
  998.      * @param parserPage $data 
  999.      */
  1000.     function handlePage($event,$data)
  1001.     {
  1002.         $type 'page';
  1003.         $this->private_page false;
  1004.         $this->data = new parserData;
  1005.         $data->category $this->category $GLOBALS['phpDocumentor_DefaultCategoryName'];
  1006.         $this->package $GLOBALS['phpDocumentor_DefaultPackageName'];
  1007.         $this->subpackage '';
  1008.         $this->proceduralpages->addPage($data);
  1009.         $this->data->setParent($data);
  1010.         $this->pages[$data->getPath()$this->data;
  1011.         $this->classes->nextFile($data->getPath());
  1012.         $this->packageoutput = $data->getPackageOutput();
  1013.     }
  1014.  
  1015.     /**
  1016.      * handles post-parsing of DocBlocks
  1017.      *
  1018.      * This function sets {@link $last} to the DocBlock represented by $data, to
  1019.      * allow the next documentable element passed to
  1020.      * phpDocumentor_IntermediateParser to link the DocBlock into its $docblock
  1021.      * property.  This function also checks for two special cases of DocBlocks:
  1022.      * <ol>
  1023.      *    <li>First DocBlock in the file contains a @package tag</li>
  1024.      *    <li>First DocBlock in the file is immediately followed by another
  1025.      *        DocBlock</li>
  1026.      * </ol>
  1027.      * In both cases, the function extracts this tag and uses it as the
  1028.      * page-level package.  If the @package tag is in the DocBlock of an
  1029.      * element (function, global variable, whatever) that isn't a page-level
  1030.      * DocBlock, a warning will be raised to notify the author that a @package
  1031.      * tag belongs in a page-level DocBlock.
  1032.      *
  1033.      * <b>New</b> in version 1.2.2, if the first DocBlock in a file contains
  1034.      * a @package tag, it is a page-level DocBlock.
  1035.      *
  1036.      * If the DocBlock is page-level, it is processed with
  1037.      * {@link _processPageLevelDocBlock}
  1038.      *
  1039.      * Finally, the function replaces the old parserPage in
  1040.      * {@link parserData::$data}->parent with the new one containing information
  1041.      * from the DocBlock by calling {@link addPage()}, and checks for
  1042.      * package-level docs.
  1043.      * @param integer $event Event number from {@link Parser.inc}
  1044.      * @param parserDocBlock $data 
  1045.      */
  1046.     function handleDocBlock($event,$data)
  1047.     {
  1048.         $type 'docblock';
  1049.         $data->postProcess();
  1050.         // Zend desc support
  1051.         if ($tdesc $data->getKeyword('desc'))
  1052.         {
  1053.             $data->setShortDesc($tdesc);
  1054.             unset($data->tags['desc']);
  1055.         }
  1056.         $this->_lastDocBlockWasPageLevel false;
  1057.         // 1st docblock in file, check for @package
  1058.         if ($this->data->isClean(&& !isset($this->last))
  1059.         {
  1060.             if ($data->getExplicitPackage())
  1061.             {
  1062.                 // new with 1.2.2:
  1063.                 // if the first docblock in a file
  1064.                 // contains a @package tag, then it is
  1065.                 // a page-level docblock
  1066.                 $this->_processPageLevelDocBlock($data);
  1067.                 $this->_lastDocBlockWasPageLevel true;
  1068.                 $this->all_packages[$data->package1;
  1069.                 $this->last = $data;
  1070.                 return;
  1071.             }
  1072.             $doc new parserDocBlock;
  1073.             $doc->category $this->category;
  1074.             $doc->package $this->package;
  1075.             $doc->subpackage $this->subpackage;
  1076.             $this->data->setDocBlock($doc);
  1077.             $this->proceduralpages->addPagePackage($this->data->parent->getPath(),$this->package,$this->subpackage);
  1078.             unset($doc);
  1079.         }
  1080.         // 2nd docblock in a row, and it's at the top of the file, page-level docblock
  1081.         if ($this->lasttype == "docblock" && $this->data->isClean())
  1082.         {
  1083.             $this->_processPageLevelDocBlock($this->last);
  1084.             $this->_oldPageLevel true;
  1085.             $this->_lastDocBlockWasPageLevel false;
  1086.         }
  1087.         $this->all_packages[$data->package1;
  1088.         $this->last = $data;
  1089.     }
  1090.  
  1091.     /**
  1092.      * Process a Page-level DocBlock
  1093.      *
  1094.      * First, it checks for an @ignore tag,
  1095.      * and if found, calls {@link ProceduralPages::ignorePage()}.  An @ignore
  1096.      * tag in a page-level DocBlock will ignore all functions, defines, global
  1097.      * variables, and includes.  It will not ignore classes!  The function next
  1098.      * checks for an @access private, and if --parseprivate is off, performs the
  1099.      * same actions as @ignore.
  1100.      * Next, it checks for the @name tag, which is used to rename the page.
  1101.      * This is also a PEAR compatibility issue, and may not be very useful in
  1102.      * the long run.  Documentation is best when it refers to real entities in
  1103.      * the package, and not to aliases.
  1104.      * @access private
  1105.      */
  1106.     function _processPageLevelDocBlock($data)
  1107.     {
  1108.         global $_phpDocumentor_setting;
  1109.         // can only have 1 package-level docblock, others are ignored
  1110.         if (!$this->data->isClean())
  1111.         {
  1112.             return;
  1113.         }
  1114.         $this->data->clean = false;
  1115.         $this->data->explicitDocBlock();
  1116.         $data->canSource();
  1117.         if (isset($_phpDocumentor_setting['source']&& $_phpDocumentor_setting['sourcecode'])
  1118.         {
  1119.             $data->addFileSource($this->data->parent->path$this->data->parent->source);
  1120.         }
  1121.         if (!$data->getExplicitPackage())
  1122.         {
  1123.             list($data->package,$data->subpackage$this->_guessPackage($this->data->parent->getPath()$this->data->parent->getSourceLocation('dummy'));
  1124.             addWarning(PDERROR_NO_PACKAGE_TAG,'file',$this->data->parent->getPath(),$this->last->package);
  1125.         }
  1126.         if (isset($this->packagecategories[$this->package])
  1127.             && $this->packagecategories[$this->package!= $data->category)
  1128.             addWarning(PDERROR_PACKAGECAT_SET,$this->package,
  1129.                         $this->packagecategories[$this->package],
  1130.                         $data->category);
  1131.         $this->packagecategories[$this->package$data->category;
  1132.         $this->category $this->data->parent->category $data->category;
  1133.         $this->packagecategories[$this->package$this->category;
  1134.         $this->subpackage $this->data->parent->subpackage $data->subpackage;
  1135.         $this->data->setDocBlock($data);
  1136.         if ($data->getKeyword('ignore'))
  1137.         {
  1138.             $this->proceduralpages->ignorePage($this->data->parent);
  1139.             $this->private_page true;
  1140.             unset($this->last);
  1141.             $this->privatepages[$this->data->parent->getPath()$this->data;
  1142.             unset($this->pages[$this->data->parent->getPath()]);
  1143.             return;
  1144.         }
  1145.         $this->package $this->data->parent->package $data->package;
  1146.         $this->subpackage $this->data->parent->subpackage $data->subpackage;
  1147.         $this->proceduralpages->addPagePackage($this->data->parent->getPath(),$this->package,$this->subpackage);
  1148.         if ($access $data->getKeyword('access'))
  1149.         {
  1150.             if (is_object($access&& ($access->getString(== 'private'&& (!$this->parsePrivate))
  1151.             {
  1152.                 $this->proceduralpages->ignorePage($this->data->parent);
  1153.                 $this->private_page true;
  1154.                 unset($this->last);
  1155.                 $this->privatepages[$this->data->parent->getPath()$this->data;
  1156.                 unset($this->pages[$this->data->parent->getPath()]);
  1157.                 return;
  1158.             }
  1159.         }
  1160.         if ($data->getKeyword('name'))
  1161.         {
  1162.             $a $data->getKeyword('name');
  1163.             if (is_object($a)) $a $a->value;
  1164.             $this->data->parent->setFile($a);
  1165.             $this->proceduralpages->setName($a);
  1166.         }
  1167.         $this->addPage($this->data->parent$this->data->parent->getPath());
  1168.         if ($this->package)
  1169.         {
  1170.             $this->parsePackagePage($this->package$this->data->parent->getPath());
  1171.         }
  1172.     }
  1173.  
  1174.     /**
  1175.      * Backward-compatibility only, use the new tutorials for more power
  1176.      * @tutorial tutorials.pkg
  1177.      * @param string package name of package file to parse
  1178.      * @param string directory of file that contains package name
  1179.      */
  1180.     function parsePackagePage($package$path)
  1181.     {
  1182.         if (!isset($this->package_pages[$package]))
  1183.         {
  1184.             if (file_exists(dirname($pathSMART_PATH_DELIMITER $package '.html'))
  1185.             {
  1186.                 if ($this->quietMode === false)
  1187.                 {
  1188.                     phpDocumentor_out("Reading package-level file ".$package '.html');
  1189.                           flush();
  1190.                 }
  1191.                 $fp fopen(dirname($pathSMART_PATH_DELIMITER $package '.html',"r");
  1192.                 $ret fread($fp,filesize(dirname($pathSMART_PATH_DELIMITER $package '.html'));
  1193.                 fclose($fp);
  1194.                 unset($fp);
  1195.                 if ($this->quietMode === false)
  1196.                 {
  1197.                     phpDocumentor_out(" -- Parsing File\n");
  1198.                           flush();
  1199.                 }
  1200.                 $pageParser new ppageParser;
  1201.                 $tempp $this->package;
  1202.                 $lp $this->last;
  1203.                 $pageParser->subscribe('*',$this);
  1204.                 $pageParser->parse($ret,false,$package);
  1205.                 $this->package $tempp;
  1206.                 $this->last = $lp;
  1207.                 unset($tempp);
  1208.                 unset($pageParser);
  1209.             }
  1210.         }
  1211.     }
  1212.  
  1213.     /**
  1214.      * called via {@link Parser::parse()} and Parser's inherited method
  1215.      * {@link Publisher::publishEvent()}
  1216.      *
  1217.      * $event is one of the PHPDOC constants from Parser.inc.  If it is not
  1218.      * PHPDOCUMENTOR_EVENT_NEWSTATE, then a function name is retrieved from the
  1219.      * {@link $event_handlers} array and called to handle the $data
  1220.      * @param integer $event event number from {@link Parser.inc}
  1221.      * @param mixed $data if $event is {@link PHPDOCUMENTOR_EVENT_NEWSTATE}, $data is a {@link PHP_DOC_EVENT_END_PAGE} or {@link STATE_END_CLASS},
  1222.      *                     otherwise $data is either a {@link parserDocBlock}{@link parserPage} or descendant of {@link parserElement}
  1223.      * @global array we use 'sourcecode' to determine whether to highlight the source
  1224.      *                of the current file if it has no file-level docblock
  1225.      */
  1226.     function HandleEvent($event,$data)
  1227.     {
  1228.         global $_phpDocumentor_setting;
  1229.         if (empty($this->packagecategories))
  1230.         $this->packagecategories[$phpDocumentor_DefaultPackageName$phpDocumentor_DefaultCategoryName;
  1231.         if ($event == PHPDOCUMENTOR_EVENT_NEWSTATE)
  1232.         {
  1233.             if ($data == STATE_END_CLASS)
  1234.             {
  1235.             elseif ($data == PHPDOCUMENTOR_EVENT_END_PAGE)
  1236.             {
  1237.                 if (!$this->private_page)
  1238.                 {
  1239.                     $this->all_packages[$this->package1;
  1240.                     if (!$this->data->hasExplicitDocBlock())
  1241.                     {
  1242.                         $doc $this->data->docblock;
  1243.                         if (!$this->data->docblock)
  1244.                         {
  1245.                             $doc new parserDocBlock;
  1246.                         }
  1247.                         if (isset($_phpDocumentor_setting['sourcecode']&&
  1248.                             $_phpDocumentor_setting['sourcecode'])
  1249.                         {
  1250.                             $doc->canSource();
  1251.                             $doc->addFileSource($this->data->parent->path$this->data->parent->source);
  1252.                         }
  1253.                         list($doc->package,$doc->subpackage$this->_guessPackage($this->data->parent->getPath()$this->data->parent->getSourceLocation('dummy'));
  1254.                         addWarning(PDERROR_NO_PAGE_LEVELDOCBLOCK,$this->data->parent->getPath());
  1255.                         $this->data->setDocBlock($doc);
  1256.                         $this->proceduralpages->addPage($this->data->parent,$doc->package,$doc->subpackage);
  1257.                     }
  1258.                     $this->pages[$this->data->parent->getPath()$this->data;
  1259.                 }
  1260.                 $this->private_page false;
  1261.                 $this->private_class = false;
  1262.                 if (isset($this->db_template))
  1263.                 {
  1264.                     addWarning(PDERROR_DB_TEMPLATE_UNTERMINATED);
  1265.                 }
  1266.                 unset($this->db_template);
  1267.                 unset($this->last);
  1268.             elseif ($data == PHPDOCUMENTOR_EVENT_END_DOCBLOCK_TEMPLATE)
  1269.             {
  1270.                 unset($this->db_template);
  1271.             }
  1272.             //echo $this->state_lookup[$data] . "\n";
  1273.             //echo $data."\n";
  1274.         }
  1275.          else
  1276.         {
  1277.             if ($event == PHPDOCUMENTOR_EVENT_README_INSTALL_CHANGELOG)
  1278.             {
  1279.                 $this->ric[$data[0]] $data[1];
  1280.                 return;
  1281.             }
  1282.             if ($event == PHPDOCUMENTOR_EVENT_DOCBLOCK_TEMPLATE)
  1283.             {
  1284.                 $data->postProcess();
  1285.                 $this->db_template = $data;
  1286.                 $this->_lastDocBlockWasPageLevel false;
  1287.                 // 2nd docblock in a row, and it's at the top of the file, page-level docblock
  1288.                 if ($this->type == "docblock" && $this->data->isClean())
  1289.                 {
  1290.                     // can only have 1 package-level docblock, others are ignored
  1291.                     $this->data->clean = false;
  1292.                     if ($this->last->getKeyword('ignore'))
  1293.                     {
  1294.                         $this->proceduralpages->ignorePage($this->data->parent);
  1295.                         $this->private_page true;
  1296.                         unset($this->last);
  1297.                         $this->privatepages[$this->data->parent->getPath()$this->data;
  1298.                         unset($this->pages[$this->data->parent->getPath()]);
  1299.                         return;
  1300.                     }
  1301.                     $this->data->setDocBlock($this->last);
  1302.                     $this->package $this->data->parent->package $this->last->package;
  1303.                     $this->subpackage $this->data->parent->subpackage $this->last->subpackage;
  1304.                     $this->proceduralpages->addPagePackage($this->data->parent->getPath(),$this->package,$this->subpackage);
  1305.                     if ($access $this->last->getKeyword('access'))
  1306.                     {
  1307.                         if (is_object($access&& ($access->getString(== 'private'&& (!$this->parsePrivate))
  1308.                         {
  1309.                             addWarning(PDERROR_PARSEPRIVATE$this->data->parent->getPath());
  1310.                             $this->proceduralpages->ignorePage($this->data->parent);
  1311.                             $this->private_page true;
  1312.                             unset($this->last);
  1313.                             $this->privatepages[$this->data->parent->getPath()$this->data;
  1314.                             unset($this->pages[$this->data->parent->getPath()]);
  1315.                             return;
  1316.                         }
  1317.                     }
  1318.                     if ($this->last->getKeyword('name'))
  1319.                     {
  1320.                         $a $this->last->getKeyword('name');
  1321.                         if (is_object($a)) $a $a->value;
  1322.                         $this->data->parent->setFile($a);
  1323.                         $this->proceduralpages->setName($a);
  1324.                     }
  1325.                     $this->addPage($this->data->parent$this->data->parent->getPath());
  1326.                     if ($this->package)
  1327.                     {
  1328.                         $this->parsePackagePage($this->package$this->data->parent->getPath());
  1329.                     }
  1330.                 }
  1331.                 unset($this->last);
  1332.             else
  1333.             {
  1334.                 $this->lasttype = $this->type;
  1335.                 $type $data->getType();
  1336. //                fancy_debug($type,$data);
  1337.                 if (($type != 'page'&& ($type != 'docblock'&& ($type != 'packagepage'&& ($type != 'tutorial'))
  1338.                 {
  1339.                     $data->setFile($this->data->parent->getFile());
  1340.                 }
  1341.                 $this->type = $type;
  1342.                 //echo $type . "\n";
  1343.  
  1344.                 if (isset($this->event_handlers[$type]))
  1345.                 {
  1346.                     $handle $this->event_handlers[$type];
  1347.                     $this->$handle($event,$data);
  1348.                 }
  1349.             }
  1350.         }
  1351.     }
  1352.  
  1353.     /**
  1354.      * Replaces the {@link parserPage} represented by $this->pages[$path] with
  1355.      * $page
  1356.      *
  1357.      * Called by {@link addPageIfNecessary(), handleDocBlock()} and
  1358.      * {@link ProceduralPages::setupPages()}, this method first checks to see if
  1359.      * the page has been added.  If not, it assumes that the page has either
  1360.      * been @ignored or set with @access private with --parseprivate off, and
  1361.      * returns {@link addPrivatePage()}.  Otherwise, it sets the pages[$path] to
  1362.      * be the parserPage $page and sets the package and subpackage to that of
  1363.      * $page
  1364.      * @see $pages
  1365.      * @param parserPage 
  1366.      * @param string full path to the file
  1367.      */
  1368.     function addPage($page$path)
  1369.     {
  1370.         if (!isset($this->pages[$path])) return $this->addPrivatePage($page$path);
  1371.         $this->pages[$path]->setParent($page);
  1372.         if ($page->package != $GLOBALS['phpDocumentor_DefaultPackageName'])
  1373.         {
  1374.             if (!$this->pages[$path]->docblock)
  1375.             {
  1376.                 $docblock new parserDocBlock;
  1377.                 $docblock->package $page->package;
  1378.                 $docblock->subpackage $page->subpackage;
  1379.                 $this->pages[$path]->docblock $docblock;
  1380.             else
  1381.             {
  1382.                 $this->pages[$path]->docblock->package $page->package;
  1383.                 $this->pages[$path]->docblock->subpackage $page->subpackage;
  1384.             }
  1385.         }
  1386.     }
  1387.  
  1388.     /**
  1389.      * add a new {@link parserPage} to the $pages array if none is found
  1390.      *
  1391.      * This method is used when a page has been @ignored or marked with @access
  1392.      * private, and a public class is in the page (a class with no @access
  1393.      * private in its DocBlock).  The method first creates a new page in the
  1394.      * {@link $pages} array and then copies path information, and calls
  1395.      * {@link addPage()} to set up packages
  1396.      * @param string full path of page
  1397.      */
  1398.     function addPageIfNecessary($path&$class)
  1399.     {
  1400.         global $_phpDocumentor_setting;
  1401.         if (!$this->parsePrivate)
  1402.         {
  1403.             if (!isset($this->pages[$path]))
  1404.             {
  1405.                 $this->pages[$pathnew parserData;
  1406.                 $this->pages[$path]->docblock new parserDocBlock;
  1407.                 $this->pages[$path]->docblock->package $this->privatepages[$path]->docblock->package;
  1408.                 $this->pages[$path]->docblock->subpackage $this->privatepages[$path]->docblock->subpackage;
  1409.                 $par $this->privatepages[$path]->parent;
  1410.                 $this->pages[$path]->setParent($par);
  1411.                 $this->proceduralpages->addPage($par);
  1412.             }
  1413.         }
  1414.         if (!empty($_phpDocumentor_setting['packageoutput']))
  1415.             $packages explode(',',$_phpDocumentor_setting['packageoutput']);
  1416.         if (!empty($_phpDocumentor_setting['packageoutput']&&
  1417.             $this->pages[$path]->parent->package != $class->docblock->package &&
  1418.             !in_array($this->pages[$path]->parent->package,$packages))
  1419.         {
  1420.             $this->pages[$path]->parent->package $class->docblock->package;
  1421.             $this->addPage($this->pages[$path]->parent$path);
  1422.             $this->proceduralpages->addPage($this->pages[$path]->parent);
  1423.         }
  1424.     }
  1425.  
  1426.     /**
  1427.      * Adds a {@link parserPage} element to the {@link parserData} element in
  1428.      * $this->privatepages[$path]
  1429.      *
  1430.      * Performs a similar function to addPage, but adds to the
  1431.      * {@link $privatePages} array
  1432.      * @param parserPage $page 
  1433.      * @param string $path full path to the page
  1434.      * @see addPage()
  1435.      */
  1436.     function addPrivatePage($page$path)
  1437.     {
  1438.         /*
  1439.          * if privatepages is still empty,
  1440.          * we need to initialize it with an empty
  1441.          * path=>ParserData element, so that it has
  1442.          * a top-level element... otherwise the setParent() call
  1443.          * below will crap out.
  1444.          */
  1445.         if (count($this->privatepages== 0{
  1446.             $this->privatepages[$pathnew ParserData();
  1447.         }
  1448.         $this->privatepages[$path]->setParent($page);
  1449.         if (isset($page->package&& $page->package != $GLOBALS['phpDocumentor_DefaultPackageName'])
  1450.         {
  1451.             if (!$this->privatepages[$path]->docblock)
  1452.             {
  1453.                 $docblock new parserDocBlock;
  1454.                 $docblock->package $page->package;
  1455.                 $docblock->subpackage $page->subpackage;
  1456.                 $this->privatepages[$path]->docblock $docblock;
  1457.             else
  1458.             {
  1459.                 $this->privatepages[$path]->docblock->package $page->package;
  1460.                 $this->privatepages[$path]->docblock->subpackage $page->subpackage;
  1461.             }
  1462.         }
  1463.     }
  1464.  
  1465.     /**
  1466.      * adds a processed descendant of {@link parserElement} to the {@link $pages}
  1467.      * array or {@link $privatepages} array
  1468.      *
  1469.      * This function expects the page to exist in either $pages or $privatepages.  It calls the
  1470.      * {@link parserData::addElement()} method to add $element to the page.
  1471.      * @param parserElement $element this will actually be a descendant of parserElement
  1472.      * @param string $path 
  1473.      */
  1474.     function addElementToPage($element$path)
  1475.     {
  1476.         if (isset($this->privatepages[$path]))
  1477.         {
  1478.             if (isset($this->pages[$path]))
  1479.             {
  1480.                 if ($element->type == 'class' || $element->type == 'method'
  1481.                     || $element->type == 'var' || $element->type == 'const')
  1482.                 {
  1483.                     $this->pages[$path]->addElement($element);
  1484.                 else
  1485.                 $this->privatepages[$path]->addElement($element);
  1486.             else
  1487.             $this->privatepages[$path]->addElement($element);
  1488.         else
  1489.         {
  1490.             if (isset($this->pages[$path]))
  1491.             {
  1492.                 $this->pages[$path]->addElement($element);
  1493.             }
  1494.         }
  1495.     }
  1496.  
  1497.     /**
  1498.      * Add all the @uses tags from $element to the $uses array so that @usedby
  1499.      * virtual tags can be added
  1500.      * @uses parserUsesTag::getSeeElement() used to initialize {@link $uses}
  1501.      * @uses parserUsesTag::getDescription() used to initialize {@link $uses}
  1502.      * @param parserElement descendant of parserElement
  1503.      * @param string full path to the file
  1504.      */
  1505.     function addUses($element$path)
  1506.     {
  1507.         if (isset($element->type&& $element->type == 'page')
  1508.         {
  1509.             $element $this->pages[$element->path];
  1510.         }
  1511.         if (!$this->parsePrivate && isset($element->docblock->hasaccess&& $element->docblock->hasaccess)
  1512.         {
  1513.             $a =  $element->docblock->getKeyword('access');
  1514.             if (is_object($a&& $a->getString(== 'private'return;
  1515.         }
  1516.         if (isset($this->privatepages[$path]))
  1517.         {
  1518.             if (isset($this->pages[$path]))
  1519.             {
  1520.                 $uses $element->docblock->getKeyword('uses');
  1521.                 if ($uses)
  1522.                 {
  1523.                     if (!is_array($uses)) $uses array($uses);
  1524.                     foreach($uses as $use)
  1525.                     {
  1526.                         if (!is_object($use)) continue;
  1527.                         $el $use->getSeeElement();
  1528.                         $description $use->getDescription();
  1529.                         $this->uses[$el][array($element$description);
  1530.                     }
  1531.                 }
  1532.             }
  1533.         else
  1534.         {
  1535.             if (isset($this->pages[$path]))
  1536.             {
  1537.                 $uses $element->docblock->getKeyword('uses');
  1538.                 if ($uses)
  1539.                 {
  1540.                     if (!is_array($uses)) $uses array($uses);
  1541.                     foreach($uses as $use)
  1542.                     {
  1543.                         if (!is_object($use)) continue;
  1544.                         $el $use->getSeeElement();
  1545.                         $description $use->getDescription();
  1546.                         $this->uses[$el][array($element$description);
  1547.                     }
  1548.                 }
  1549.             }
  1550.         }
  1551.     }
  1552.  
  1553.     /**
  1554.      * Add a {@link parserUsedByTag} link to every element referred to by @uses
  1555.      * @param Converter temporary converter used to retrieve abstract links
  1556.      * @uses phpDocumentor_IntermediateParser::addUses() indirectly, as
  1557.      *        addUses() sets up $uses, which is iterated over here
  1558.      * @uses $pages sets up all @usedby tags from here
  1559.      * @access private
  1560.      */
  1561.     function _setupUsesList(&$converter)
  1562.     {
  1563.         ob_start();
  1564.         $converter->_createPkgElements($this->pages);
  1565.         ob_end_clean();
  1566.         ksort($this->uses);
  1567.         foreach($this->uses as $link => $elements)
  1568.         {
  1569.             foreach($elements as $element)
  1570.             {
  1571.                 if ($element[0]->type == 'method' || $element[0]->type == 'var' ||
  1572.                     $element[0]->type == 'const')
  1573.                 {
  1574.                     $converter->class $element[0]->getClass();
  1575.                 }
  1576.                 if ($element[0]->type == 'class')
  1577.                 {
  1578.                     $converter->class $element[0]->getName();
  1579.                 }
  1580.                 $reallink $converter->getLink($link,$element[0]->docblock->package);
  1581.                 if (is_object($reallink))
  1582.                 {
  1583.                     // add a used by tag to the docblock of the destination
  1584.                     switch(phpDocumentor_get_class($reallink))
  1585.                     {
  1586.                         case 'pagelink' :
  1587.                             $this->pages[$reallink->path]->docblock->addUsedBy(
  1588.                                 $element[0]->getLink($converterfalsetrue),
  1589.                                 $element[1]);
  1590.                         break;
  1591.                         case 'functionlink' :
  1592.                         case 'definelink' :
  1593.                         case 'globallink' :
  1594.                         if (isset($this->pages[$reallink->path]))
  1595.                         {
  1596.                             for ($i=0;
  1597.                                  $i<count($this->pages[$reallink->path]->elements);
  1598.                                  $i++{
  1599.                                 if ($this->pages[$reallink->path]->elements[$i]->type ==
  1600.                                       str_replace('link''',
  1601.                                       phpDocumentor_get_class($reallink)) &&
  1602.                                       $this->pages[$reallink->path]->
  1603.                                       elements[$i]->getName()
  1604.                                       == $reallink->name{
  1605.                                     $this->pages[$reallink->path]->elements[$i]->
  1606.                                     docblock->addUsedBy(
  1607.                                         $element[0]->getLink($converter,false,true),
  1608.                                         $element[1]);
  1609. //                                   debug('added @usedby to '.str_replace('link','',phpDocumentor_get_class($reallink)).' '.$reallink->name);
  1610.                                 }
  1611.                             }
  1612.                         }
  1613.                         break;
  1614.                         case 'classlink' :
  1615.                         case 'methodlink' :
  1616.                         case 'varlink' :
  1617.                         case 'constlink' :
  1618.                         if (isset($this->pages[$reallink->path]))
  1619.                         {
  1620.                             for ($i=0;$i<count($this->pages[$reallink->path]->classelements);$i++)
  1621.                             {
  1622.                                 if ($this->pages[$reallink->path]->classelements[$i]->type ==
  1623.                                       str_replace('link','',phpDocumentor_get_class($reallink)) &&
  1624.                                       $this->pages[$reallink->path]->classelements[$i]->getName(== $reallink->name &&
  1625.                                       (!isset($reallink->class||
  1626.                                       $this->pages[$reallink->path]->classelements[$i]->getClass(== $reallink->class))
  1627.                                 {
  1628.                                     $this->pages[$reallink->path]->classelements[$i]->docblock->addUsedBy($element[0]->getLink($converter,false,true)$element[1]);
  1629. //                                   debug('added @usedby to '.str_replace('link','',phpDocumentor_get_class($reallink)).' '.$reallink->name);
  1630.                                 }
  1631.                             }
  1632.                         }
  1633.                         break;
  1634.                     }
  1635.                 }
  1636.             }
  1637.         }
  1638.     }
  1639.  
  1640.     /**
  1641.      * Interface to the Converter
  1642.      *
  1643.      * This function simply passes {@link $pages} and {@link package_pages} to
  1644.      * the walk() method, and then calls the Output() method.  Note that
  1645.      * Output() is not required to do anything, and in fact doesn't in
  1646.      * HTMLframesConverter.
  1647.      * @uses Converter::walk() passes {@link $pages} and {@link $package_pages}
  1648.      * @uses Converter::Output()
  1649.      */
  1650.     function Convert($title$converter)
  1651.     {
  1652.         $converter->walk($this->pages$this->package_pages);
  1653.         $converter->Output($title);
  1654.         $converter->cleanup();
  1655.     }
  1656.  
  1657.     /**
  1658.      * Clean up classes
  1659.      *
  1660.      * {@source } 
  1661.      * @access private
  1662.      * @uses Classes::Inherit() passes $this
  1663.      */
  1664.     function fixClasses()
  1665.     {
  1666.         $this->classes->Inherit($this);
  1667.     }
  1668.  
  1669.     /**
  1670.      * Clean up Procedural Pages
  1671.      * {@source } 
  1672.      * @access private
  1673.      * @uses ProceduralPages::setupPages() passes $this
  1674.      */
  1675.     function fixProcPages()
  1676.     {
  1677.         $this->proceduralpages->setupPages($this);
  1678.     }
  1679.  
  1680.     /**
  1681.      * If the parent class of $class is in a different package, adds it to the
  1682.      * {@link $package_parents} array
  1683.      * @param parserClass &$class 
  1684.      */
  1685.     function addPackageParent(&$class)
  1686.     {
  1687.         if (!is_array($class->parent)) return;
  1688.         $par $this->classes->getClass($class->parent[1]$class->parent[0]);
  1689.         if ($class->docblock->package == $par->docblock->packagereturn;
  1690.         $this->package_parents[$class->docblock->package$par->docblock->package;
  1691.         if (!isset($this->package_parents[$par->docblock->package]|| !$this->package_parents[$par->docblock->package]$this->package_parents[$par->docblock->packagefalse;
  1692.     }
  1693.  
  1694.     /**
  1695.      * Add a converter name to use to the list of converters
  1696.      *
  1697.      * Sets up the {@link $converters} array.
  1698.      * {@internal 
  1699.      * First, the Converter's file is included, and then, if successful,
  1700.      * the converter classname is tested for existance.  If all is good,
  1701.      * then the templates are added to the list of converters/templates to use}}}
  1702.      * @param string $output output format (HTML, PDF, XML).  Must be all caps
  1703.      * @param string $name Converter name (frames, for example, is the name of
  1704.      *                      HTMLframesConverter)
  1705.      * @param string $template template to use, should be a relative path to the
  1706.      *                          templates dir (like DOM/default)
  1707.      */
  1708.     function addConverter($output,$name,$template)
  1709.     {
  1710.         if ($this->templateBase{
  1711.             $templateBase str_replace('\\','/'$this->templateBase'/Converters';
  1712.         else {
  1713.             if ('@PEAR-DIR@' != '@'.'PEAR-DIR@'{
  1714.                 $templateBase 'PhpDocumentor/phpDocumentor/Converters';
  1715.             else {
  1716.                 $templateBase str_replace('\\','/',$GLOBALS['_phpDocumentor_install_dir']'/phpDocumentor/Converters';
  1717.             }
  1718.         }
  1719.         if (strpos($name,PATH_DELIMITER))
  1720.         {
  1721.             // include the parent template
  1722.             $parent explode(PATH_DELIMITER,$name);
  1723.             $parent $parent[0];
  1724.             if (!class_exists($output $parent 'Converter')) {
  1725.                 $filename $templateBase '/' $output '/' $parent '/' $output
  1726.                     . $parent 'Converter.inc';
  1727.                 if (Io::isIncludeable($filename))
  1728.                 {
  1729.                     include_once($filename);
  1730.                 }
  1731.             }
  1732.             if (!class_exists($output $parent 'Converter'))
  1733.             {
  1734.                 addError(PDERROR_CONVERTER_NOT_FOUND,"parent Converter ".$output $parent "Converter of child Converter ".$output str_replace(PATH_DELIMITER,'',$name"Converter");
  1735.             }
  1736.         }
  1737.         $filename $templateBase .
  1738.              PATH_DELIMITER $output PATH_DELIMITER $name PATH_DELIMITER $output .
  1739.              str_replace(PATH_DELIMITER''$name"Converter" ".inc";
  1740.         if (Io::isIncludeable($filename))
  1741.         {
  1742.             include_once($filename);
  1743.         }
  1744.         if (class_exists($output str_replace(PATH_DELIMITER,'',$name'Converter'))
  1745.         {
  1746.             $this->converters[$output][$output str_replace(PATH_DELIMITER,'',$name"Converter"][$template;
  1747.         else
  1748.         {
  1749.             addError(PDERROR_CONVERTER_NOT_FOUND,$output str_replace(PATH_DELIMITER,'',$name"Converter");
  1750.         }
  1751.     }
  1752.  
  1753.     /**
  1754.      * does a natural case sort on two {@link parserElement} descendants
  1755.      *
  1756.      * @param    mixed    $a 
  1757.      * @param    mixed    $b 
  1758.      * @return    int 
  1759.      * @see        generateElementIndex()
  1760.      */
  1761.     function elementCmp ($a$b)
  1762.     {
  1763.         return strnatcasecmp($a->getName()$b->getName());
  1764.     }
  1765.  
  1766.     /**
  1767.      * does a natural case sort on two class elements (either
  1768.      * {@link parserClass, parserMethod} or {@link parserVar}
  1769.      *
  1770.      * @param    mixed    $a 
  1771.      * @param    mixed    $b 
  1772.      * @return    int 
  1773.      * @see        generateElementIndex()
  1774.      */
  1775.     function ClasselementCmp ($a$b)
  1776.     {
  1777.         if (phpDocumentor_get_class($a== 'parserclass'$atest $a->nameelse $atest $a->class;
  1778.         if (phpDocumentor_get_class($b== 'parserclass'$btest $b->nameelse $btest $b->class;
  1779.  
  1780.         if(($c strnatcasecmp($atest$btest)) != 0return $c;
  1781.         if (phpDocumentor_get_class($a!= 'parserclass'$atest .= $a->name;
  1782.         if (phpDocumentor_get_class($b!= 'parserclass'$btest .= $b->name;
  1783.         if (phpDocumentor_get_class($a== 'parsermethod' && phpDocumentor_get_class($b== 'parsermethod')
  1784.         {
  1785.             if ($a->isConstructorreturn -1;
  1786.             if ($b->isConstructorreturn 1;
  1787.             if ($a->isDestructorreturn -1;
  1788.             if ($b->isDestructorreturn 1;
  1789.         }
  1790.         return strnatcasecmp($atest,$btest);
  1791.     }
  1792.  
  1793.     /**
  1794.      * call this method once parsing has completed.
  1795.      *
  1796.      * This method calls the private methods fixClasses and fixProcPages, both
  1797.      * of which adjust inheritance and package information based on complicated
  1798.      * post-parsing rules described in {@link ProceduralPages::setupPages()}
  1799.      * and {@link Classes::Inherit()}.  Then, it sorts elements of the $pages
  1800.      * array and calls Convert for each Converter in the $converters array
  1801.      * @see $converters
  1802.      * @see $pages
  1803.      * @see Convert()
  1804.      */
  1805.     function Output ($title "Generated Documentation")
  1806.     {
  1807.         $GLOBALS['phpDocumentor_errors']->curfile false;
  1808.         $this->fixClasses();
  1809.         $this->fixProcPages();
  1810. //        var_dump($this->uses);
  1811. //        exit;
  1812.         phpDocumentor_out("\nSorting page elements...");
  1813.         flush();
  1814.         uasort($this->pages,'pagesort');
  1815.         foreach($this->pages as $i => $page)
  1816.         {
  1817.             usort($this->pages[$i]->elements,array($this,'elementCmp'));
  1818.             usort($this->pages[$i]->classelements,array($this,'ClasselementCmp'));
  1819.         }
  1820.         phpDocumentor_out("done\n");
  1821.         flush();
  1822.         $complicatedout false;
  1823.         if (is_array($this->converters))
  1824.         {
  1825.             if (count($this->converters1)
  1826.             {
  1827.                 $complicatedout true;
  1828.             }
  1829.             phpDocumentor_out("Formatting @uses list...");
  1830.             flush();
  1831.             $a new __dummyConverter($this->all_packages$this->package_parents$this->classes$this->proceduralpages$this->packageoutput$this->parsePrivate$this->quietMode$this->targetDir ''$this->title);
  1832.             $this->_setupUsesList($a);
  1833.             unset($a);
  1834.             phpDocumentor_out("done\n\n");
  1835.             flush();
  1836.             foreach($this->converters as $converter => $blah)
  1837.             {
  1838.                 if (is_array($blah))
  1839.                 {
  1840.                     if (count($blah1)
  1841.                     {
  1842.                         $complicatedout true;
  1843.                     }
  1844.                     foreach($blah as $converter => $templates)
  1845.                     {
  1846.                         foreach($templates as $template)
  1847.                         {
  1848.                             $extraout '';
  1849.                             if ($complicatedout)
  1850.                             {
  1851.                                 $extraout SMART_PATH_DELIMITER $converter;
  1852.                             }
  1853.                             if (count($templates1)
  1854.                             {
  1855.                                 $extraout .= SMART_PATH_DELIMITER str_replace(PATH_DELIMITERSMART_PATH_DELIMITERsubstr($template,0,strlen($template1));
  1856.                             }
  1857.                             $a new $converter($this->all_packages$this->package_parents$this->classes$this->proceduralpages$this->packageoutput$this->parsePrivate$this->quietMode$this->targetDir . $extraout$template$this->title);
  1858.                             if (isset($this->templateBase))
  1859.                             {
  1860.                                 $a->setTemplateBase($this->templateBase$template);
  1861.                             }
  1862.                             $a->ric $this->ric;
  1863.                             $a->packagecategories $this->packagecategories;
  1864.                             if (isset($this->tutorials)) $a->setTutorials($this->tutorials);
  1865.                             $this->Convert($title$a);
  1866.                             unset($a);
  1867.                         }
  1868.                     }
  1869.                 }
  1870.             }
  1871.         else
  1872.         {
  1873.             addErrorDie(PDERROR_NO_CONVERTERS);
  1874.         }
  1875.     }
  1876.  
  1877.     /**
  1878.      * Sets the output directory
  1879.      *
  1880.      * @param string $dir the output directory
  1881.      */
  1882.     function setTargetDir($dir)
  1883.     {
  1884.         $this->targetDir = $dir;
  1885.     }
  1886.  
  1887.     /**
  1888.      * Sets the template base directory
  1889.      *
  1890.      * @param string $dir the template base directory
  1891.      * @tutorial phpDocumentor.howto.pkg#using.command-line.templatebase
  1892.      */
  1893.     function setTemplateBase($dir)
  1894.     {
  1895.         $this->templateBase = $dir;
  1896.     }
  1897.  
  1898.     /**
  1899.      * set parsing information output mode (quiet or verbose)
  1900.      *
  1901.      * If set to false, no parsing information (parsing /php/file/thisfile.php,
  1902.      * Converting etc.) will be displayed.
  1903.      * Useful for cron jobs
  1904.      * @param    bool $quietMode 
  1905.      */
  1906.     function setQuietMode($quietMode)
  1907.     {
  1908.         $this->quietMode = $quietMode;
  1909.     }
  1910.  
  1911.     /**
  1912.      * show warnings for undocumented elements
  1913.      *
  1914.      * If set to false, no warnings will be shown for undocumented elements.
  1915.      * Useful for identifying classes and methods that haven't yet been documented.
  1916.      * @param    bool $undocumentedElementWarnings 
  1917.      */
  1918.     function setUndocumentedElementWarningsMode($undocumentedElementWarnings)
  1919.     {
  1920.         $this->undocumentedElementWarnings = $undocumentedElementWarnings;
  1921.     }
  1922.  
  1923.     /**
  1924.      * set display of elements marked with @access private
  1925.      *
  1926.      * If set to true, elements will be displayed
  1927.      * @param    bool $parse 
  1928.      */
  1929.     function setParsePrivate($parse)
  1930.     {
  1931.         $this->parsePrivate = $parse;
  1932.     }
  1933. }
  1934.  
  1935. /** @access private */
  1936. function pagesort($a$b)
  1937. {
  1938.     return strnatcasecmp($a->parent->file,$b->parent->file);
  1939. }
  1940. ?>

Documentation generated on Mon, 05 Dec 2011 21:06:01 -0600 by phpDocumentor 1.4.4