Intermediate procedural page parsing structure.
This structure parses defines, functions, and global variables by file, and then iterates over the elements to document conflicts.
Located in /phpDocumentor/ProceduralPages.inc (line 58)
file being parsed, used in every add function to match up elements with the file that contains them
Namespace conflicts within all documented packages of functions
Format:
array(
functionname => array(
full path,
full path,
...
)
)
array of parsed defines organized by the full path of the file that contains the define.
Format:
array(
full path => array(
definename => parserDefine
)
)
array of file names organized by defines that are in the file.
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,
...
)
)
Namespace conflicts within all documented packages of functions
Format:
array(
functionname => array(
full path,
full path,
...
)
)
array of parsed functions organized by the full path of the file that contains the function.
Format:
array(
full path => array(
functionname => parserFunction
)
)
array of file names organized by functions that are in the file.
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,
...
)
)
Namespace conflicts within all documented packages of functions
Format:
array(
functionname => array(
full path,
full path,
...
)
)
array of parsed global variables organized by the full path of the file that contains the global variable definition.
Format:
array(
full path => array(
globalname => parserGlobal
)
)
array of file names organized by global variables that are in the file.
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,
...
)
)
array of all procedural pages ordered by name
that have been ignored via -po or @access private or @ignore Format:
array(
name => array(
fullpath => parserPage,
fullpath => parserPage2 [if there are name conflicts],
...
)
)
array of parsed includes organized by the full path of the file that contains the include.
Format:
array(
full path => array(
includename => parserInclude
)
)
array of packages assigned to classes in a file, ordered by fullpath
Format:
array(
fullpath => array(
packagename => array(
subpackagename => 1,
subpackagename => 1,
..
),
packagename2 => array(...
)
)
)
Namespace conflicts within all documented pages
Format:
array(
pagename => array(
fullpath,
fullpath,
...
)
)
array of packages ordered by full path
Format:
array(
fullpath => array(
packagename,
subpackagename
)
)
array of all procedural pages ordered by name
Format:
array(
name => array(
fullpath => parserPage,
fullpath => parserPage2 [if there are name conflicts],
...
)
)
array of all procedural page names ordered by full path to the file
Format:
array(
fullpath => name
)
adds a package from a class to the current file
sets up the $definesbyfile array using $curfile
sets up the $functionsbyfile array using $curfile
sets up the $globalsbyfile array using $curfile
sets up the $includesbyfile array using $curfile
Changes the package of the page represented by $path
changes package in both the $pages array and the pagepackages array
gathers path-related info about a given element
Ensures the path to the file is an absolute path
moves a page from the $pages array to the $ignorepages array
checks to see if the parsed file matches the given path
Used to align an element with the package of its parent page prior to Conversion.
Change a page's name from its file to alias $name
This function is used to handle a @name tag in a page-level DocBlock
sets the parser base
if there is one class package in a file, the parent path inherits the package if its package is default.
helps with -po to avoid dumb bugs
Adjusts packages of all pages and removes name conflicts within a package
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:
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:
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.
Documentation generated on Mon, 05 Dec 2011 21:01:08 -0600 by phpDocumentor 1.4.4