phpDocumentor
[ class tree: phpDocumentor ] [ index: phpDocumentor ] [ all elements ]

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

Documentation generated on Mon, 11 Mar 2019 15:50:29 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.