Class: ProceduralPages

Format:

 array(
 functionname => array(
 full path,
 full path,
 ...
 )
 )

Format:

 array(
 full path => array(
 definename => parserDefine
 )
 )

This structure is designed to handle name conflicts. Two files can contain defines with the same name, and this array will record both filenames to help control namespace errors Format:

 array(
 definename => array(
 full path of file containing definename,
 full path of file 2 containing definename,
 ...
 )
 )

Format:

 array(
 functionname => array(
 full path,
 full path,
 ...
 )
 )

Format:

 array(
 full path => array(
 functionname => parserFunction
 )
 )

This structure is designed to handle name conflicts. Two files can contain functions with the same name, and this array will record both filenames to help control namespace errors Format:

 array(
 functionname => array(
 full path of file containing functionname,
 full path of file 2 containing functionname,
 ...
 )
 )

Format:

 array(
 functionname => array(
 full path,
 full path,
 ...
 )
 )

Format:

 array(
 full path => array(
 globalname => parserGlobal
 )
 )

This structure is designed to handle name conflicts. Two files can contain global variables with the same name, and this array will record both filenames to help control namespace errors Format:

 array(
 global variablename => array(
 full path of file containing global variablename,
 full path of file 2 containing global variablename,
 ...
 )
 )

that have been ignored via -po or @access private or @ignore Format:

 array(
 name => array(
 fullpath => parserPage,
 fullpath => parserPage2 [if there are name conflicts],
 ...
 )
 )

Format:

 array(
 full path => array(
 includename => parserInclude
 )
 )

Format:

 array(
 fullpath => array(
 packagename => array(
 subpackagename => 1,
 subpackagename => 1,
 ..
 ),
 packagename2 => array(...
 )
 )
 )

Format:

 array(
 pagename => array(
 fullpath,
 fullpath,
 ...
 )
 )

Format:

 array(
 fullpath => array(
 packagename,
 subpackagename
 )
 )

Format:

 array(
 name => array(
 fullpath => parserPage,
 fullpath => parserPage2 [if there are name conflicts],
 ...
 )
 )

Format:

 array(
 fullpath => name
 )

changes package in both the $pages array and the pagepackages array

This function is used to handle a @name tag in a page-level DocBlock

helps with -po to avoid dumb bugs

Automatic linking requires that each linkable name have exactly one element associated with it. In other words, there cannot be two functions named foo() in the same package.

This also adheres to php rules with one exception:

1. if ($test == 3) {
2. define ('whatever', 'this thing');
3. } else {
4. define ('whatever', 'this other thing');
5. }

phpDocumentor is not aware of conditional control structures because it would slow things down considerably. So, what phpDocumentor does is automatically ignore the second define and raise a warning. The warning can be eliminated with an @ignore tag on the second element like so:

1. if ($test == 3) {
2. define ('whatever', 'this thing');
3. } else {
4. /**
5. * @ignore
6. */
7. define ('whatever', 'this other thing');
8. }

If there are two files that contain the same procedural elements in the same package (for example, a common configuration file common.php), they will also be ignored as if they were in the same file. The reasoning behind this is simple. A package is an indivisible set of files and classes that a user will include in their code. Name conflicts must be avoided to allow successful execution.

This function also plays the all-important role of calling phpDocumentor_IntermediateParser::addElementToPage() in order to add processed elements to their pages for Conversion.