Element index for package phpDocumentor

[ a ] [ b ] [ c ] [ d ] [ e ] [ f ] [ g ] [ h ] [ i ] [ k ] [ l ] [ m ] [ n ] [ o ] [ p ] [ q ] [ r ] [ s ] [ t ] [ u ] [ v ] [ w ] [ x ] [ _ ]

_

$_phpDocumentor_setting: in file Setup.inc.php, global variable $_phpDocumentor_setting
$_phpDocumentor_setting is either the value from the web interface, or is set up by Io::parseArgv()
_IN_PHP5: in file common.inc.php, constant _IN_PHP5
_setupIgnore: in file Io.inc, method Io::_setupIgnore()
Construct the $ignore array

top

a

$all_packages: in file IntermediateParser.inc, variable phpDocumentor_IntermediateParser::$all_packages
list of all packages encountered while documenting. Used in automatic linking.
addClass: in file Classes.inc, method Classes::addClass()
While parsing, add a class to the list of parsed classes
addClassPackageToFile: in file ProceduralPages.inc, method ProceduralPages::addClassPackageToFile()
adds a package from a class to the current file
addConst: in file Classes.inc, method Classes::addConst()
While parsing, add a variable to the list of parsed variables
addConverter: in file IntermediateParser.inc, method phpDocumentor_IntermediateParser::addConverter()
Add a converter name to use to the list of converters
addDefine: in file ProceduralPages.inc, method ProceduralPages::addDefine()
sets up the $definesbyfile array using $curfile
addElementToPage: in file IntermediateParser.inc, method phpDocumentor_IntermediateParser::addElementToPage()
adds a processed descendant of parserElement to the $pages array or $privatepages array
addFunction: in file ProceduralPages.inc, method ProceduralPages::addFunction()
sets up the $functionsbyfile array using $curfile
addGlobal: in file ProceduralPages.inc, method ProceduralPages::addGlobal()
sets up the $globalsbyfile array using $curfile
addInclude: in file ProceduralPages.inc, method ProceduralPages::addInclude()
sets up the $includesbyfile array using $curfile
addMethod: in file Classes.inc, method Classes::addMethod()
While parsing, add a method to the list of parsed methods
addPackageParent: in file IntermediateParser.inc, method phpDocumentor_IntermediateParser::addPackageParent()
If the parent class of $class is in a different package, adds it to the
addPackageToFile: in file Classes.inc, method Classes::addPackageToFile()
Mark a package as being used in a class
addPage: in file IntermediateParser.inc, method phpDocumentor_IntermediateParser::addPage()
Replaces the parserPage represented by $this->pages[$path] with $page
addPage: in file ProceduralPages.inc, method ProceduralPages::addPage()
sets up the $pages array
addPageIfNecessary: in file IntermediateParser.inc, method phpDocumentor_IntermediateParser::addPageIfNecessary()
add a new parserPage to the $pages array if none is found
addPagePackage: in file ProceduralPages.inc, method ProceduralPages::addPagePackage()
Changes the package of the page represented by $path
addPrivatePage: in file IntermediateParser.inc, method phpDocumentor_IntermediateParser::addPrivatePage()
Adds a parserPage element to the parserData element in $this->privatepages[$path]
addToCVS: in file add_cvs.php, function addToCVS()
Recursively add files to cvs
addUses: in file IntermediateParser.inc, method phpDocumentor_IntermediateParser::addUses()
Add all the @uses tags from $element to the $uses array so that @usedby
addVar: in file Classes.inc, method Classes::addVar()
While parsing, add a variable to the list of parsed variables
actions.php: procedural page actions.php
add_cvs.php: procedural page add_cvs.php
addItem: in file DescHTML.inc, method parserList::addItem()
add an item to a list
addList: in file DescHTML.inc, method parserList::addList()
add a list
addError: in file Errors.inc, method ErrorTracker::addError()
add a new error to the $errors array
addError: in file Errors.inc, function addError()
add an Error
addErrorDie: in file Errors.inc, function addErrorDie()
like addError() but exits parsing
addErrorReturn: in file Errors.inc, method ErrorTracker::addErrorReturn()
add a new error to the $errors array and returns the error string
addWarning: in file Errors.inc, method ErrorTracker::addWarning()
add a new warning to the $warnings array
addWarning: in file Errors.inc, function addWarning()
add a Warning
arrayConvert: in file InlineTags.inc, method parserSourceInlineTag::arrayConvert()
converter helper used in PHP 4.3.0+
arrayConvert: in file InlineTags.inc, method parserExampleInlineTag::arrayConvert()
converter helper for PHP 4.3.0+
abstractLink: in file LinkClasses.inc, class abstractLink
linking classes parent
addLink: in file LinkClasses.inc, method tutorialLink::addLink()
sets up the link
addLink: in file LinkClasses.inc, method abstractLink::addLink()
sets up the link
addLink: in file LinkClasses.inc, method methodLink::addLink()
sets up the link
add: in file ParserData.inc, method parserStringWithInlineTags::add()
equivalent to the . operator ($a = $b . $c)
addElement: in file ParserData.inc, method parserData::addElement()
add a new element to the tracking array
addLink: in file ParserData.inc, method parserData::addLink()
adds a link
addTutorial: in file ParserData.inc, method parserData::addTutorial()
adds a tutorial parser
add: in file ParserDocBlock.inc, method parserDesc::add()
addAccess: in file ParserDocBlock.inc, method parserDocBlock::addAccess()
add an @access tag to the tags array
addExample: in file ParserDocBlock.inc, method parserDocBlock::addExample()
adds an @example tag
addFileSource: in file ParserDocBlock.inc, method parserDocBlock::addFileSource()
Adds a new @filesource tag to the DocBlock
addFuncGlobal: in file ParserDocBlock.inc, method parserDocBlock::addFuncGlobal()
adds a function declaration of @global to the $funcglobals array
addKeyword: in file ParserDocBlock.inc, method parserDocBlock::addKeyword()
addLink: in file ParserDocBlock.inc, method parserDocBlock::addLink()
creates a parserLinkTag and adds it to the $tags array
addName: in file ParserDocBlock.inc, method parserDocBlock::addName()
Adds a @name tag to the tag list
addPackage: in file ParserDocBlock.inc, method parserDocBlock::addPackage()
addParam: in file ParserDocBlock.inc, method parserDocBlock::addParam()
addProperty: in file ParserDocBlock.inc, method parserDocBlock::addProperty()
Adds a @property(-read or -write) or @method magic tag to the DocBlock
addReturn: in file ParserDocBlock.inc, method parserDocBlock::addReturn()
creates a parserReturnTag and adds it to the $tags array
addSee: in file ParserDocBlock.inc, method parserDocBlock::addSee()
creates a parserLinkTag and adds it to the $tags array
addStaticVar: in file ParserDocBlock.inc, method parserDocBlock::addStaticVar()
addTag: in file ParserDocBlock.inc, method parserDocBlock::addTag()
Used to insert DocBlock Template tags into a docblock
addUnknownTag: in file ParserDocBlock.inc, method parserDocBlock::addUnknownTag()
adds an unknown tag to the $unknown_tags array for use by custom converters
addUses: in file ParserDocBlock.inc, method parserDocBlock::addUses()
Add a @uses tag to the DocBlock
addVar: in file ParserDocBlock.inc, method parserDocBlock::addVar()
creates a parserVarTag and adds it to the $tags array
addGlobals: in file ParserElements.inc, method parserFunction::addGlobals()
Add all "global $var, $var2" declarations to this function
addImplements: in file ParserElements.inc, method parserClass::addImplements()
addParam: in file ParserElements.inc, method parserMethod::addParam()
addParam: in file ParserElements.inc, method parserFunction::addParam()
addSource: in file ParserElements.inc, method parserFunction::addSource()
Set the source code. Always array in PHP 4.3.0+
addStatics: in file ParserElements.inc, method parserFunction::addStatics()
Add all "static $var, $var2 = 6" declarations to this function
addTutorial: in file ParserElements.inc, method parserClass::addTutorial()
$attributes: in file PackagePageElements.inc, variable parserXMLDocBookTag::$attributes
Attributes from the XML tag
add: in file PackagePageElements.inc, method parserXMLDocBookTag::add()
Add contents to this tag.
addAttribute: in file PackagePageElements.inc, method parserXMLDocBookTag::addAttribute()
Add an xml tag attribute name="value" pair
addCData: in file PackagePageElements.inc, method parserXMLDocBookTag::addCData()
add a word to CData
addFileSource: in file phpDocumentorTWordParser.inc, method phpDocumentorTWordParser::addFileSource()
Wrapper for addSource() used to retrieve the entire source code organized by line number in setup()
addSource: in file phpDocumentorTWordParser.inc, method phpDocumentorTWordParser::addSource()
Generate source token arrays organized by line number

top

b

$base_package: in file create_examples.php, global variable $base_package
default package name, used to change all non-included files to this package
builder.php: procedural page builder.php
backupPos: in file HighlightParser.inc, method phpDocumentor_HighlightWordParser::backupPos()
back the word parser to the previous token as defined by $last_token
Beautifier.php: procedural page Beautifier.php
backupPos: in file WordParser.inc, method WordParser::backupPos()
Backup to the previous token so that it can be retrieved again in a new context.
backupPos: in file phpDocumentorTWordParser.inc, method phpDocumentorTWordParser::backupPos()
backs the parser up to the previous position

top

c

$charset: in file IntermediateParser.inc, variable phpDocumentor_IntermediateParser::$charset
$classes: in file IntermediateParser.inc, variable phpDocumentor_IntermediateParser::$classes
used to keep track of inheritance at the smartest level possible for a
$converters: in file IntermediateParser.inc, variable phpDocumentor_IntermediateParser::$converters
an array of template names indexed by converter name
$curfile: in file ProceduralPages.inc, variable ProceduralPages::$curfile
file being parsed, used in every add function to match up elements with the file that contains them
$cur_class: in file IntermediateParser.inc, variable phpDocumentor_IntermediateParser::$cur_class
Name of the class currently being parsed.
$cvsadd_directory: in file add_cvs.php, global variable $cvsadd_directory
Physical location on this computer of the package to parse
checkForBugCondition: in file Setup.inc.php, function checkForBugCondition()
Crash in case of known, dangerous bug condition
checkIgnore: in file Io.inc, method Io::checkIgnore()
Tell whether to ignore a file or a directory allows * and ? wildcards
checkIgnoreTag: in file Setup.inc.php, method phpDocumentor_setup::checkIgnoreTag()
ClasselementCmp: in file IntermediateParser.inc, method phpDocumentor_IntermediateParser::ClasselementCmp()
does a natural case sort on two class elements (either parserClass, parserMethod or parserVar
Classes: in file Classes.inc, class Classes
Intermediate class parsing structure.
Convert: in file IntermediateParser.inc, method phpDocumentor_IntermediateParser::Convert()
Interface to the Converter
createDocs: in file Setup.inc.php, method phpDocumentor_setup::createDocs()
config.php: procedural page config.php
Classes.inc: procedural page Classes.inc
clone.inc.php: procedural page clone.inc.php
clone5.inc.php: procedural page clone5.inc.php
common.inc.php: procedural page common.inc.php
create_examples.php: procedural page create_examples.php
create_package.xml.php: procedural page create_package.xml.php
Convert: in file DescHTML.inc, method parserList::Convert()
performs the conversion of list tags
Convert: in file DescHTML.inc, method parserPre::Convert()
performs the conversion of code tags
Convert: in file DescHTML.inc, method parserSamp::Convert()
performs the conversion of sample tags
Convert: in file DescHTML.inc, method parserKbd::Convert()
performs the conversion of keyboard tags
Convert: in file DescHTML.inc, method parserI::Convert()
performs the conversion of italic tags
Convert: in file DescHTML.inc, method parserBr::Convert()
performs the conversion of linebreak tags
Convert: in file DescHTML.inc, method parserCode::Convert()
performs the conversion of code tags
Convert: in file DescHTML.inc, method parserDescVar::Convert()
performs the conversion of variable tags
Convert: in file DescHTML.inc, method parserB::Convert()
performs the conversion of bold tags
$converted_returnType: in file DocBlockTags.inc, variable parserReturnTag::$converted_returnType
contains a link to the documentation for a class passed as a type in @return, @var or @param
Convert: in file DocBlockTags.inc, method parserTag::Convert()
Perform the output conversion on this parserTag using the output converter that is passed in
Convert: in file DocBlockTags.inc, method parserTutorialTag::Convert()
process this tag through the given output converter
Convert: in file DocBlockTags.inc, method parserUsedByTag::Convert()
process this tag through the given output converter
Convert: in file DocBlockTags.inc, method parserUsesTag::Convert()
Return a link to documentation for other element, and description of how it is used
Convert: in file DocBlockTags.inc, method parserSeeTag::Convert()
process this tag through the given output converter
Convert: in file DocBlockTags.inc, method parserReturnTag::Convert()
process this tag through the given output converter (sets up the $converted_returnType)
Convert: in file DocBlockTags.inc, method parserFileSourceTag::Convert()
Return a link to the highlighted source and generate the source
Convert: in file DocBlockTags.inc, method parserNameTag::Convert()
process this tag through the given output converter
Convert: in file DocBlockTags.inc, method parserAccessTag::Convert()
process this tag through the given output converter
ConvertSource: in file DocBlockTags.inc, method parserFileSourceTag::ConvertSource()
convert the source code
ConvertSource: in file DocBlockTags.inc, method parserExampleTag::ConvertSource()
convert the source code
$curfile: in file Errors.inc, variable ErrorTracker::$curfile
$category: in file InlineTags.inc, variable parserIdInlineTag::$category
category of the {@id}
Convert: in file InlineTags.inc, method parserTocInlineTag::Convert()
converter method
Convert: in file InlineTags.inc, method parserTutorialInlineTag::Convert()
convert part of the tag
Convert: in file InlineTags.inc, method parserSourceInlineTag::Convert()
convert the tag
Convert: in file InlineTags.inc, method parserLinkInlineTag::Convert()
calls the output conversion
Convert: in file InlineTags.inc, method parserIdInlineTag::Convert()
converter
Convert: in file InlineTags.inc, method parserInheritdocInlineTag::Convert()
only sets a warning and returns empty
ConvertPart: in file InlineTags.inc, method parserLinkInlineTag::ConvertPart()
convert part of the tag
$category: in file LinkClasses.inc, variable abstractLink::$category
$class: in file LinkClasses.inc, variable methodLink::$class
classLink: in file LinkClasses.inc, class classLink
class link
constLink: in file LinkClasses.inc, class constLink
class constant link
$category: in file ParserData.inc, variable parserPage::$category
$classelements: in file ParserData.inc, variable parserData::$classelements
array of parsed class elements
$clean: in file ParserData.inc, variable parserData::$clean
used by phpDocumentor_IntermediateParser::handleDocBlock() to
Convert: in file ParserData.inc, method parserStringWithInlineTags::Convert()
Use to convert the string to a real string with all inline tags parsed and linked
$category: in file ParserDocBlock.inc, variable parserDocBlock::$category
canSource: in file ParserDocBlock.inc, method parserDocBlock::canSource()
Tells the DocBlock it can have a @filesource tag
cantSource: in file ParserDocBlock.inc, method parserDocBlock::cantSource()
Tells the DocBlock it can't have a @filesource tag
changeGlobal: in file ParserDocBlock.inc, method parserDocBlock::changeGlobal()
changeParam: in file ParserDocBlock.inc, method parserDocBlock::changeParam()
changeStatic: in file ParserDocBlock.inc, method parserDocBlock::changeStatic()
$children: in file ParserElements.inc, variable parserTutorial::$children
links to the child tutorials, or false if none
$class: in file ParserElements.inc, variable parserVar::$class
$class: in file ParserElements.inc, variable parserMethod::$class
$class: in file ParserElements.inc, variable parserConst::$class
$conflicts: in file ParserElements.inc, variable parserElement::$conflicts
$curfile: in file ParserElements.inc, variable parserClass::$curfile
Convert: in file ParserElements.inc, method parserPackagePage::Convert()
Convert: in file ParserElements.inc, method parserTutorial::Convert()
$context: in file XMLpackagePageParser.inc, variable XMLPackagePageParser::$context
categoryTagHandler: in file Parser.inc, method Parser::categoryTagHandler()
handles @category
checkEventPop: in file TutorialHighlightParser.inc, method phpDocumentor_TutorialHighlightParser::checkEventPop()
This function checks whether parameter $word is a token for popping the current event off of the Event Stack.
checkEventPop: in file Tokenizer.php, method phpDocumentor_XML_Beautifier_Tokenizer::checkEventPop()
this function checks whether parameter $word is a token for popping the current event off of the Event Stack.
checkEventPop: in file Parser.inc, method Parser::checkEventPop()
this function checks whether parameter $word is a token for popping the current event off of the Event Stack.
checkEventPush: in file Parser.inc, method Parser::checkEventPush()
this function checks whether parameter $word is a token for pushing a new event onto the Event Stack.
checkEventPush: in file Tokenizer.php, method phpDocumentor_XML_Beautifier_Tokenizer::checkEventPush()
this function checks whether parameter $word is a token for pushing a new event onto the Event Stack.
checkEventPush: in file TutorialHighlightParser.inc, method phpDocumentor_TutorialHighlightParser::checkEventPush()
This function checks whether parameter $word is a token for pushing a new event onto the Event Stack.
configWordParser: in file TutorialHighlightParser.inc, method phpDocumentor_TutorialHighlightParser::configWordParser()
Tell the parser's WordParser $wp to set up tokens to parse words by.
configWordParser: in file Tokenizer.php, method phpDocumentor_XML_Beautifier_Tokenizer::configWordParser()
tell the parser's WordParser $wp to set up tokens to parse words by.
configWordParser: in file HighlightParser.inc, method phpDocumentor_HighlightParser::configWordParser()
Give the word parser necessary data to begin a new parse
configWordParser: in file Parser.inc, method Parser::configWordParser()
tell the parser's WordParser $wp to set up tokens to parse words by.
Convert: in file PackagePageElements.inc, method parserXMLDocBookTag::Convert()
calls the output conversion
Convert: in file PackagePageElements.inc, method parserEntity::Convert()
calls the output conversion
Convert: in file PackagePageElements.inc, method parserCData::Convert()
calls the output conversion
concatTokens: in file phpDocumentorTWordParser.inc, method phpDocumentorTWordParser::concatTokens()
Utility function to convert a series of tokens into a string

top

d

$data: in file IntermediateParser.inc, variable phpDocumentor_IntermediateParser::$data
$data contains parsed structures for the current page being parsed
$db_template: in file IntermediateParser.inc, variable phpDocumentor_IntermediateParser::$db_template
$defineconflicts: in file ProceduralPages.inc, variable ProceduralPages::$defineconflicts
Namespace conflicts within all documented packages of functions
$definesbyfile: in file ProceduralPages.inc, variable ProceduralPages::$definesbyfile
array of parsed defines organized by the full path of the file that contains the define.
$definesbynamefile: in file ProceduralPages.inc, variable ProceduralPages::$definesbynamefile
array of file names organized by defines that are in the file.
$dirs: in file Setup.inc.php, variable phpDocumentor_setup::$dirs
contents of --directory commandline
debug: in file common.inc.php, function debug()
Debugging output
decideOnOrOff: in file Setup.inc.php, function decideOnOrOff()
Fuzzy logic to interpret the boolean args' intent
dirList: in file Io.inc, method Io::dirList()
displayHelpMsg: in file Io.inc, method Io::displayHelpMsg()
create the help message for display on the command-line
DescHTML.inc: procedural page DescHTML.inc
DocBlockTags.inc: procedural page DocBlockTags.inc
$data: in file Errors.inc, variable RecordWarning::$data
error string
defineLink: in file LinkClasses.inc, class defineLink
define link
$docblock: in file ParserData.inc, variable parserData::$docblock
DocBlock (parserDocBlock) for this page, or false if not set
$desc: in file ParserDocBlock.inc, variable parserDocBlock::$desc
$datatype: in file ParserElements.inc, variable parserGlobal::$datatype
Name of the global's data type
$docblock: in file ParserElements.inc, variable parserElement::$docblock
defaultHandler: in file Parser.inc, method ppageParser::defaultHandler()
Handles all non-inline tags
defaultTagHandler: in file Parser.inc, method Parser::defaultTagHandler()
Handles all standard tags that only have a description
doSimpleList: in file ParserDescCleanup.inc, method parserDescParser::doSimpleList()
Return a simple list, if found

top

e

$event_handlers: in file IntermediateParser.inc, variable phpDocumentor_IntermediateParser::$event_handlers
the functions which handle output from the Parser
elementCmp: in file IntermediateParser.inc, method phpDocumentor_IntermediateParser::elementCmp()
does a natural case sort on two parserElement descendants
EventStack: in file EventStack.inc, class EventStack
An event Stack
EventStack.inc: procedural page EventStack.inc
$errors: in file Errors.inc, variable ErrorTracker::$errors
array of RecordErrors
ErrorTracker: in file Errors.inc, class ErrorTracker
contains all the errors/warnings
Errors.inc: procedural page Errors.inc
$end: in file InlineTags.inc, variable parserSourceInlineTag::$end
Last line to display
$elements: in file ParserData.inc, variable parserData::$elements
array of parsed elements
explicitDocBlock: in file ParserData.inc, method parserData::explicitDocBlock()
Tells this page that its DocBlock was not implicit
$endlinenumber: in file ParserDocBlock.inc, variable parserDocBlock::$endlinenumber
Line number in the source on which this docblock ends
$explicitcategory: in file ParserDocBlock.inc, variable parserDocBlock::$explicitcategory
fix for bug 708559
$explicitpackage: in file ParserDocBlock.inc, variable parserDocBlock::$explicitpackage
fix for bug 591396
$endlinenumber: in file ParserElements.inc, variable parserElement::$endlinenumber
line number on file where this element stops
$extends: in file ParserElements.inc, variable parserClass::$extends
$eventHandlers: in file XMLpackagePageParser.inc, variable XMLPackagePageParser::$eventHandlers
$eventHandlers: in file Tokenizer.php, variable phpDocumentor_XML_Beautifier_Tokenizer::$eventHandlers
$eventHandlers: in file phpDocumentorTParser.inc, variable phpDocumentorTParser::$eventHandlers
endTag: in file Parser.inc, method Parser::endTag()
Called to clean up at the end of parsing a @tag in a docblock
exampleTagHandler: in file Parser.inc, method Parser::exampleTagHandler()
handles @example
endCData: in file PackagePageElements.inc, method parserXMLDocBookTag::endCData()
Adds $_cdata to $value

top

f

$files: in file Setup.inc.php, variable phpDocumentor_setup::$files
contents of --filename commandline
$files: in file add_cvs.php, global variable $files
$functionconflicts: in file ProceduralPages.inc, variable ProceduralPages::$functionconflicts
Namespace conflicts within all documented packages of functions
$functionsbyfile: in file ProceduralPages.inc, variable ProceduralPages::$functionsbyfile
array of parsed functions organized by the full path of the file that contains the function.
$functionsbynamefile: in file ProceduralPages.inc, variable ProceduralPages::$functionsbynamefile
array of file names organized by functions that are in the file.
fancy_debug: in file common.inc.php, function fancy_debug()
Returns a formatted var_dump for debugging purposes.
file_dialog.php: procedural page file_dialog.php
$file: in file Errors.inc, variable RecordWarning::$file
file this error occurred in
$fileAlias: in file LinkClasses.inc, variable abstractLink::$fileAlias
phpdoc alias _phpdoc_inc for phpdoc.inc
functionLink: in file LinkClasses.inc, class functionLink
function link
$file: in file ParserData.inc, variable parserPage::$file
filename.ext (no path)
$funcglobals: in file ParserDocBlock.inc, variable parserDocBlock::$funcglobals
array of global variable data.
$file: in file ParserElements.inc, variable parserElement::$file
location of this element (filename)
formatFile: in file Beautifier.php, method phpDocumentor_peardoc2_XML_Beautifier::formatFile()
format a file or URL
formatString: in file Beautifier.php, method phpDocumentor_peardoc2_XML_Beautifier::formatString()
format an XML string
find_phpdoc.php: procedural page find_phpdoc.php
findGlobal: in file phpDocumentorTWordParser.inc, method phpDocumentorTWordParser::findGlobal()
Tell the phpDocumentorTWordParser to return the entire global variable if it is found.

top

g

$globalconflicts: in file ProceduralPages.inc, variable ProceduralPages::$globalconflicts
Namespace conflicts within all documented packages of functions
$globalsbyfile: in file ProceduralPages.inc, variable ProceduralPages::$globalsbyfile
array of parsed global variables organized by the full path of the file that contains the global variable definition.
$globalsbynamefile: in file ProceduralPages.inc, variable ProceduralPages::$globalsbynamefile
array of file names organized by global variables that are in the file.
getAllFiles: in file Io.inc, method Io::getAllFiles()
Take a filename with wildcards and return all files that match the
getBase: in file Io.inc, method Io::getBase()
Retrieve common directory (case-insensitive in windows)
getClass: in file Classes.inc, method Classes::getClass()
Get the parserClass representation of a class from its name and file
getClassByPackage: in file Classes.inc, method Classes::getClassByPackage()
Search for a class in a package
getClassesInPath: in file Classes.inc, method Classes::getClassesInPath()
Used by parserData::getClasses() to retrieve classes defined in file $path
getConflicts: in file Classes.inc, method Classes::getConflicts()
If a package contains two classes with the same name, this function finds that conflict
getDefiniteChildren: in file Classes.inc, method Classes::getDefiniteChildren()
Get all classes confirmed in parsing to be descended class $parclass in file $file
getDir: in file utilities.php, function getDir()
getDirTree: in file Io.inc, method Io::getDirTree()
getEvent: in file EventStack.inc, method EventStack::getEvent()
Get the current event
getParentClass: in file Classes.inc, method Classes::getParentClass()
Find the parent class of a class in file $file
getPathInfo: in file ProceduralPages.inc, method ProceduralPages::getPathInfo()
gathers path-related info about a given element
getReadmeInstallChangelog: in file Io.inc, method Io::getReadmeInstallChangelog()
getRealPath: in file ProceduralPages.inc, method ProceduralPages::getRealPath()
Ensures the path to the file is an absolute path
getRegExpableSearchString: in file Io.inc, method Io::getRegExpableSearchString()
Converts $s into a string that can be used with preg_match
getRoots: in file Classes.inc, method Classes::getRoots()
Get a list of all root classes indexed by package. Used to generate class trees by Converter
getTutorials: in file Io.inc, method Io::getTutorials()
Retrieve tutorial subdirectories and their contents from the list of
get_include_path: in file Io.inc, function get_include_path()
getDescription: in file DocBlockTags.inc, method parserUsesTag::getDescription()
Get the description of how the element used is being used.
getSourceLink: in file DocBlockTags.inc, method parserFileSourceTag::getSourceLink()
gets path to the sourcecode file
getSourceLink: in file DocBlockTags.inc, method parserExampleTag::getSourceLink()
Retrieve a converter-specific link to the example
getString: in file DocBlockTags.inc, method parserTag::getString()
Returns the text minus any inline tags
getString: in file DocBlockTags.inc, method parserAccessTag::getString()
No inline tags are possible, returns 'public', 'protected' or 'private'
getProgramListing: in file InlineTags.inc, method parserExampleInlineTag::getProgramListing()
Return the source for the example file, enclosed in a <programlisting> tag to use in a tutorial
getString: in file InlineTags.inc, method parserSourceInlineTag::getString()
gets the source string
getString: in file InlineTags.inc, method parserInlineTag::getString()
always gets an empty string
globalLink: in file LinkClasses.inc, class globalLink
global variable link
getClasses: in file ParserData.inc, method parserData::getClasses()
returns a list of all classes declared in a file
getFile: in file ParserData.inc, method parserPage::getFile()
gets the file name
getLink: in file ParserData.inc, method parserData::getLink()
returns a link
getName: in file ParserData.inc, method parserData::getName()
Get the output-safe filename (. changed to _)
getName: in file ParserData.inc, method parserPage::getName()
gets the name
getPackageOutput: in file ParserData.inc, method parserPage::getPackageOutput()
gets the package output array
getParseData: in file ParserData.inc, method parserPage::getParseData()
Not implemented in this version
getPath: in file ParserData.inc, method parserPage::getPath()
gets the path
getSourceLocation: in file ParserData.inc, method parserPage::getSourceLocation()
gets the source location
getString: in file ParserData.inc, method parserStringWithInlineTags::getString()
return the string unconverted (all inline tags are taken out - this should only be used in pre-parsing to see if any other text is in the string)
getTutorial: in file ParserData.inc, method parserData::getTutorial()
If this file has a tutorial associated with it, returns a link to the tutorial.
getType: in file ParserData.inc, method parserPage::getType()
gets the tag type
getType: in file ParserData.inc, method parserBase::getType()
gets the type
getValue: in file ParserData.inc, method parserBase::getValue()
gets the value
getDesc: in file ParserDocBlock.inc, method parserDocBlock::getDesc()
getEndLineNumber: in file ParserDocBlock.inc, method parserDocBlock::getEndLineNumber()
Retrieve ending line number
getExplicitCategory: in file ParserDocBlock.inc, method parserDocBlock::getExplicitCategory()
If the DocBlock has a @category tag, then this returns true
getExplicitPackage: in file ParserDocBlock.inc, method parserDocBlock::getExplicitPackage()
If the DocBlock has a @package tag, then this returns true
getKeyword: in file ParserDocBlock.inc, method parserDocBlock::getKeyword()
getLineNumber: in file ParserDocBlock.inc, method parserDocBlock::getLineNumber()
Retrieve starting line number
getSDesc: in file ParserDocBlock.inc, method parserDocBlock::getSDesc()
getType: in file ParserDocBlock.inc, method parserDocBlock::getType()
$globals: in file ParserElements.inc, variable parserFunction::$globals
global declarations parsed from function definition
getChildClassList: in file ParserElements.inc, method parserClass::getChildClassList()
returns a list of all child classes of this class
getClass: in file ParserElements.inc, method parserVar::getClass()
Retrieve the class name
getClass: in file ParserElements.inc, method parserMethod::getClass()
Return name of the class that contains this method
getClass: in file ParserElements.inc, method parserConst::getClass()
Retrieve the class name
getConflicts: in file ParserElements.inc, method parserFunction::getConflicts()
Returns all functions in other packages that have the same name as this function
getConflicts: in file ParserElements.inc, method parserClass::getConflicts()
Returns all classes in other packages that have the same name as this class
getConflicts: in file ParserElements.inc, method parserDefine::getConflicts()
Returns all defines in other packages that have the same name as this define
getConflicts: in file ParserElements.inc, method parserGlobal::getConflicts()
Returns all global variables in other packages that have the same name as this global variable
getConstNames: in file ParserElements.inc, method parserClass::getConstNames()
getConsts: in file ParserElements.inc, method parserClass::getConsts()
getDataType: in file ParserElements.inc, method parserGlobal::getDataType()
Retrieve converter-specific representation of the data type
getEndLineNumber: in file ParserElements.inc, method parserElement::getEndLineNumber()
getExtends: in file ParserElements.inc, method parserClass::getExtends()
getFile: in file ParserElements.inc, method parserElement::getFile()
getFunctionCall: in file ParserElements.inc, method parserMethod::getFunctionCall()
adds "constructor " to start of function call if $isConstructor is true
getFunctionCall: in file ParserElements.inc, method parserFunction::getFunctionCall()
Get a human-friendly description of the function call
getImplements: in file ParserElements.inc, method parserClass::getImplements()
getImplements: in file ParserElements.inc, method parserMethod::getImplements()
getInheritedConsts: in file ParserElements.inc, method parserClass::getInheritedConsts()
getInheritedMethods: in file ParserElements.inc, method parserClass::getInheritedMethods()
getInheritedVars: in file ParserElements.inc, method parserClass::getInheritedVars()
getIntricateFunctionCall: in file ParserElements.inc, method parserMethod::getIntricateFunctionCall()
getIntricateFunctionCall: in file ParserElements.inc, method parserFunction::getIntricateFunctionCall()
Like getFunctionCall(), but has no English or pre-determined formatting.
getLineNumber: in file ParserElements.inc, method parserElement::getLineNumber()
getLink: in file ParserElements.inc, method parserConst::getLink()
quick way to link to this element
getLink: in file ParserElements.inc, method parserDefine::getLink()
quick way to link to this element
getLink: in file ParserElements.inc, method parserTutorial::getLink()
Get a link to this tutorial, or to any subsection of this tutorial
getLink: in file ParserElements.inc, method parserVar::getLink()
quick way to link to this element
getLink: in file ParserElements.inc, method parserGlobal::getLink()
quick way to link to this element
getLink: in file ParserElements.inc, method parserMethod::getLink()
quick way to link to this element
getLink: in file ParserElements.inc, method parserFunction::getLink()
quick way to link to this element
getLink: in file ParserElements.inc, method parserClass::getLink()
quick way to link to this element
getMethod: in file ParserElements.inc, method parserClass::getMethod()
getMethodNames: in file ParserElements.inc, method parserClass::getMethodNames()
getMethods: in file ParserElements.inc, method parserClass::getMethods()
getModifiers: in file ParserElements.inc, method parserClass::getModifiers()
Get the PHP5+ modifiers for this class
getModifiers: in file ParserElements.inc, method parserVar::getModifiers()
Return a list of access modifiers (static/private/etc.)
getModifiers: in file ParserElements.inc, method parserMethod::getModifiers()
Return name of the class that contains this method
getName: in file ParserElements.inc, method parserElement::getName()
getNext: in file ParserElements.inc, method parserTutorial::getNext()
Retrieve converter-specific link to the next tutorial's documentation
getOverrides: in file ParserElements.inc, method parserVar::getOverrides()
getOverrides: in file ParserElements.inc, method parserMethod::getOverrides()
getOverridingMethods: in file ParserElements.inc, method parserMethod::getOverridingMethods()
getOverridingMethodsForClass: in file ParserElements.inc, method parserMethod::getOverridingMethodsForClass()
getOverridingVars: in file ParserElements.inc, method parserVar::getOverridingVars()
getOverridingVarsForClass: in file ParserElements.inc, method parserVar::getOverridingVarsForClass()
getPackage: in file ParserElements.inc, method parserElement::getPackage()
getParam: in file ParserElements.inc, method parserFunction::getParam()
getParent: in file ParserElements.inc, method parserClass::getParent()
retrieve object that represents the parent class
getParent: in file ParserElements.inc, method parserTutorial::getParent()
Retrieve converter-specific link to the parent tutorial's documentation
getParentClassTree: in file ParserElements.inc, method parserClass::getParentClassTree()
getPath: in file ParserElements.inc, method parserElement::getPath()
getPrev: in file ParserElements.inc, method parserTutorial::getPrev()
Retrieve converter-specific link to the previous tutorial's documentation
getReturnsReference: in file ParserElements.inc, method parserFunction::getReturnsReference()
getSource: in file ParserElements.inc, method parserFunction::getSource()
getSourceLocation: in file ParserElements.inc, method parserClass::getSourceLocation()
getTitle: in file ParserElements.inc, method parserTutorial::getTitle()
Retrieve the title of the tutorial, or of any subsection
getTutorial: in file ParserElements.inc, method parserClass::getTutorial()
Get the associated tutorial for this class, if any
getVar: in file ParserElements.inc, method parserClass::getVar()
getVarNames: in file ParserElements.inc, method parserClass::getVarNames()
getVars: in file ParserElements.inc, method parserClass::getVars()
getParserEventName: in file TutorialHighlightParser.inc, method phpDocumentor_TutorialHighlightParser::getParserEventName()
searches for a parser event name based on its number
getParserEventName: in file XMLpackagePageParser.inc, method XMLPackagePageParser::getParserEventName()
debugging function
getParserEventName: in file Tokenizer.php, method phpDocumentor_XML_Beautifier_Tokenizer::getParserEventName()
getParserEventName: in file ParserDescCleanup.inc, method parserDescParser::getParserEventName()
getParserEventName: in file Parser.inc, method Parser::getParserEventName()
Debugging function, takes an event number and attempts to return its name
getWord: in file HighlightParser.inc, method phpDocumentor_HighlightWordParser::getWord()
Retrieve the next token
globalTagHandler: in file Parser.inc, method Parser::globalTagHandler()
handles @global
getId: in file PackagePageElements.inc, method parserXMLDocBookTag::getId()
Return converter-specific formatting of ID.
getSubsection: in file PackagePageElements.inc, method parserXMLDocBookTag::getSubsection()
Retrieve the contents of a subsection
getTitle: in file PackagePageElements.inc, method parserXMLDocBookTag::getTitle()
Retrieve Converter-specific formatting of the title of this element
getTOC: in file PackagePageElements.inc, method parserXMLDocBookTag::getTOC()
Retrieve either the table of contents index, or the location that the TOC will go
getBlock: in file WordParser.inc, method WordParser::getBlock()
Unused
getFileSource: in file phpDocumentorTWordParser.inc, method phpDocumentorTWordParser::getFileSource()
gets the source code tokens
getPos: in file WordParser.inc, method WordParser::getPos()
Returns the current pointer position, or 1 character after the end of the word
getSource: in file phpDocumentorTWordParser.inc, method phpDocumentorTWordParser::getSource()
loads up next set of source code
getSource: in file WordParser.inc, method WordParser::getSource()
Retrieve source code for the last function/method
getWord: in file WordParser.inc, method WordParser::getWord()
Retrieve a token from the token list
getWord: in file phpDocumentorTWordParser.inc, method phpDocumentorTWordParser::getWord()
Retrieve a token for the phpDocumentorTParser
getWord: in file ParserDescCleanup.inc, method ObjectWordParser::getWord()

top

h

$hidden: in file Setup.inc.php, variable phpDocumentor_setup::$hidden
contents of --hidden commandline
handleClass: in file IntermediateParser.inc, method phpDocumentor_IntermediateParser::handleClass()
handles post-parsing of classes
handleConst: in file IntermediateParser.inc, method phpDocumentor_IntermediateParser::handleConst()
handles post-parsing of class constants
handleDefine: in file IntermediateParser.inc, method phpDocumentor_IntermediateParser::handleDefine()
handles post-parsing of defines
handleDocBlock: in file IntermediateParser.inc, method phpDocumentor_IntermediateParser::handleDocBlock()
handles post-parsing of DocBlocks
HandleEvent: in file IntermediateParser.inc, method phpDocumentor_IntermediateParser::HandleEvent()
called via Parser::parse() and Parser's inherited method Publisher::publishEvent()
handleFunction: in file IntermediateParser.inc, method phpDocumentor_IntermediateParser::handleFunction()
handles post-parsing of functions
handleGlobal: in file IntermediateParser.inc, method phpDocumentor_IntermediateParser::handleGlobal()
handles post-parsing of global variables
handleInclude: in file IntermediateParser.inc, method phpDocumentor_IntermediateParser::handleInclude()
handles post-parsing of include/require/include_once/require_once
handleMethod: in file IntermediateParser.inc, method phpDocumentor_IntermediateParser::handleMethod()
handles post-parsing of class methods
handlePackagePage: in file IntermediateParser.inc, method phpDocumentor_IntermediateParser::handlePackagePage()
handles post-parsing of Package-level documentation pages.
handlePage: in file IntermediateParser.inc, method phpDocumentor_IntermediateParser::handlePage()
handles post-parsing of procedural pages
handleTutorial: in file IntermediateParser.inc, method phpDocumentor_IntermediateParser::handleTutorial()
handle post-parsing of Tutorials.
handleVar: in file IntermediateParser.inc, method phpDocumentor_IntermediateParser::handleVar()
handles post-parsing of class vars
htmlArraySelect: in file utilities.php, function htmlArraySelect()
Returns a select box based on an key,value array where selected is based on key
HandleEvent: in file DocBlockTags.inc, method parserTag::HandleEvent()
Called by the parserDescParser when processing a description.
handleEvent: in file Errors.inc, method ErrorTracker::handleEvent()
This function subscribes to two events in the Parser in order to keep track of line number information and file name.
hasClasses: in file ParserData.inc, method parserData::hasClasses()
Does this package have classes?
hasExplicitDocBlock: in file ParserData.inc, method parserData::hasExplicitDocBlock()
If the page-level DocBlock was present in the source, returns true
hasInlineTag: in file ParserData.inc, method parserStringWithInlineTags::hasInlineTag()
Determine whether the string contains any inline tags
hasInterfaces: in file ParserData.inc, method parserData::hasInterfaces()
Does this package have interfaces?
$hasaccess: in file ParserDocBlock.inc, variable parserDocBlock::$hasaccess
whether this DocBlock has an @access tag
$hasname: in file ParserDocBlock.inc, variable parserDocBlock::$hasname
whether this DocBlock has a @name tag
hasInheritDoc: in file ParserDocBlock.inc, method parserDocBlock::hasInheritDoc()
Wrapper for parserDesc::hasInheritDoc()
hasInheritDoc: in file ParserDocBlock.inc, method parserDesc::hasInheritDoc()
hasSource: in file ParserDocBlock.inc, method parserDesc::hasSource()
hasConst: in file ParserElements.inc, method parserClass::hasConst()
hasMethod: in file ParserElements.inc, method parserClass::hasMethod()
hasSource: in file ParserElements.inc, method parserFunction::hasSource()
Determine whether the source code has been requested via {@source}
hasVar: in file ParserElements.inc, method parserClass::hasVar()
handleInlineDockeyword: in file Parser.inc, method ppageParser::handleInlineDockeyword()
handler for INLINE_DOCKEYWORD.
HighlightParser.inc: procedural page HighlightParser.inc
hasTitle: in file PackagePageElements.inc, method parserXMLDocBookTag::hasTitle()
Determine whether the docbook element has a title

top

i

$ignore: in file Io.inc, variable Io::$ignore
Format: array(array(regexp-ready string to search for whole path,
$ignore: in file add_cvs.php, global variable $ignore
Comma-separated list of files and directories to ignore
$ignorepages: in file ProceduralPages.inc, variable ProceduralPages::$ignorepages
array of all procedural pages ordered by name
$ignoresymlinks: in file Setup.inc.php, variable phpDocumentor_setup::$ignoresymlinks
contents of --ignoresymlinks commandline
$ignore_files: in file Setup.inc.php, variable phpDocumentor_setup::$ignore_files
contents of --ignore commandline
$includesbyfile: in file ProceduralPages.inc, variable ProceduralPages::$includesbyfile
array of parsed includes organized by the full path of the file that contains the include.
$interface: in file Setup.inc.php, global variable $interface
$interface is either 'web' or is not set at all
ignorePage: in file ProceduralPages.inc, method ProceduralPages::ignorePage()
moves a page from the $pages array to the $ignorepages array
Inherit: in file Classes.inc, method Classes::Inherit()
Main processing engine for setting up class inheritance.
Io: in file Io.inc, method Io::Io()
creates an array $this->phpDocOptions and sets program options in it.
Io: in file Io.inc, class Io
Class to handle file and user io opperations
Ioinc_mystrucsort: in file Io.inc, function Ioinc_mystrucsort()
Sorting functions for the file list
Ioinc_sortfiles: in file Io.inc, function Ioinc_sortfiles()
Sorting functions for the file list
isIncludeable: in file Io.inc, method Io::isIncludeable()
calls http://www.php.net/file_exists for each value in include_path,
IntermediateParser.inc: procedural page IntermediateParser.inc
Io.inc: procedural page Io.inc
$items: in file DescHTML.inc, variable parserList::$items
$isvalid: in file DocBlockTags.inc, variable parserAccessTag::$isvalid
set to true if the returned tag has a value type of private, protected
$id: in file InlineTags.inc, variable parserIdInlineTag::$id
section/subsection name
$inlinetype: in file InlineTags.inc, variable parserSourceInlineTag::$inlinetype
always 'source'
$inlinetype: in file InlineTags.inc, variable parserTocInlineTag::$inlinetype
always 'toc'
$inlinetype: in file InlineTags.inc, variable parserInlineTag::$inlinetype
the name of the inline tag (like link)
$inlinetype: in file InlineTags.inc, variable parserInheritdocInlineTag::$inlinetype
always 'inheritdoc'
$inlinetype: in file InlineTags.inc, variable parserIdInlineTag::$inlinetype
always 'id'
InlineTags.inc: procedural page InlineTags.inc
$id: in file ParserData.inc, variable parserPage::$id
not implemented in this version, will be used to link xml output pages
isClean: in file ParserData.inc, method parserData::isClean()
checks if the element is "cleaned" already
$ignore: in file ParserElements.inc, variable parserClass::$ignore
Used to determine whether a class should be ignored or not. Helps maintain integrity of parsing
$ini: in file ParserElements.inc, variable parserTutorial::$ini
output from tutorialname.ext.ini
$isConstructor: in file ParserElements.inc, variable parserMethod::$isConstructor
$isDestructor: in file ParserElements.inc, variable parserMethod::$isDestructor
isChildOf: in file ParserElements.inc, method parserTutorial::isChildOf()
Determine if this parserTutorial object is a child of another
isInterface: in file ParserElements.inc, method parserClass::isInterface()
$inlineTagHandlers: in file phpDocumentorTParser.inc, variable phpDocumentorTParser::$inlineTagHandlers
incdataHandler: in file Tokenizer.php, method phpDocumentor_XML_Beautifier_Tokenizer::incdataHandler()
Handler for real character data
invalidTagHandler: in file Parser.inc, method Parser::invalidTagHandler()
Handles tags like '@filesource' that only work in PHP 4.3.0+

top

k

$keyword: in file DocBlockTags.inc, variable parserStaticvarTag::$keyword
always 'staticvar'
$keyword: in file DocBlockTags.inc, variable parserSeeTag::$keyword
always 'see'
$keyword: in file DocBlockTags.inc, variable parserReturnTag::$keyword
always 'return'
$keyword: in file DocBlockTags.inc, variable parserTag::$keyword
tag name (see, access, etc.)
$keyword: in file DocBlockTags.inc, variable parserTutorialTag::$keyword
Always "tutorial"
$keyword: in file DocBlockTags.inc, variable parserVarTag::$keyword
always 'var'
$keyword: in file DocBlockTags.inc, variable parserUsesTag::$keyword
Always "uses"
$keyword: in file DocBlockTags.inc, variable parserUsedByTag::$keyword
Always "usedby"
$keyword: in file DocBlockTags.inc, variable parserPropertyWriteTag::$keyword
always 'property-write'
$keyword: in file DocBlockTags.inc, variable parserPropertyTag::$keyword
always 'property'
$keyword: in file DocBlockTags.inc, variable parserLicenseTag::$keyword
always 'license'
$keyword: in file DocBlockTags.inc, variable parserFileSourceTag::$keyword
Always "filesource"
$keyword: in file DocBlockTags.inc, variable parserExampleTag::$keyword
always "example"
$keyword: in file DocBlockTags.inc, variable parserLinkTag::$keyword
always 'link'
$keyword: in file DocBlockTags.inc, variable parserMethodTag::$keyword
always 'method'
$keyword: in file DocBlockTags.inc, variable parserPropertyReadTag::$keyword
always 'property-read'
$keyword: in file DocBlockTags.inc, variable parserParamTag::$keyword
always 'param'
$keyword: in file DocBlockTags.inc, variable parserNameTag::$keyword
tag name
$keyword: in file DocBlockTags.inc, variable parserAccessTag::$keyword
tag name

top

l

$last: in file IntermediateParser.inc, variable phpDocumentor_IntermediateParser::$last
$lasttype: in file IntermediateParser.inc, variable phpDocumentor_IntermediateParser::$lasttype
type of the last parser Element handled
$lasterror: in file Errors.inc, variable ErrorTracker::$lasterror
index in $errors of last error triggered
$lastwarning: in file Errors.inc, variable ErrorTracker::$lastwarning
index in $warnings of last warning triggered
$linenum: in file Errors.inc, variable RecordWarning::$linenum
line number of the file this error occurred in
$linenum: in file Errors.inc, variable ErrorTracker::$linenum
$linktext: in file InlineTags.inc, variable parserLinkInlineTag::$linktext
text to display in the link, can be different from the link for standard
LinkClasses.inc: procedural page LinkClasses.inc
$links: in file ParserData.inc, variable parserData::$links
array of links descended from abstractLink
$linenumber: in file ParserDocBlock.inc, variable parserDocBlock::$linenumber
Line number in the source on which this docblock begins
listParams: in file ParserDocBlock.inc, method parserDocBlock::listParams()
listProperties: in file ParserDocBlock.inc, method parserDocBlock::listProperties()
listTags: in file ParserDocBlock.inc, method parserDocBlock::listTags()
$linenumber: in file ParserElements.inc, variable parserElement::$linenumber
Line number in the source on which this element appears
$linked_element: in file ParserElements.inc, variable parserTutorial::$linked_element
The documentable element this tutorial is linked to
listGlobals: in file ParserElements.inc, method parserFunction::listGlobals()
listParams: in file ParserElements.inc, method parserFunction::listParams()
listStatics: in file ParserElements.inc, method parserFunction::listStatics()

top

m

mystrucsort: in file add_cvs.php, function mystrucsort()
Sorting functions for the file list
methodLink: in file LinkClasses.inc, class methodLink
method link
$modDate: in file ParserData.inc, variable parserPage::$modDate
not implemented yet

top

n

$num: in file EventStack.inc, variable EventStack::$num
The number of events in the stack
nextFile: in file Classes.inc, method Classes::nextFile()
Prepare to parse a new file
new_phpdoc.php: procedural page new_phpdoc.php
$numbered: in file DescHTML.inc, variable parserList::$numbered
$num: in file Errors.inc, variable RecordWarning::$num
error number
$name: in file LinkClasses.inc, variable abstractLink::$name
$name: in file ParserData.inc, variable parserPage::$name
phpdoc-safe name (only letters, numbers and _)
$name: in file ParserElements.inc, variable parserElement::$name
name of this element, or include type if element is a parserInclude
$name: in file ParserElements.inc, variable parserTutorial::$name
filename minus extension of this tutorial (used for @tutorial tag)
$next: in file ParserElements.inc, variable parserTutorial::$next
link to the next tutorial in a document series, or false if none
newLineNum: in file HighlightParser.inc, method phpDocumentor_HighlightParser::newLineNum()
wraps the current line (via the converter) and resets it to empty
newLineNum: in file TutorialHighlightParser.inc, method phpDocumentor_TutorialHighlightParser::newLineNum()
advances output to a new line
nextToken: in file HighlightParser.inc, method phpDocumentor_HighlightWordParser::nextToken()
Retrieve the position of the next token that will be parsed in the internal token array
$name: in file PackagePageElements.inc, variable parserXMLDocBookTag::$name
Name of the tag
nextIsObjectOrNonNL: in file ParserDescCleanup.inc, method ObjectWordParser::nextIsObjectOrNonNL()
Determine if the next word is an inline tag

top

o

$output: in file create_examples.php, global variable $output
directories to output examples into.
$output_directory: in file create_examples.php, global variable $output_directory
Directory the output should go to.
Output: in file IntermediateParser.inc, method phpDocumentor_IntermediateParser::Output()
call this method once parsing has completed.
output: in file Errors.inc, method RecordWarning::output()
prints the warning
output: in file Errors.inc, method RecordError::output()
prints the error
$origName: in file ParserData.inc, variable parserPage::$origName
original phpdoc-safe name (only letters, numbers and _)
overridePackage: in file ParserDocBlock.inc, method parserDocBlock::overridePackage()
set the element's package to the passed values. Used in phpDocumentor_IntermediateParser to align package of
ObjectWordParser: in file ParserDescCleanup.inc, method ObjectWordParser::ObjectWordParser()
ObjectWordParser: in file ParserDescCleanup.inc, class ObjectWordParser
Like WordParser but designed to handle an array with strings and

top

p

$packagecategories: in file IntermediateParser.inc, variable phpDocumentor_IntermediateParser::$packagecategories
Used to determine the category for tutorials.
$packageoutput: in file IntermediateParser.inc, variable phpDocumentor_IntermediateParser::$packageoutput
array of packages to parser and output documentation for, if not all packages should be documented
$packages: in file Setup.inc.php, variable phpDocumentor_setup::$packages
Packages to create documentation for
$package_pages: in file IntermediateParser.inc, variable phpDocumentor_IntermediateParser::$package_pages
array of parsed package pages
$package_parents: in file IntermediateParser.inc, variable phpDocumentor_IntermediateParser::$package_parents
Keeps track of packages of classes that have parent classes in another package. Used in automatic linking.
$pageclasspackages: in file ProceduralPages.inc, variable ProceduralPages::$pageclasspackages
array of packages assigned to classes in a file, ordered by fullpath
$pageconflicts: in file ProceduralPages.inc, variable ProceduralPages::$pageconflicts
Namespace conflicts within all documented pages
$pagepackages: in file ProceduralPages.inc, variable ProceduralPages::$pagepackages
array of packages ordered by full path
$pages: in file ProceduralPages.inc, variable ProceduralPages::$pages
array of all procedural pages ordered by name
$pages: in file IntermediateParser.inc, variable phpDocumentor_IntermediateParser::$pages
$parse: in file Setup.inc.php, variable phpDocumentor_setup::$parse
The main parser
$parsePrivate: in file IntermediateParser.inc, variable phpDocumentor_IntermediateParser::$parsePrivate
set in Setup.inc.php to the value of the parseprivate commandline
$parse_directory: in file create_examples.php, global variable $parse_directory
location of the files to parse. Change to a location on your computer.
$pathpages: in file ProceduralPages.inc, variable ProceduralPages::$pathpages
array of all procedural page names ordered by full path to the file
$phpDocOptions: in file Io.inc, variable Io::$phpDocOptions
Holds all the options that are avaible to the cmd line interface
$phpDocumentor_DefaultCategoryName: in file Setup.inc.php, global variable $phpDocumentor_DefaultCategoryName
default package name, set using -dn --defaultcategoryname
$phpDocumentor_DefaultPackageName: in file Setup.inc.php, global variable $phpDocumentor_DefaultPackageName
default package name, set using -dn --defaultpackagename
$popEvent: in file Publisher.inc, variable Publisher::$popEvent
$privatepages: in file IntermediateParser.inc, variable phpDocumentor_IntermediateParser::$privatepages
Put away a page that has been @ignored or @access private if !$parsePrivate
$private_class: in file IntermediateParser.inc, variable phpDocumentor_IntermediateParser::$private_class
this variable is used to prevent parsing of elements with an @ignore tag
$proceduralpages: in file IntermediateParser.inc, variable phpDocumentor_IntermediateParser::$proceduralpages
used to keep track of all elements in a procedural page. Handles name
$pushEvent: in file Publisher.inc, variable Publisher::$pushEvent
parseArgv: in file Io.inc, method Io::parseArgv()
Parses $_SERVER['argv'] and creates a setup array
parseHiddenFiles: in file Setup.inc.php, method phpDocumentor_setup::parseHiddenFiles()
parseIni: in file Setup.inc.php, method phpDocumentor_setup::parseIni()
Parse configuration file phpDocumentor.ini
parsePackagePage: in file IntermediateParser.inc, method phpDocumentor_IntermediateParser::parsePackagePage()
Backward-compatibility only, use the new tutorials for more power
pathMatchesParsedFile: in file ProceduralPages.inc, method ProceduralPages::pathMatchesParsedFile()
checks to see if the parsed file matches the given path
PATH_DELIMITER: in file common.inc.php, constant PATH_DELIMITER
phpdoc.php: procedural page phpdoc.php
phpdoc.inc: procedural page phpdoc.inc
ProceduralPages.inc: procedural page ProceduralPages.inc
Publisher.inc: procedural page Publisher.inc
phpDocumentor_clone: in file clone.inc.php, function phpDocumentor_clone()
Clone an object in PHP 4
phpDocumentor_ConfigFileList: in file common.inc.php, function phpDocumentor_ConfigFileList()
used in phpdoc.php and new_phpdoc.php
phpDocumentor_get_class: in file common.inc.php, function phpDocumentor_get_class()
Returns a lower-cased version of get_class for PHP 5
phpDocumentor_IntermediateParser: in file IntermediateParser.inc, method phpDocumentor_IntermediateParser::phpDocumentor_IntermediateParser()
sets up basic data structures
phpDocumentor_IntermediateParser: in file IntermediateParser.inc, class phpDocumentor_IntermediateParser
The phpDocumentor_IntermediateParser Class
phpDocumentor_out: in file Setup.inc.php, function phpDocumentor_out()
Print parse information if quiet setting is off
phpDocumentor_parse_ini_file: in file common.inc.php, function phpDocumentor_parse_ini_file()
Parse an .ini file
phpDocumentor_setup: in file Setup.inc.php, method phpDocumentor_setup::phpDocumentor_setup()
Checks PHP version, makes sure it is 4.2.0+, and chooses the
phpDocumentor_setup: in file Setup.inc.php, class phpDocumentor_setup
PHPDOCUMENTOR_VER: in file common.inc.php, constant PHPDOCUMENTOR_VER
PHPDOCUMENTOR_WEBSITE: in file common.inc.php, constant PHPDOCUMENTOR_WEBSITE
PHPDOCUMENTOR_WINDOWS: in file common.inc.php, constant PHPDOCUMENTOR_WINDOWS
PHPDOC_WEBROOT_DIR: in file file_dialog.php, constant PHPDOC_WEBROOT_DIR
popEvent: in file EventStack.inc, method EventStack::popEvent()
Pop an event from the stack
ProceduralPages: in file ProceduralPages.inc, class ProceduralPages
Intermediate procedural page parsing structure.
processChild: in file Classes.inc, method Classes::processChild()
This function recursively climbs up the class tree, setting inherited information like package and adds the elements to phpDocumentor_IntermediateParser.
Publisher: in file Publisher.inc, class Publisher
a class for handling the publishing of data
publishEvent: in file Publisher.inc, method Publisher::publishEvent()
Publish an event
pushEvent: in file EventStack.inc, method EventStack::pushEvent()
Push an event onto the stack
parserB: in file DescHTML.inc, class parserB
Used for in a description
parserBr: in file DescHTML.inc, class parserBr
Used for in a description
parserCode: in file DescHTML.inc, class parserCode
Used for <code> in a description
parserDescVar: in file DescHTML.inc, class parserDescVar
Used for <var> in a description
parserI: in file DescHTML.inc, class parserI
Used for in a description
parserKbd: in file DescHTML.inc, class parserKbd
Used for <kbd> in a description
parserList: in file DescHTML.inc, method parserList::parserList()
Constructor - create a new list
parserList: in file DescHTML.inc, class parserList
Used for lists <ol> and <ul>
parserPre: in file DescHTML.inc, class parserPre
Used for <pre> in a description
parserSamp: in file DescHTML.inc, class parserSamp
Used for <samp> in a description
$path: in file DocBlockTags.inc, variable parserFileSourceTag::$path
parserAccessTag: in file DocBlockTags.inc, class parserAccessTag
This class represents the @access tag
parserAccessTag: in file DocBlockTags.inc, method parserAccessTag::parserAccessTag()
checks $value to make sure it is private, protected or public, otherwise it's not a valid @access tag
parserExampleTag: in file DocBlockTags.inc, method parserExampleTag::parserExampleTag()
Reads and parses the example file indicated
parserExampleTag: in file DocBlockTags.inc, class parserExampleTag
represents "@example"
parserFileSourceTag: in file DocBlockTags.inc, method parserFileSourceTag::parserFileSourceTag()
Set $source to $value, and set up path
parserFileSourceTag: in file DocBlockTags.inc, class parserFileSourceTag
represents "@filesource"
parserLicenseTag: in file DocBlockTags.inc, method parserLicenseTag::parserLicenseTag()
set up the license tag
parserLicenseTag: in file DocBlockTags.inc, class parserLicenseTag
represents the "@see" tag
parserLinkTag: in file DocBlockTags.inc, method parserLinkTag::parserLinkTag()
sets up the link tag
parserLinkTag: in file DocBlockTags.inc, class parserLinkTag
represents the "@link" tag
parserMethodTag: in file DocBlockTags.inc, class parserMethodTag
represents the "@method" tag
parserNameTag: in file DocBlockTags.inc, class parserNameTag
This class represents the @name tag
parserNameTag: in file DocBlockTags.inc, method parserNameTag::parserNameTag()
set up the name tag
parserParamTag: in file DocBlockTags.inc, class parserParamTag
represents the "@param" tag
parserPropertyReadTag: in file DocBlockTags.inc, class parserPropertyReadTag
represents the "@property-read" tag
parserPropertyTag: in file DocBlockTags.inc, class parserPropertyTag
represents the "@property" tag
parserPropertyTag: in file DocBlockTags.inc, method parserPropertyTag::parserPropertyTag()
set up the property tag
parserPropertyWriteTag: in file DocBlockTags.inc, class parserPropertyWriteTag
represents the "@property-write" tag
parserReturnTag: in file DocBlockTags.inc, method parserReturnTag::parserReturnTag()
set up the tag
parserReturnTag: in file DocBlockTags.inc, class parserReturnTag
represents the "@return" tag
parserSeeTag: in file DocBlockTags.inc, method parserSeeTag::parserSeeTag()
sets up the see tag
parserSeeTag: in file DocBlockTags.inc, class parserSeeTag
represents the "@see" tag
parserStaticvarTag: in file DocBlockTags.inc, class parserStaticvarTag
represents the "@staticvar" tag
parserTag: in file DocBlockTags.inc, class parserTag
used to represent standard tags like @access, etc.
parserTag: in file DocBlockTags.inc, method parserTag::parserTag()
Set up the tag
parserTutorialTag: in file DocBlockTags.inc, class parserTutorialTag
represents "@tutorial"
parserUsedByTag: in file DocBlockTags.inc, method parserUsedByTag::parserUsedByTag()
set up the usedby tag
parserUsedByTag: in file DocBlockTags.inc, class parserUsedByTag
This is a virtual tag, it is created by @uses to cross-reference the used element
parserUsesTag: in file DocBlockTags.inc, class parserUsesTag
represents the "@uses" tag
parserUsesTag: in file DocBlockTags.inc, method parserUsesTag::parserUsesTag()
set up the uses tag
parserVarTag: in file DocBlockTags.inc, class parserVarTag
represents the "@var" tag
$phpDocumentor_errors: in file Errors.inc, global variable $phpDocumentor_errors
$phpDocumentor_error_descrip: in file Errors.inc, global variable $phpDocumentor_error_descrip
Error messages for phpDocumentor parser errors
$phpDocumentor_warning_descrip: in file Errors.inc, global variable $phpDocumentor_warning_descrip
Error messages for phpDocumentor parser warnings
PDERROR_ACCESS_WRONG_PARAM: in file Errors.inc, constant PDERROR_ACCESS_WRONG_PARAM
warning triggered when the arguments to @access are neither public nor private
PDERROR_BEAUTIFYING_FAILED: in file Errors.inc, constant PDERROR_BEAUTIFYING_FAILED
warning triggered by an unterminated entity in a tutorial
PDERROR_CANNOT_EXTEND_SELF: in file Errors.inc, constant PDERROR_CANNOT_EXTEND_SELF
warning triggered if someone brilliant tries "class X extends X {"
PDERROR_CANT_HAVE_INLINE_IN_TAGNAME: in file Errors.inc, constant PDERROR_CANT_HAVE_INLINE_IN_TAGNAME
warning triggered when an inline tag is found inside an xml tag name
PDERROR_CANT_NEST_IN_B: in file Errors.inc, constant PDERROR_CANT_NEST_IN_B
warning triggered when another tag is nested in
PDERROR_CHILD_TUTORIAL_NOT_FOUND: in file Errors.inc, constant PDERROR_CHILD_TUTORIAL_NOT_FOUND
warning triggered when a tutorial's child in the .ini file doesn't exist in the
PDERROR_CLASS_CONFLICT: in file Errors.inc, constant PDERROR_CLASS_CONFLICT
warning triggered when classes in the same package have the same name
PDERROR_CLASS_EXISTS: in file Errors.inc, constant PDERROR_CLASS_EXISTS
warning triggered when inheritance could be from more than one class
PDERROR_CLASS_NOT_IN_PACKAGE: in file Errors.inc, constant PDERROR_CLASS_NOT_IN_PACKAGE
warning triggered when a getClassByPackage is called and can't find the class
PDERROR_CLASS_PARENT_NOT_FOUND: in file Errors.inc, constant PDERROR_CLASS_PARENT_NOT_FOUND
warning triggered when an entire page is ignored because of @access private
PDERROR_CONVERTER_NOT_FOUND: in file Errors.inc, constant PDERROR_CONVERTER_NOT_FOUND
warning triggered when a converter is passed to
PDERROR_CONVERTER_OVR_GFCT: in file Errors.inc, constant PDERROR_CONVERTER_OVR_GFCT
warning triggered when a child converter doesn't override
PDERROR_DANGEROUS_PHP_BUG_EXISTS: in file Errors.inc, constant PDERROR_DANGEROUS_PHP_BUG_EXISTS
warning triggered when the PHP version being used has dangerous bug/behavior
PDERROR_DB_TEMPLATE_UNTERMINATED: in file Errors.inc, constant PDERROR_DB_TEMPLATE_UNTERMINATED
warning triggered when a docblock template is never turned off
PDERROR_DOCBLOCK_CONFLICT: in file Errors.inc, constant PDERROR_DOCBLOCK_CONFLICT
warning triggered by a page-level docblock preceding a source element
PDERROR_DOCBLOCK_GOES_CLASS: in file Errors.inc, constant PDERROR_DOCBLOCK_GOES_CLASS
warning triggered when the first docblock in a file with a @package tag precedes a class. In this case, the class gets the docblock.
PDERROR_DUMB_USES: in file Errors.inc, constant PDERROR_DUMB_USES
warning triggered by improper "@uses blah"
PDERROR_ELEMENT_IGNORED: in file Errors.inc, constant PDERROR_ELEMENT_IGNORED
warning triggered when a duplicate element is encountered that will be
PDERROR_EMPTY_EXAMPLE_TITLE: in file Errors.inc, constant PDERROR_EMPTY_EXAMPLE_TITLE
warning triggered by @example path/to/example with no title
PDERROR_EXAMPLE_NOT_FOUND: in file Errors.inc, constant PDERROR_EXAMPLE_NOT_FOUND
warning triggered when an example's path from @example /path/to/example.php
PDERROR_FUNCTION_HAS_NONAME: in file Errors.inc, constant PDERROR_FUNCTION_HAS_NONAME
warning triggered by a function with no name
PDERROR_GLOBAL_NOT_FOUND: in file Errors.inc, constant PDERROR_GLOBAL_NOT_FOUND
warning triggered when there are multiple @name tags in a docblock
PDERROR_ID_MUST_BE_INLINE: in file Errors.inc, constant PDERROR_ID_MUST_BE_INLINE
warning triggered when an id attribute in a tutorial docbook tag is not
PDERROR_IGNORE_TAG_IGNORED: in file Errors.inc, constant PDERROR_IGNORE_TAG_IGNORED
warning triggered when an @ignore tag is used in a DocBlock preceding
PDERROR_ILLEGAL_PACKAGENAME: in file Errors.inc, constant PDERROR_ILLEGAL_PACKAGENAME
warning triggered when the package or subpackage name is illegal
PDERROR_INHERITANCE_CONFLICT: in file Errors.inc, constant PDERROR_INHERITANCE_CONFLICT
warning triggered when inheritance could be from more than one class
PDERROR_INHERITDOC_DONT_WORK_HERE: in file Errors.inc, constant PDERROR_INHERITDOC_DONT_WORK_HERE
warning triggered by {@inheritdoc} in a non-inheritable situation
PDERROR_INLINETAG_IN_SEE: in file Errors.inc, constant PDERROR_INLINETAG_IN_SEE
warning triggered when an example's path from @example /path/to/example.php
PDERROR_INTERNAL_NOT_CLOSED: in file Errors.inc, constant PDERROR_INTERNAL_NOT_CLOSED
warning triggered when an {@internal}} tag is not closed
PDERROR_INVALID_VALUES: in file Errors.inc, constant PDERROR_INVALID_VALUES
warning triggered if a command line option does not have a valid value passed in
PDERROR_LOOP_RECURSION_LIMIT_REACHED: in file Errors.inc, constant PDERROR_LOOP_RECURSION_LIMIT_REACHED
warning triggered when the a loop recursion tripwire has been tripped
PDERROR_MALFORMED_GLOBAL_TAG: in file Errors.inc, constant PDERROR_MALFORMED_GLOBAL_TAG
warning triggered when there are multiple @name tags in a docblock
PDERROR_MALFORMED_TAG: in file Errors.inc, constant PDERROR_MALFORMED_TAG
warning triggered by an empty tag
PDERROR_MISSING_PROPERTY_TAG_NAME: in file Errors.inc, constant PDERROR_MISSING_PROPERTY_TAG_NAME
warning triggered when any of {@property}}, {@property-read}},
PDERROR_MULTIPLE_ACCESS_TAGS: in file Errors.inc, constant PDERROR_MULTIPLE_ACCESS_TAGS
warning triggered when there are multiple @access tags in a docblock
PDERROR_MULTIPLE_CATEGORY_TAGS: in file Errors.inc, constant PDERROR_MULTIPLE_CATEGORY_TAGS
warning triggered by more than 1 @category tag
PDERROR_MULTIPLE_GLOBAL_TAGS: in file Errors.inc, constant PDERROR_MULTIPLE_GLOBAL_TAGS
warning triggered when there are multiple @name tags in a docblock
PDERROR_MULTIPLE_NAME_TAGS: in file Errors.inc, constant PDERROR_MULTIPLE_NAME_TAGS
warning triggered when there are multiple @name tags in a docblock
PDERROR_MULTIPLE_PACKAGE_TAGS: in file Errors.inc, constant PDERROR_MULTIPLE_PACKAGE_TAGS
warning triggered when there are multiple @package tags in a docblock
PDERROR_MULTIPLE_PARENT: in file Errors.inc, constant PDERROR_MULTIPLE_PARENT
warning triggered when inheritance could be from more than one class
PDERROR_MULTIPLE_RETURN_TAGS: in file Errors.inc, constant PDERROR_MULTIPLE_RETURN_TAGS
warning triggered when there are multiple @return tags in a docblock
PDERROR_MULTIPLE_SUBPACKAGE_TAGS: in file Errors.inc, constant PDERROR_MULTIPLE_SUBPACKAGE_TAGS
warning triggered when there are multiple @subpackage tags in a docblock
PDERROR_MULTIPLE_VAR_TAGS: in file Errors.inc, constant PDERROR_MULTIPLE_VAR_TAGS
warning triggered when there are multiple @var tags in a docblock
PDERROR_NAME_ALIAS_SAME_AS_TARGET: in file Errors.inc, constant PDERROR_NAME_ALIAS_SAME_AS_TARGET
warning triggered when the alias value in an page-level docblock's @name tag
PDERROR_NEED_WHITESPACE: in file Errors.inc, constant PDERROR_NEED_WHITESPACE
warning triggered when an entire page is ignored because of @access private
PDERROR_NESTED_INTERNAL: in file Errors.inc, constant PDERROR_NESTED_INTERNAL
warning triggered when {@internal}} is nested inside another {@internal}}
PDERROR_NOTODO_INCLUDE: in file Errors.inc, constant PDERROR_NOTODO_INCLUDE
warning triggered when @todo is used on an include element
PDERROR_NO_CONVERTERS: in file Errors.inc, constant PDERROR_NO_CONVERTERS
warning triggered when a converter is passed to
PDERROR_NO_CONVERTER_HANDLER: in file Errors.inc, constant PDERROR_NO_CONVERTER_HANDLER
warning triggered when an example's path from @example /path/to/example.php
PDERROR_NO_DOCBOOK_ID: in file Errors.inc, constant PDERROR_NO_DOCBOOK_ID
warning triggered in tutorial parsing if there is a missing {@id} inline tag
PDERROR_NO_PACKAGE_TAG: in file Errors.inc, constant PDERROR_NO_PACKAGE_TAG
warning triggered when no @package tag is used in a page-level
PDERROR_NO_PAGE_LEVELDOCBLOCK: in file Errors.inc, constant PDERROR_NO_PAGE_LEVELDOCBLOCK
warning triggered when a file does not contain a page-level docblock
PDERROR_OVERRIDDEN_PACKAGE_TAGS: in file Errors.inc, constant PDERROR_OVERRIDDEN_PACKAGE_TAGS
warning triggered when there a @package tag is used in a function,
PDERROR_OVERRIDDEN_SUBPACKAGE_TAGS: in file Errors.inc, constant PDERROR_OVERRIDDEN_SUBPACKAGE_TAGS
warning triggered when there a @subpackage tag is used in a function,
PDERROR_PACKAGECAT_SET: in file Errors.inc, constant PDERROR_PACKAGECAT_SET
warning triggered when a package is already associated with a category, and
PDERROR_PACKAGEOUTPUT_DELETES_PARENT_FILE: in file Errors.inc, constant PDERROR_PACKAGEOUTPUT_DELETES_PARENT_FILE
warning triggered when there are multiple @name tags in a docblock
PDERROR_PARENT_NOT_FOUND: in file Errors.inc, constant PDERROR_PARENT_NOT_FOUND
warning triggered when parent class doesn't exist
PDERROR_PARSEPRIVATE: in file Errors.inc, constant PDERROR_PARSEPRIVATE
warning triggered when an entire page is ignored because of @access private
PDERROR_PDFFUNCTION_NO_FUNC: in file Errors.inc, constant PDERROR_PDFFUNCTION_NO_FUNC
warning triggered when a <pdffunction:funcname /> tag is used in the PDF
PDERROR_PDF_METHOD_DOESNT_EXIST: in file Errors.inc, constant PDERROR_PDF_METHOD_DOESNT_EXIST
warning triggered when a <pdffunction:funcname /> tag is used in the PDF
PDERROR_PDF_TEMPVAR_DOESNT_EXIST: in file Errors.inc, constant PDERROR_PDF_TEMPVAR_DOESNT_EXIST
warning triggered when a <pdffunction:funcname arg=$tempvar/> tag
PDERROR_PRIVATE_ASSUMED: in file Errors.inc, constant PDERROR_PRIVATE_ASSUMED
warning triggered when no @access private tag is used in a
PDERROR_SOURCECODE_IGNORED: in file Errors.inc, constant PDERROR_SOURCECODE_IGNORED
warning triggered by sourcecode="on", if PHP < 4.3.0
PDERROR_SOURCE_TAG_FUNCTION_NOT_FOUND: in file Errors.inc, constant PDERROR_SOURCE_TAG_FUNCTION_NOT_FOUND
warning triggered when a { @source } inline tag is used in a docblock not
PDERROR_SOURCE_TAG_IGNORED: in file Errors.inc, constant PDERROR_SOURCE_TAG_IGNORED
warning triggered when an {@source} tag is found in a short description
PDERROR_TAG_NOT_HANDLED: in file Errors.inc, constant PDERROR_TAG_NOT_HANDLED
warning triggered by @filesource, if PHP < 4.3.0
PDERROR_TEMPLATEDIR_DOESNT_EXIST: in file Errors.inc, constant PDERROR_TEMPLATEDIR_DOESNT_EXIST
warning triggered by non-existent template directory
PDERROR_TEXT_OUTSIDE_LI: in file Errors.inc, constant PDERROR_TEXT_OUTSIDE_LI
warning triggered when text in a docblock list is not contained in
PDERROR_TUTORIAL_IS_OWN_CHILD: in file Errors.inc, constant PDERROR_TUTORIAL_IS_OWN_CHILD
warning triggered when a tutorial lists itself as a child tutorial
PDERROR_TUTORIAL_IS_OWN_GRANDPA: in file Errors.inc, constant PDERROR_TUTORIAL_IS_OWN_GRANDPA
warning triggered when a tutorial's child lists the parent tutorial
PDERROR_TUTORIAL_NOT_FOUND: in file Errors.inc, constant PDERROR_TUTORIAL_NOT_FOUND
warning triggered when a tutorial is referenced
PDERROR_TUTORIAL_SUBSECTION_NOT_FOUND: in file Errors.inc, constant PDERROR_TUTORIAL_SUBSECTION_NOT_FOUND
warning triggered when a subsection's title is asked for, but the subsection
PDERROR_UL_IN_UL: in file Errors.inc, constant PDERROR_UL_IN_UL
warning triggered if <ul> is nested inside <ul> and not <li>
PDERROR_UNCLOSED_TAG: in file Errors.inc, constant PDERROR_UNCLOSED_TAG
warning triggered when a DocBlock html tag is unclosed
PDERROR_UNDOCUMENTED_ELEMENT: in file Errors.inc, constant PDERROR_UNDOCUMENTED_ELEMENT
warning triggered when a class or method hasn't got docblock
PDERROR_UNKNOWN_COMMANDLINE: in file Errors.inc, constant PDERROR_UNKNOWN_COMMANDLINE
warning triggered when an entire page is ignored because of @access private
PDERROR_UNKNOWN_TAG: in file Errors.inc, constant PDERROR_UNKNOWN_TAG
warning triggered when classes in the same package have the same name
PDERROR_UNMATCHED_LIST_TAG: in file Errors.inc, constant PDERROR_UNMATCHED_LIST_TAG
warning triggered when a docblock has an unmatched <ol> or <ul>
PDERROR_UNMATCHED_TUTORIAL_TAG: in file Errors.inc, constant PDERROR_UNMATCHED_TUTORIAL_TAG
warning triggered when a docbook tag is not properly matched
PDERROR_UNTERMINATED_ATTRIB: in file Errors.inc, constant PDERROR_UNTERMINATED_ATTRIB
warning triggered when a subsection's title is asked for, but the subsection
PDERROR_UNTERMINATED_ENTITY: in file Errors.inc, constant PDERROR_UNTERMINATED_ENTITY
warning triggered by an unterminated entity in a tutorial
PDERROR_UNTERMINATED_INLINE_TAG: in file Errors.inc, constant PDERROR_UNTERMINATED_INLINE_TAG
warning triggered when an {@inline tag} is not terminated
$package: in file InlineTags.inc, variable parserIdInlineTag::$package
package of the {@id}
parserExampleInlineTag: in file InlineTags.inc, method parserExampleInlineTag::parserExampleInlineTag()
constructor
parserExampleInlineTag: in file InlineTags.inc, class parserExampleInlineTag
Represents the example inline tag, used to display an example file inside a docblock or tutorial
parserIdInlineTag: in file InlineTags.inc, class parserIdInlineTag
Represents the inline {@id} tag for tutorials
parserIdInlineTag: in file InlineTags.inc, method parserIdInlineTag::parserIdInlineTag()
constructor
parserInheritdocInlineTag: in file InlineTags.inc, method parserInheritdocInlineTag::parserInheritdocInlineTag()
Does nothing, overrides parent constructor
parserInheritdocInlineTag: in file InlineTags.inc, class parserInheritdocInlineTag
Represents the inheritdoc inline tag, used by classes/methods/vars to inherit documentation from the parent class if possible
parserInlineTag: in file InlineTags.inc, method parserInlineTag::parserInlineTag()
sets up the tag
parserInlineTag: in file InlineTags.inc, class parserInlineTag
Use this element to represent an {@inline tag} like {@link}
parserLinkInlineTag: in file InlineTags.inc, method parserLinkInlineTag::parserLinkInlineTag()
sets up the tag
parserLinkInlineTag: in file InlineTags.inc, class parserLinkInlineTag
represents inline links
parserSourceInlineTag: in file InlineTags.inc, method parserSourceInlineTag::parserSourceInlineTag()
constructor
parserSourceInlineTag: in file InlineTags.inc, class parserSourceInlineTag
represents inline source tag, used for function/method source
parserTocInlineTag: in file InlineTags.inc, method parserTocInlineTag::parserTocInlineTag()
constructor
parserTocInlineTag: in file InlineTags.inc, class parserTocInlineTag
Represents {@toc} for table of contents generation in tutorials
parserTutorialInlineTag: in file InlineTags.inc, method parserTutorialInlineTag::parserTutorialInlineTag()
constructor
parserTutorialInlineTag: in file InlineTags.inc, class parserTutorialInlineTag
Represents inline links to external tutorial documentation
$package: in file LinkClasses.inc, variable abstractLink::$package
$path: in file LinkClasses.inc, variable abstractLink::$path
pageLink: in file LinkClasses.inc, class pageLink
procedural page link
$package: in file ParserData.inc, variable parserPage::$package
$packageOutput: in file ParserData.inc, variable parserPage::$packageOutput
Used to limit output, contains contents of --packageoutput commandline.
$parent: in file ParserData.inc, variable parserData::$parent
parserPage element that is this parserData's parent, or false if not set.
$parserVersion: in file ParserData.inc, variable parserPage::$parserVersion
$path: in file ParserData.inc, variable parserPage::$path
$privateclasselements: in file ParserData.inc, variable parserData::$privateclasselements
array of parsed class elements with @access private
$privateelements: in file ParserData.inc, variable parserData::$privateelements
array of parsed elements with @access private
parserBase: in file ParserData.inc, class parserBase
Base class for all elements
parserData: in file ParserData.inc, class parserData
Contains an in-memory representation of all documentable elements (parserPage, parserFunction, parserDefine, parserInclude, parserClass, parserMethod, parserVar) and their DocBlocks (parserDocBlock).
parserPage: in file ParserData.inc, method parserPage::parserPage()
sets package to default package
parserPage: in file ParserData.inc, class parserPage
Contains information about a PHP file, used to group procedural elements together.
parserStringWithInlineTags: in file ParserData.inc, class parserStringWithInlineTags
Used to represent strings that contain inline tags, so that they can be properly parsed at link time
ParserData.inc: procedural page ParserData.inc
$package: in file ParserDocBlock.inc, variable parserDocBlock::$package
$packagedescrip: in file ParserDocBlock.inc, variable parserDocBlock::$packagedescrip
description of package parsed from @package tag
$params: in file ParserDocBlock.inc, variable parserDocBlock::$params
array of param data.
$processed_desc: in file ParserDocBlock.inc, variable parserDocBlock::$processed_desc
$processed_sdesc: in file ParserDocBlock.inc, variable parserDocBlock::$processed_sdesc
$properties: in file ParserDocBlock.inc, variable parserDocBlock::$properties
array of parserPropertyTag, parserPropertyReadTag, parserPropertyWriteTag, parserMethodTag magic tags
parserDesc: in file ParserDocBlock.inc, class parserDesc
represents a short or long description in a DocBlock (parserDocBlock)
parserDocBlock: in file ParserDocBlock.inc, method parserDocBlock::parserDocBlock()
sets package to default
parserDocBlock: in file ParserDocBlock.inc, class parserDocBlock
Represents a docblock and its components, $desc, $sdesc, $tags, and also $params for functions
ParserDocBlock.inc: procedural page ParserDocBlock.inc
postProcess: in file ParserDocBlock.inc, method parserDocBlock::postProcess()
Parse out any html tags from doc comments, and make them into
$package: in file ParserElements.inc, variable parserTutorial::$package
$package: in file ParserElements.inc, variable parserPackagePage::$package
$params: in file ParserElements.inc, variable parserFunction::$params
parameters parsed from function definition.
$parent: in file ParserElements.inc, variable parserClass::$parent
Format: array(file, parent) where parent class is found or false if no parent
$parent: in file ParserElements.inc, variable parserTutorial::$parent
link to the parent tutorial in a document series, or false if none
$path: in file ParserElements.inc, variable parserTutorial::$path
path to the tutorial page
$path: in file ParserElements.inc, variable parserElement::$path
full path location of this element (filename)
$prev: in file ParserElements.inc, variable parserTutorial::$prev
link to the previous tutorial in a document series, or false if none
parserClass: in file ParserElements.inc, class parserClass
parserConst: in file ParserElements.inc, method parserConst::parserConst()
parserConst: in file ParserElements.inc, class parserConst
parserDefine: in file ParserElements.inc, class parserDefine
parserElement: in file ParserElements.inc, class parserElement
all elements except parserPackagePage descend from this abstract class
parserFunction: in file ParserElements.inc, class parserFunction
parserGlobal: in file ParserElements.inc, class parserGlobal
parserInclude: in file ParserElements.inc, class parserInclude
parserMethod: in file ParserElements.inc, class parserMethod
parserMethod: in file ParserElements.inc, method parserMethod::parserMethod()
parserPackagePage: in file ParserElements.inc, method parserPackagePage::parserPackagePage()
parserPackagePage: in file ParserElements.inc, class parserPackagePage
parserTutorial: in file ParserElements.inc, method parserTutorial::parserTutorial()
parserTutorial: in file ParserElements.inc, class parserTutorial
parserVar: in file ParserElements.inc, class parserVar
parserVar: in file ParserElements.inc, method parserVar::parserVar()
ParserElements.inc: procedural page ParserElements.inc
$package: in file Parser.inc, variable ppageParser::$package
$pars: in file XMLpackagePageParser.inc, variable XMLPackagePageParser::$pars
packageTagHandler: in file Parser.inc, method Parser::packageTagHandler()
handles @package
paramTagHandler: in file Parser.inc, method Parser::paramTagHandler()
handles @param
parse: in file XMLpackagePageParser.inc, method XMLPackagePageParser::parse()
Parse a new file
parse: in file ParserDescCleanup.inc, method parserDescParser::parse()
Parse a long or short description for tags
parse: in file TutorialHighlightParser.inc, method phpDocumentor_TutorialHighlightParser::parse()
Parse a new file
parse: in file phpDocumentorTParser.inc, method phpDocumentorTParser::parse()
Parse a new file
parse: in file Parser.inc, method ppageParser::parse()
Parse a new file
parse: in file Parser.inc, method Parser::parse()
Parse a new file
parse: in file HighlightParser.inc, method phpDocumentor_HighlightParser::parse()
Parse a new file
Parser: in file Parser.inc, class Parser
PHP Parser for PHP 4.2.3-
Parser: in file Parser.inc, method Parser::Parser()
Set up invariant parsing variables
parserDescParser: in file ParserDescCleanup.inc, method parserDescParser::parserDescParser()
sets $wp to be a ObjectWordParser
parserDescParser: in file ParserDescCleanup.inc, class parserDescParser
Parses a DocBlock description to retrieve abstract representations of
PARSER_EVENT_ACCESS_MODIFIER: in file Parser.inc, constant PARSER_EVENT_ACCESS_MODIFIER
used when parsing an access modifier
PARSER_EVENT_ARRAY: in file Parser.inc, constant PARSER_EVENT_ARRAY
used when an array definition is encountered in parsing
PARSER_EVENT_CLASS: in file Parser.inc, constant PARSER_EVENT_CLASS
used when a class definition is encountered in parsing
PARSER_EVENT_CLASS_CONSTANT: in file Parser.inc, constant PARSER_EVENT_CLASS_CONSTANT
used when a class implements interfaces
PARSER_EVENT_CLASS_MEMBER: in file Parser.inc, constant PARSER_EVENT_CLASS_MEMBER
used by the HighlightParser only, when ->var or ->function() is encountered in a method
PARSER_EVENT_COMMENT: in file Parser.inc, constant PARSER_EVENT_COMMENT
used when short comment // is encountered in parsing
PARSER_EVENT_COMMENTBLOCK: in file Parser.inc, constant PARSER_EVENT_COMMENTBLOCK
used when long comment /x x/ where x is an asterisk is encountered in parsing
PARSER_EVENT_DEFINE: in file Parser.inc, constant PARSER_EVENT_DEFINE
used when a define statement is encountered in parsing
PARSER_EVENT_DEFINE_GLOBAL: in file Parser.inc, constant PARSER_EVENT_DEFINE_GLOBAL
used when parsing a global variable declaration
PARSER_EVENT_DEFINE_PARAMS: in file Parser.inc, constant PARSER_EVENT_DEFINE_PARAMS
used when a define statement opening parenthesis is encountered in parsing
PARSER_EVENT_DEFINE_PARAMS_PARENTHESIS: in file Parser.inc, constant PARSER_EVENT_DEFINE_PARAMS_PARENTHESIS
used when a define statement's opening parenthesis is encountered in parsing
PARSER_EVENT_DESC: in file Parser.inc, constant PARSER_EVENT_DESC
used when parsing the desc part of a docblock
PARSER_EVENT_DOCBLOCK: in file Parser.inc, constant PARSER_EVENT_DOCBLOCK
used when a DocBlock is encountered in parsing
PARSER_EVENT_DOCBLOCK_TEMPLATE: in file Parser.inc, constant PARSER_EVENT_DOCBLOCK_TEMPLATE
used when encountering a /**#@+ comment marking a new docblock template
PARSER_EVENT_DOCKEYWORD: in file Parser.inc, constant PARSER_EVENT_DOCKEYWORD
used when a @tag is encountered in DocBlock parsing
PARSER_EVENT_DOCKEYWORD_EMAIL: in file Parser.inc, constant PARSER_EVENT_DOCKEYWORD_EMAIL
used when a <email@address> is encountered in parsing an @author tag
PARSER_EVENT_END_DOCBLOCK_TEMPLATE: in file Parser.inc, constant PARSER_EVENT_END_DOCBLOCK_TEMPLATE
used when encountering a /**#@-* / comment (no space) marking the end of using a docblock template
PARSER_EVENT_END_STATEMENT: in file Parser.inc, constant PARSER_EVENT_END_STATEMENT
PARSER_EVENT_EOFQUOTE: in file Parser.inc, constant PARSER_EVENT_EOFQUOTE
used when a <<< is encountered in parsing
PARSER_EVENT_ESCAPE: in file Parser.inc, constant PARSER_EVENT_ESCAPE
used when a backslash is encountered in parsing a string or other escapable entity
PARSER_EVENT_FUNCTION: in file Parser.inc, constant PARSER_EVENT_FUNCTION
used when a function definition is encountered in parsing
PARSER_EVENT_FUNCTION_PARAMS: in file Parser.inc, constant PARSER_EVENT_FUNCTION_PARAMS
used when a function statement opening parenthesis is encountered in parsing
PARSER_EVENT_FUNCTION_PARAM_VAR: in file Parser.inc, constant PARSER_EVENT_FUNCTION_PARAM_VAR
used when a $param is encountered in a function definition
PARSER_EVENT_FUNC_GLOBAL: in file Parser.inc, constant PARSER_EVENT_FUNC_GLOBAL
used when parsing a "global $var1, $var2;" declaration in a function
PARSER_EVENT_GLOBAL_VALUE: in file Parser.inc, constant PARSER_EVENT_GLOBAL_VALUE
used when parsing the default value in a global variable declaration
PARSER_EVENT_IMPLEMENTS: in file Parser.inc, constant PARSER_EVENT_IMPLEMENTS
used when a class implements interfaces
PARSER_EVENT_INCLUDE: in file Parser.inc, constant PARSER_EVENT_INCLUDE
used when an include/require/include_once/include_once statement is encountered in parsing
PARSER_EVENT_INCLUDE_PARAMS: in file Parser.inc, constant PARSER_EVENT_INCLUDE_PARAMS
used when an opening parenthesis of an include/require/include_once/include_once statement is encountered in parsing
PARSER_EVENT_INCLUDE_PARAMS_PARENTHESIS: in file Parser.inc, constant PARSER_EVENT_INCLUDE_PARAMS_PARENTHESIS
used when an inner ( ) is encountered while parsing an include/require/include_once/include_once statement
PARSER_EVENT_INLINE_DOCKEYWORD: in file Parser.inc, constant PARSER_EVENT_INLINE_DOCKEYWORD
used when an inline {@tag} is encountered in parsing a DocBlock
PARSER_EVENT_LOGICBLOCK: in file Parser.inc, constant PARSER_EVENT_LOGICBLOCK
{ encountered in parsing a function or php code
PARSER_EVENT_METHOD: in file Parser.inc, constant PARSER_EVENT_METHOD
used by the HighlightParser only, when a method starts
PARSER_EVENT_METHOD_LOGICBLOCK: in file Parser.inc, constant PARSER_EVENT_METHOD_LOGICBLOCK
used by the HighlightParser only, when a method body is parsed
PARSER_EVENT_NOEVENTS: in file Parser.inc, constant PARSER_EVENT_NOEVENTS
used for the beginning of parsing, before first < ? php encountered
PARSER_EVENT_OUTPHP: in file Parser.inc, constant PARSER_EVENT_OUTPHP
used when a ? > (with no space) is encountered in parsing
PARSER_EVENT_PHPCODE: in file Parser.inc, constant PARSER_EVENT_PHPCODE
used when php code processor instruction (< ? php) is encountered in parsing
PARSER_EVENT_QUOTE: in file Parser.inc, constant PARSER_EVENT_QUOTE
used when double quotation mark (") encountered in parsing
PARSER_EVENT_QUOTE_VAR: in file Parser.inc, constant PARSER_EVENT_QUOTE_VAR
used by the HighlightParser only, when {$var} is encountered in a string
PARSER_EVENT_SINGLEQUOTE: in file Parser.inc, constant PARSER_EVENT_SINGLEQUOTE
used when a single quote (') is encountered in parsing
PARSER_EVENT_STATIC_VAR: in file Parser.inc, constant PARSER_EVENT_STATIC_VAR
used when parsing a "static $var1, $var2;" declaration in a function
PARSER_EVENT_STATIC_VAR_VALUE: in file Parser.inc, constant PARSER_EVENT_STATIC_VAR_VALUE
used when parsing the value in a "static $var1 = x" declaration in a function
PARSER_EVENT_TAGS: in file Parser.inc, constant PARSER_EVENT_TAGS
used when parsing the @tag block of a docblock
PARSER_EVENT_VAR: in file Parser.inc, constant PARSER_EVENT_VAR
used when a var statement is encountered in parsing a class definition
PARSER_EVENT_VAR_ARRAY: in file Parser.inc, constant PARSER_EVENT_VAR_ARRAY
used when a variable value is an array
PARSER_EVENT_VAR_ARRAY_COMMENT: in file Parser.inc, constant PARSER_EVENT_VAR_ARRAY_COMMENT
used when a comment is found in a variable array value
parseString: in file Tokenizer.php, method phpDocumentor_XML_Beautifier_Tokenizer::parseString()
Parse a new file
Parser.inc: procedural page Parser.inc
ParserDescCleanup.inc: procedural page ParserDescCleanup.inc
phpDocumentorTParser.inc: procedural page phpDocumentorTParser.inc
phpDocumentorTWordParser.inc: procedural page phpDocumentorTWordParser.inc
phpDocumentorTParser: in file phpDocumentorTParser.inc, method phpDocumentorTParser::phpDocumentorTParser()
Constructor
phpDocumentorTParser: in file phpDocumentorTParser.inc, class phpDocumentorTParser
Tokenizer-based parser for PHP source code
PHPDOCUMENTOR_EVENT_CLASS: in file Parser.inc, constant PHPDOCUMENTOR_EVENT_CLASS
Class published to IntermediateParser with this event
PHPDOCUMENTOR_EVENT_CONST: in file Parser.inc, constant PHPDOCUMENTOR_EVENT_CONST
Class Constant published to IntermediateParser with this event
PHPDOCUMENTOR_EVENT_DEFINE: in file Parser.inc, constant PHPDOCUMENTOR_EVENT_DEFINE
Constant (define) published to IntermediateParser with this event
PHPDOCUMENTOR_EVENT_DOCBLOCK: in file Parser.inc, constant PHPDOCUMENTOR_EVENT_DOCBLOCK
DocBlock published to IntermediateParser with this event
PHPDOCUMENTOR_EVENT_DOCBLOCK_TEMPLATE: in file Parser.inc, constant PHPDOCUMENTOR_EVENT_DOCBLOCK_TEMPLATE
used when a docblock template is encountered in the source
PHPDOCUMENTOR_EVENT_END_DOCBLOCK_TEMPLATE: in file Parser.inc, constant PHPDOCUMENTOR_EVENT_END_DOCBLOCK_TEMPLATE
used when a docblock template is encountered in the source
PHPDOCUMENTOR_EVENT_END_PAGE: in file Parser.inc, constant PHPDOCUMENTOR_EVENT_END_PAGE
used to inform phpDocumentor_IntermediateParser that the current file has been completely parsed.
PHPDOCUMENTOR_EVENT_FUNCTION: in file Parser.inc, constant PHPDOCUMENTOR_EVENT_FUNCTION
Function published to IntermediateParser with this event
PHPDOCUMENTOR_EVENT_GLOBAL: in file Parser.inc, constant PHPDOCUMENTOR_EVENT_GLOBAL
used when a global variable definition is encountered in the source
PHPDOCUMENTOR_EVENT_INCLUDE: in file Parser.inc, constant PHPDOCUMENTOR_EVENT_INCLUDE
Include (include/require/include_once/include_once) published to IntermediateParser with this event
PHPDOCUMENTOR_EVENT_MESSAGE: in file Parser.inc, constant PHPDOCUMENTOR_EVENT_MESSAGE
PHPDOCUMENTOR_EVENT_NEWFILE: in file Parser.inc, constant PHPDOCUMENTOR_EVENT_NEWFILE
use to inform ErrorTracker of a new file being parsed
PHPDOCUMENTOR_EVENT_NEWLINENUM: in file Parser.inc, constant PHPDOCUMENTOR_EVENT_NEWLINENUM
use to inform ErrorTracker of the next line number being parsed
PHPDOCUMENTOR_EVENT_NEWSTATE: in file Parser.inc, constant PHPDOCUMENTOR_EVENT_NEWSTATE
use to inform IntermediateParser of a new element being parsed
PHPDOCUMENTOR_EVENT_PACKAGEPAGE: in file Parser.inc, constant PHPDOCUMENTOR_EVENT_PACKAGEPAGE
Package-level page published to IntermediateParser with this event
PHPDOCUMENTOR_EVENT_PAGE: in file Parser.inc, constant PHPDOCUMENTOR_EVENT_PAGE
New File (page) published to IntermediateParser with this event
PHPDOCUMENTOR_EVENT_README_INSTALL_CHANGELOG: in file Parser.inc, constant PHPDOCUMENTOR_EVENT_README_INSTALL_CHANGELOG
Contents of README/INSTALL/CHANGELOG files published to IntermediateParser with this event
PHPDOCUMENTOR_EVENT_TUTORIAL: in file Parser.inc, constant PHPDOCUMENTOR_EVENT_TUTORIAL
Tutorial published to IntermediateParser with this event
PHPDOCUMENTOR_EVENT_VAR: in file Parser.inc, constant PHPDOCUMENTOR_EVENT_VAR
Class Variable published to IntermediateParser with this event
phpDocumentor_HighlightParser: in file HighlightParser.inc, class phpDocumentor_HighlightParser
Highlights source code using parse()
phpDocumentor_HighlightParser: in file HighlightParser.inc, method phpDocumentor_HighlightParser::phpDocumentor_HighlightParser()
Initialize the $tokenpushEvent, $wordpushEvent arrays
phpDocumentor_HighlightWordParser: in file HighlightParser.inc, class phpDocumentor_HighlightWordParser
Retrieve tokens from an array of tokens organized by line numbers
PHPDOCUMENTOR_PDP_EVENT_ATTRIBUTES: in file XMLpackagePageParser.inc, constant PHPDOCUMENTOR_PDP_EVENT_ATTRIBUTES
when tag attributes name="value" are found
PHPDOCUMENTOR_PDP_EVENT_B: in file ParserDescCleanup.inc, constant PHPDOCUMENTOR_PDP_EVENT_B
when is found in a desc
PHPDOCUMENTOR_PDP_EVENT_BR: in file ParserDescCleanup.inc, constant PHPDOCUMENTOR_PDP_EVENT_BR
when is found in a desc
PHPDOCUMENTOR_PDP_EVENT_CDATA: in file XMLpackagePageParser.inc, constant PHPDOCUMENTOR_PDP_EVENT_CDATA
when <![CDATA[ ]]> is found
PHPDOCUMENTOR_PDP_EVENT_CODE: in file ParserDescCleanup.inc, constant PHPDOCUMENTOR_PDP_EVENT_CODE
when <code> is found in a desc
PHPDOCUMENTOR_PDP_EVENT_DOUBLECR: in file ParserDescCleanup.inc, constant PHPDOCUMENTOR_PDP_EVENT_DOUBLECR
when \n\n is found in a desc
PHPDOCUMENTOR_PDP_EVENT_ENTITY: in file XMLpackagePageParser.inc, constant PHPDOCUMENTOR_PDP_EVENT_ENTITY
when tag attributes name="value" are found
PHPDOCUMENTOR_PDP_EVENT_ESCAPE: in file ParserDescCleanup.inc, constant PHPDOCUMENTOR_PDP_EVENT_ESCAPE
when the << potential escape for tags is found in a desc
PHPDOCUMENTOR_PDP_EVENT_ESCAPE_CODE: in file ParserDescCleanup.inc, constant PHPDOCUMENTOR_PDP_EVENT_ESCAPE_CODE
when << /code>> is found in a <code></code> section
PHPDOCUMENTOR_PDP_EVENT_ESCAPE_PRE: in file ParserDescCleanup.inc, constant PHPDOCUMENTOR_PDP_EVENT_ESCAPE_PRE
when << /pre>> is found in a <pre></pre> section
PHPDOCUMENTOR_PDP_EVENT_I: in file ParserDescCleanup.inc, constant PHPDOCUMENTOR_PDP_EVENT_I
when is found in a desc
PHPDOCUMENTOR_PDP_EVENT_KBD: in file ParserDescCleanup.inc, constant PHPDOCUMENTOR_PDP_EVENT_KBD
when <kbd> is found in a desc
PHPDOCUMENTOR_PDP_EVENT_LIST: in file ParserDescCleanup.inc, constant PHPDOCUMENTOR_PDP_EVENT_LIST
when <ul>/<ol> is found in a desc
PHPDOCUMENTOR_PDP_EVENT_P: in file ParserDescCleanup.inc, constant PHPDOCUMENTOR_PDP_EVENT_P
when is found in a desc
PHPDOCUMENTOR_PDP_EVENT_PRE: in file ParserDescCleanup.inc, constant PHPDOCUMENTOR_PDP_EVENT_PRE
when <pre> is found in a desc
PHPDOCUMENTOR_PDP_EVENT_PROGRAMLISTING: in file XMLpackagePageParser.inc, constant PHPDOCUMENTOR_PDP_EVENT_PROGRAMLISTING
when <programlisting> is found
PHPDOCUMENTOR_PDP_EVENT_SAMP: in file ParserDescCleanup.inc, constant PHPDOCUMENTOR_PDP_EVENT_SAMP
when <samp> is found in a desc
PHPDOCUMENTOR_PDP_EVENT_SIMLIST: in file ParserDescCleanup.inc, constant PHPDOCUMENTOR_PDP_EVENT_SIMLIST
when a simple list is found in a desc
PHPDOCUMENTOR_PDP_EVENT_TAG: in file XMLpackagePageParser.inc, constant PHPDOCUMENTOR_PDP_EVENT_TAG
when a DocBook <tag> is found
PHPDOCUMENTOR_PDP_EVENT_VAR: in file ParserDescCleanup.inc, constant PHPDOCUMENTOR_PDP_EVENT_VAR
when <var> is found in a desc
PHPDOCUMENTOR_PDP_STATE_ATTRIBUTES: in file XMLpackagePageParser.inc, constant PHPDOCUMENTOR_PDP_STATE_ATTRIBUTES
when tag attributes name="value" are found
PHPDOCUMENTOR_PDP_STATE_B: in file ParserDescCleanup.inc, constant PHPDOCUMENTOR_PDP_STATE_B
when is found in a desc
PHPDOCUMENTOR_PDP_STATE_BR: in file ParserDescCleanup.inc, constant PHPDOCUMENTOR_PDP_STATE_BR
when is found in a desc
PHPDOCUMENTOR_PDP_STATE_CDATA: in file XMLpackagePageParser.inc, constant PHPDOCUMENTOR_PDP_STATE_CDATA
when <![CDATA[ ]]> is found
PHPDOCUMENTOR_PDP_STATE_CODE: in file ParserDescCleanup.inc, constant PHPDOCUMENTOR_PDP_STATE_CODE
when <code> is found in a desc
PHPDOCUMENTOR_PDP_STATE_DOUBLECR: in file ParserDescCleanup.inc, constant PHPDOCUMENTOR_PDP_STATE_DOUBLECR
when \n\n is found in a desc
PHPDOCUMENTOR_PDP_STATE_ENTITY: in file XMLpackagePageParser.inc, constant PHPDOCUMENTOR_PDP_STATE_ENTITY
when tag attributes name="value" are found
PHPDOCUMENTOR_PDP_STATE_ESCAPE: in file ParserDescCleanup.inc, constant PHPDOCUMENTOR_PDP_STATE_ESCAPE
when the << potential escape for tags is found in a desc
PHPDOCUMENTOR_PDP_STATE_ESCAPE_CODE: in file ParserDescCleanup.inc, constant PHPDOCUMENTOR_PDP_STATE_ESCAPE_CODE
when << /code>> is found in a <code></code> section
PHPDOCUMENTOR_PDP_STATE_ESCAPE_PRE: in file ParserDescCleanup.inc, constant PHPDOCUMENTOR_PDP_STATE_ESCAPE_PRE
when << /pre>> is found in a <pre></pre> section
PHPDOCUMENTOR_PDP_STATE_I: in file ParserDescCleanup.inc, constant PHPDOCUMENTOR_PDP_STATE_I
when is found in a desc
PHPDOCUMENTOR_PDP_STATE_KBD: in file ParserDescCleanup.inc, constant PHPDOCUMENTOR_PDP_STATE_KBD
when <kbd> is found in a desc
PHPDOCUMENTOR_PDP_STATE_LIST: in file ParserDescCleanup.inc, constant PHPDOCUMENTOR_PDP_STATE_LIST
when <ul>/<ol> is found in a desc
PHPDOCUMENTOR_PDP_STATE_P: in file ParserDescCleanup.inc, constant PHPDOCUMENTOR_PDP_STATE_P
when is found in a desc
PHPDOCUMENTOR_PDP_STATE_PRE: in file ParserDescCleanup.inc, constant PHPDOCUMENTOR_PDP_STATE_PRE
when <pre> is found in a desc
PHPDOCUMENTOR_PDP_STATE_PROGRAMLISTING: in file XMLpackagePageParser.inc, constant PHPDOCUMENTOR_PDP_STATE_PROGRAMLISTING
when <programlisting> is found
PHPDOCUMENTOR_PDP_STATE_SAMP: in file ParserDescCleanup.inc, constant PHPDOCUMENTOR_PDP_STATE_SAMP
when <samp> is found in a desc
PHPDOCUMENTOR_PDP_STATE_SIMLIST: in file ParserDescCleanup.inc, constant PHPDOCUMENTOR_PDP_STATE_SIMLIST
when a simple list is found in a desc
PHPDOCUMENTOR_PDP_STATE_TAG: in file XMLpackagePageParser.inc, constant PHPDOCUMENTOR_PDP_STATE_TAG
when a DocBook <tag> is found
PHPDOCUMENTOR_PDP_STATE_VAR: in file ParserDescCleanup.inc, constant PHPDOCUMENTOR_PDP_STATE_VAR
when <var> is found in a desc
phpDocumentor_peardoc2_XML_Beautifier: in file Beautifier.php, class phpDocumentor_peardoc2_XML_Beautifier
This is just like XML_Beautifier, but uses phpDocumentor_XML_Beautifier_Tokenizer
phpDocumentor_TutorialHighlightParser: in file TutorialHighlightParser.inc, class phpDocumentor_TutorialHighlightParser
Highlights source code using parse()
phpDocumentor_TutorialHighlightParser: in file TutorialHighlightParser.inc, method phpDocumentor_TutorialHighlightParser::phpDocumentor_TutorialHighlightParser()
Initialize the $tokenpushEvent, $wordpushEvent arrays
phpDocumentor_XML_Beautifier_Tokenizer: in file Tokenizer.php, class phpDocumentor_XML_Beautifier_Tokenizer
Highlights source code using parse()
phpDocumentor_XML_Beautifier_Tokenizer: in file Tokenizer.php, method phpDocumentor_XML_Beautifier_Tokenizer::phpDocumentor_XML_Beautifier_Tokenizer()
Initialize the $tokenpushEvent, $wordpushEvent arrays
PHPDOC_BEAUTIFIER_CDATA: in file Tokenizer.php, constant PHPDOC_BEAUTIFIER_CDATA
do not remove, needed in plain renderer
PHPDOC_XMLTOKEN_EVENT_ATTRIBUTE: in file Tokenizer.php, constant PHPDOC_XMLTOKEN_EVENT_ATTRIBUTE
used when a <tag attr="attribute"> is found
PHPDOC_XMLTOKEN_EVENT_CDATA: in file Tokenizer.php, constant PHPDOC_XMLTOKEN_EVENT_CDATA
used when a <! is found
PHPDOC_XMLTOKEN_EVENT_CLOSETAG: in file Tokenizer.php, constant PHPDOC_XMLTOKEN_EVENT_CLOSETAG
used when a close </tag> is found
PHPDOC_XMLTOKEN_EVENT_COMMENT: in file Tokenizer.php, constant PHPDOC_XMLTOKEN_EVENT_COMMENT
used when a  is found
PHPDOC_XMLTOKEN_EVENT_DEF: in file Tokenizer.php, constant PHPDOC_XMLTOKEN_EVENT_DEF
used when a <! is found
PHPDOC_XMLTOKEN_EVENT_DOUBLEQUOTE: in file Tokenizer.php, constant PHPDOC_XMLTOKEN_EVENT_DOUBLEQUOTE
used when a  is found
PHPDOC_XMLTOKEN_EVENT_ENTITY: in file Tokenizer.php, constant PHPDOC_XMLTOKEN_EVENT_ENTITY
used when an &entity; is found
PHPDOC_XMLTOKEN_EVENT_IN_CDATA: in file Tokenizer.php, constant PHPDOC_XMLTOKEN_EVENT_IN_CDATA
used when a <![CDATA[ section is found
PHPDOC_XMLTOKEN_EVENT_NOEVENTS: in file Tokenizer.php, constant PHPDOC_XMLTOKEN_EVENT_NOEVENTS
starting state
PHPDOC_XMLTOKEN_EVENT_OPENTAG: in file Tokenizer.php, constant PHPDOC_XMLTOKEN_EVENT_OPENTAG
used when an open <tag> is found
PHPDOC_XMLTOKEN_EVENT_PI: in file Tokenizer.php, constant PHPDOC_XMLTOKEN_EVENT_PI
used when a processor instruction is found
PHPDOC_XMLTOKEN_EVENT_SINGLEQUOTE: in file Tokenizer.php, constant PHPDOC_XMLTOKEN_EVENT_SINGLEQUOTE
used when a  is found
PHPDOC_XMLTOKEN_EVENT_XML: in file Tokenizer.php, constant PHPDOC_XMLTOKEN_EVENT_XML
used when a <?xml is found
ppageParser: in file Parser.inc, class ppageParser
Global package page parser
ppageParser: in file Parser.inc, method ppageParser::ppageParser()
set up invariant Parser variables
propertyTagHandler: in file Parser.inc, method Parser::propertyTagHandler()
Handles @property(-read or -write) and @method magic tag
parserCData: in file PackagePageElements.inc, class parserCData
Represents <![CDATA[ ]]> sections.
parserEntity: in file PackagePageElements.inc, method parserEntity::parserEntity()
sets up the entity
parserEntity: in file PackagePageElements.inc, class parserEntity
a standard entity like ”
parserXMLDocBookTag: in file PackagePageElements.inc, method parserXMLDocBookTag::parserXMLDocBookTag()
sets up the tag
parserXMLDocBookTag: in file PackagePageElements.inc, class parserXMLDocBookTag
a standard XML DocBook Tag
PackagePageElements.inc: procedural page PackagePageElements.inc
phpDocumentorTWordParser: in file phpDocumentorTWordParser.inc, class phpDocumentorTWordParser
Like WordParser, but expects an array of tokens from the tokenizer instead of a string.

top

q

$quietMode: in file IntermediateParser.inc, variable phpDocumentor_IntermediateParser::$quietMode
set in Setup.inc.php to the value of the quitemode commandline option.

top

r

$render: in file Setup.inc.php, variable phpDocumentor_setup::$render
Used to organize output from the Parser before Conversion
$ric: in file IntermediateParser.inc, variable phpDocumentor_IntermediateParser::$ric
Stores parsed CHANGELOG/INSTALL/README files
readCommandLineSettings: in file Setup.inc.php, method phpDocumentor_setup::readCommandLineSettings()
Get phpDocumentor settings from command-line or web interface
readConfigFile: in file Setup.inc.php, method phpDocumentor_setup::readConfigFile()
Get phpDocumentor settings from a user configuration file
readPhpFile: in file Io.inc, method Io::readPhpFile()
Reads a file and returns it as a string Does basic error checking
recurseDir: in file utilities.php, function recurseDir()
removeNonMatches: in file Io.inc, method Io::removeNonMatches()
Removes files from the $dir array that do not match the search string in
replaceElement: in file ProceduralPages.inc, method ProceduralPages::replaceElement()
Used to align an element with the package of its parent page prior to Conversion.
$returnType: in file DocBlockTags.inc, variable parserVarTag::$returnType
the type a var has
$returnType: in file DocBlockTags.inc, variable parserReturnTag::$returnType
the type a function returns
$returnType: in file DocBlockTags.inc, variable parserPropertyTag::$returnType
the type a property has
$returnType: in file DocBlockTags.inc, variable parserMethodTag::$returnType
the return type a method has
RecordError: in file Errors.inc, class RecordError
encapsulates error information
RecordWarning: in file Errors.inc, class RecordWarning
encapsulates warning information
RecordWarning: in file Errors.inc, method RecordWarning::RecordWarning()
Constructor
returnErrors: in file Errors.inc, method ErrorTracker::returnErrors()
Get sorted array of all non-fatal errors in parsing/conversion
returnLastError: in file Errors.inc, method ErrorTracker::returnLastError()
Get the error message of the last error
returnLastWarning: in file Errors.inc, method ErrorTracker::returnLastWarning()
Get the warning message of the last warning
returnWarnings: in file Errors.inc, method ErrorTracker::returnWarnings()
Get sorted array of all warnings in parsing/conversion
$return: in file ParserDocBlock.inc, variable parserDocBlock::$return
This is either a parserReturnTag or false if no return tag is present
replaceInheritDoc: in file ParserDocBlock.inc, method parserDesc::replaceInheritDoc()
replaces {@inheritdoc} with the contents of the parent DocBlock
replaceInheritDoc: in file ParserDocBlock.inc, method parserDocBlock::replaceInheritDoc()
Wrapper for parserDesc::replaceInheritDoc()
resetParams: in file ParserDocBlock.inc, method parserDocBlock::resetParams()
$returnsreference: in file ParserElements.inc, variable parserFunction::$returnsreference
Function returns a reference to an element, instead of a value
$refsect1id: in file XMLpackagePageParser.inc, variable XMLPackagePageParser::$refsect1id
$refsect2id: in file XMLpackagePageParser.inc, variable XMLPackagePageParser::$refsect2id
$refsect3id: in file XMLpackagePageParser.inc, variable XMLPackagePageParser::$refsect3id
returnTagHandler: in file Parser.inc, method Parser::returnTagHandler()
handles @return

top

s

$setup: in file Setup.inc.php, variable phpDocumentor_setup::$setup
Used to parse command-line options
$stack: in file EventStack.inc, variable EventStack::$stack
The stack
$subscriber: in file Publisher.inc, variable Publisher::$subscriber
Array of references objects that have Subscribed to this publisher
Setup.inc.php: procedural page Setup.inc.php
setClassParent: in file Classes.inc, method Classes::setClassParent()
Find the parent class of $class, and set up structures to note this fact
setDirectoriesToParse: in file Setup.inc.php, method phpDocumentor_setup::setDirectoriesToParse()
setFilesToParse: in file Setup.inc.php, method phpDocumentor_setup::setFilesToParse()
setIgnore: in file Setup.inc.php, method phpDocumentor_setup::setIgnore()
setJavadocDesc: in file Setup.inc.php, method phpDocumentor_setup::setJavadocDesc()
setMemoryLimit: in file Setup.inc.php, method phpDocumentor_setup::setMemoryLimit()
Allow a memory_limit setting in phpDocumentor.ini to override php.ini or default memory limit
setName: in file ProceduralPages.inc, method ProceduralPages::setName()
Change a page's name from its file to alias $name
setPackageOutput: in file Setup.inc.php, method phpDocumentor_setup::setPackageOutput()
setParseBase: in file ProceduralPages.inc, method ProceduralPages::setParseBase()
sets the parser base
setParsePrivate: in file IntermediateParser.inc, method phpDocumentor_IntermediateParser::setParsePrivate()
set display of elements marked with @access private
setParsePrivate: in file Setup.inc.php, method phpDocumentor_setup::setParsePrivate()
setQuietMode: in file Setup.inc.php, method phpDocumentor_setup::setQuietMode()
setQuietMode: in file IntermediateParser.inc, method phpDocumentor_IntermediateParser::setQuietMode()
set parsing information output mode (quiet or verbose)
setTargetDir: in file IntermediateParser.inc, method phpDocumentor_IntermediateParser::setTargetDir()
Sets the output directory
setTargetDir: in file Setup.inc.php, method phpDocumentor_setup::setTargetDir()
setTemplateBase: in file Setup.inc.php, method phpDocumentor_setup::setTemplateBase()
setTemplateBase: in file IntermediateParser.inc, method phpDocumentor_IntermediateParser::setTemplateBase()
Sets the template base directory
setTitle: in file Setup.inc.php, method phpDocumentor_setup::setTitle()
setUndocumentedElementWarnings: in file Setup.inc.php, method phpDocumentor_setup::setUndocumentedElementWarnings()
setUndocumentedElementWarningsMode: in file IntermediateParser.inc, method phpDocumentor_IntermediateParser::setUndocumentedElementWarningsMode()
show warnings for undocumented elements
setupPagePackages: in file ProceduralPages.inc, method ProceduralPages::setupPagePackages()
if there is one class package in a file, the parent path inherits the package if its package is default.
setupPages: in file ProceduralPages.inc, method ProceduralPages::setupPages()
Adjusts packages of all pages and removes name conflicts within a package
setup_dirs: in file Io.inc, function setup_dirs()
Recursively move contents of $struc into associative array
set_dir: in file Io.inc, function set_dir()
Recursively add all the subdirectories of $contents to $dir without erasing anything in
showImage: in file utilities.php, function showImage()
Allows png's with alpha transparency to be displayed in IE 6
SMART_PATH_DELIMITER: in file common.inc.php, constant SMART_PATH_DELIMITER
sortfiles: in file add_cvs.php, function sortfiles()
Sorting functions for the file list
subscribe: in file Publisher.inc, method Publisher::subscribe()
Adds a subscriber to the $subscriber array().
switchDirTree: in file utilities.php, function switchDirTree()
$source: in file DocBlockTags.inc, variable parserFileSourceTag::$source
$source: in file InlineTags.inc, variable parserSourceInlineTag::$source
tokenized source organized by line numbers for php 4.3.0+, the old
$start: in file InlineTags.inc, variable parserSourceInlineTag::$start
First line of source code to display
$subpackage: in file InlineTags.inc, variable parserIdInlineTag::$subpackage
subpackage of the {@id}
setPath: in file InlineTags.inc, method parserTocInlineTag::setPath()
set the path
setSource: in file InlineTags.inc, method parserSourceInlineTag::setSource()
sets the source tag's value
setSource: in file InlineTags.inc, method parserExampleInlineTag::setSource()
sets the source
setTOC: in file InlineTags.inc, method parserTocInlineTag::setTOC()
set the TOC
stringConvert: in file InlineTags.inc, method parserSourceInlineTag::stringConvert()
converter helper used in PHP 4.2.3-
Strlen: in file InlineTags.inc, method parserSourceInlineTag::Strlen()
only used to determine blank lines. {@source} will not be blank, probably
Strlen: in file InlineTags.inc, method parserInlineTag::Strlen()
get length of the tag
$section: in file LinkClasses.inc, variable tutorialLink::$section
$subpackage: in file LinkClasses.inc, variable abstractLink::$subpackage
$source: in file ParserData.inc, variable parserPage::$source
Tokenized source code of the file
$sourceLocation: in file ParserData.inc, variable parserPage::$sourceLocation
relative source location
$subpackage: in file ParserData.inc, variable parserPage::$subpackage
setDocBlock: in file ParserData.inc, method parserData::setDocBlock()
sets the docblock
setFile: in file ParserData.inc, method parserPage::setFile()
Sets the name to display in documentation (can be an alias set with @name)
setName: in file ParserData.inc, method parserPage::setName()
sets the name
setPackageOutput: in file ParserData.inc, method parserPage::setPackageOutput()
loads the package output array
setParent: in file ParserData.inc, method parserData::setParent()
sets the parent
setPath: in file ParserData.inc, method parserPage::setPath()
sets the path to the file
setSource: in file ParserData.inc, method parserStringWithInlineTags::setSource()
Pass source code to any {@source} tags contained within the string for later conversion.
setSource: in file ParserData.inc, method parserPage::setSource()
Sets the source code of the file for highlighting.
setSourceLocation: in file ParserData.inc, method parserPage::setSourceLocation()
sets the source location
setValue: in file ParserData.inc, method parserBase::setValue()
sets the given value
$sdesc: in file ParserDocBlock.inc, variable parserDocBlock::$sdesc
$statics: in file ParserDocBlock.inc, variable parserDocBlock::$statics
array of static variable data.
$subpackage: in file ParserDocBlock.inc, variable parserDocBlock::$subpackage
$subpackagedescrip: in file ParserDocBlock.inc, variable parserDocBlock::$subpackagedescrip
description of subpackage parsed from @package tag
setDesc: in file ParserDocBlock.inc, method parserDocBlock::setDesc()
setEndLineNumber: in file ParserDocBlock.inc, method parserDocBlock::setEndLineNumber()
Sets the ending line number for the DocBlock
setExplicitCategory: in file ParserDocBlock.inc, method parserDocBlock::setExplicitCategory()
Used if this docblock has a @category tag.
setExplicitPackage: in file ParserDocBlock.inc, method parserDocBlock::setExplicitPackage()
Used if this docblock has a @package tag.
setLineNumber: in file ParserDocBlock.inc, method parserDocBlock::setLineNumber()
Sets the starting line number for the DocBlock
setShortDesc: in file ParserDocBlock.inc, method parserDocBlock::setShortDesc()
Set the short description of the DocBlock
setSource: in file ParserDocBlock.inc, method parserDocBlock::setSource()
Passes to parserStringWithInlineTags::setSource()
$source: in file ParserElements.inc, variable parserFunction::$source
$sourceLocation: in file ParserElements.inc, variable parserClass::$sourceLocation
$statics: in file ParserElements.inc, variable parserFunction::$statics
static variable declarations parsed from function definition
setAccessModifiers: in file ParserElements.inc, method parserClass::setAccessModifiers()
Use this method to set access modifiers for a class
setConstructor: in file ParserElements.inc, method parserMethod::setConstructor()
Use this method to tell the parser that this method is the class constructor
setDataType: in file ParserElements.inc, method parserGlobal::setDataType()
Sets the name of the global variable's type
setDestructor: in file ParserElements.inc, method parserMethod::setDestructor()
Use this method to tell the parser that this method is the class constructor
setDocBlock: in file ParserElements.inc, method parserElement::setDocBlock()
setEndLineNumber: in file ParserElements.inc, method parserElement::setEndLineNumber()
Sets the ending line number of elements
setExtends: in file ParserElements.inc, method parserClass::setExtends()
setFile: in file ParserElements.inc, method parserElement::setFile()
setInterface: in file ParserElements.inc, method parserClass::setInterface()
Use this method to set the type of class to be an interface
setLineNumber: in file ParserElements.inc, method parserElement::setLineNumber()
Set starting line number
setModifiers: in file ParserElements.inc, method parserMethod::setModifiers()
Return name of the class that contains this method
setModifiers: in file ParserElements.inc, method parserVar::setModifiers()
Return name of the class that contains this method
setModifiers: in file ParserElements.inc, method parserClass::setModifiers()
Set the PHP5+ modifiers for this class
setName: in file ParserElements.inc, method parserElement::setName()
setNext: in file ParserElements.inc, method parserTutorial::setNext()
setParent: in file ParserElements.inc, method parserTutorial::setParent()
setParent: in file ParserElements.inc, method parserClass::setParent()
setParentNoClass: in file ParserElements.inc, method parserClass::setParentNoClass()
setPath: in file ParserElements.inc, method parserElement::setPath()
setPrev: in file ParserElements.inc, method parserTutorial::setPrev()
setReturnsReference: in file ParserElements.inc, method parserFunction::setReturnsReference()
sets $returnsreference to true
setSourceLocation: in file ParserElements.inc, method parserClass::setSourceLocation()
$source_location: in file phpDocumentorTParser.inc, variable phpDocumentorTParser::$source_location
relative path of the parsed file from the base parse directory
$subpackage: in file Parser.inc, variable ppageParser::$subpackage
setLineNum: in file HighlightParser.inc, method phpDocumentor_HighlightParser::setLineNum()
Start the parsing at a certain line number
setLineNum: in file TutorialHighlightParser.inc, method phpDocumentor_TutorialHighlightParser::setLineNum()
Start the parsing at a certain line number
setup: in file HighlightParser.inc, method phpDocumentor_HighlightWordParser::setup()
Initialize the parser object
setupStates: in file Parser.inc, method Parser::setupStates()
setup the parser tokens, and the pushEvent/popEvent arrays
setupStates: in file Parser.inc, method ppageParser::setupStates()
set up invariant Parser variables
setupStates: in file HighlightParser.inc, method phpDocumentor_HighlightParser::setupStates()
Initialize all parser state variables
setupStates: in file XMLpackagePageParser.inc, method XMLPackagePageParser::setupStates()
setup the parser tokens, and the pushEvent/popEvent arrays
setupStates: in file ParserDescCleanup.inc, method parserDescParser::setupStates()
setup the parser tokens, and the pushEvent/popEvent arrays
setupStates: in file Tokenizer.php, method phpDocumentor_XML_Beautifier_Tokenizer::setupStates()
Initialize all parser state variables
setupStates: in file TutorialHighlightParser.inc, method phpDocumentor_TutorialHighlightParser::setupStates()
Initialize all parser state variables
STATE_ACCESS_MODIFIER: in file Parser.inc, constant STATE_ACCESS_MODIFIER
currently parsing an access modifier
STATE_ARRAY: in file Parser.inc, constant STATE_ARRAY
currently parsing an array
STATE_CLASS: in file Parser.inc, constant STATE_CLASS
currently parsing a class definition
STATE_CLASS_CONSTANT: in file Parser.inc, constant STATE_CLASS_CONSTANT
currently parsing a class constant
STATE_CLASS_MEMBER: in file Parser.inc, constant STATE_CLASS_MEMBER
currently parsing a class member using the HighlightParser
STATE_COMMENT: in file Parser.inc, constant STATE_COMMENT
currently parsing a short comment //
STATE_COMMENTBLOCK: in file Parser.inc, constant STATE_COMMENTBLOCK
currently parsing a long comment /x x/ where x is an asterisk
STATE_DEFINE: in file Parser.inc, constant STATE_DEFINE
currently parsing a define statement
STATE_DEFINE_PARAMS: in file Parser.inc, constant STATE_DEFINE_PARAMS
currently parsing the stuff in ( ) of a define statement
STATE_DEFINE_PARAMS_PARENTHESIS: in file Parser.inc, constant STATE_DEFINE_PARAMS_PARENTHESIS
currently parsing an inner parenthetical statement of a define( )
STATE_DESC: in file Parser.inc, constant STATE_DESC
currently parsing the desc part of a docblock
STATE_DOCBLOCK: in file Parser.inc, constant STATE_DOCBLOCK
currently parsing a DocBlock
STATE_DOCBLOCK_TEMPLATE: in file Parser.inc, constant STATE_DOCBLOCK_TEMPLATE
currently parsing the value in a "static $var1 = x" declaration in a function
STATE_DOCKEYWORD: in file Parser.inc, constant STATE_DOCKEYWORD
currently parsing a @tag in a DocBlock
STATE_DOCKEYWORD_EMAIL: in file Parser.inc, constant STATE_DOCKEYWORD_EMAIL
currently parsing an email in brackets in an @author tag of a DocBlock
STATE_END_CLASS: in file Parser.inc, constant STATE_END_CLASS
used to tell Render that a class has been completely parsed, and to flush buffers
STATE_END_DOCBLOCK_TEMPLATE: in file Parser.inc, constant STATE_END_DOCBLOCK_TEMPLATE
currently parsing the value in a "static $var1 = x" declaration in a function
STATE_EOFQUOTE: in file Parser.inc, constant STATE_EOFQUOTE
currently parsing a string defined using Perl <<<
STATE_ESCAPE: in file Parser.inc, constant STATE_ESCAPE
used when a backslash is encountered in parsing a string or other escapable entity
STATE_FUNCTION: in file Parser.inc, constant STATE_FUNCTION
currently parsing a Function or Method
STATE_FUNCTION_PARAMS: in file Parser.inc, constant STATE_FUNCTION_PARAMS
currently parsing the stuff in ( ) of a function definition
STATE_FUNCTION_PARAM_VAR: in file Parser.inc, constant STATE_FUNCTION_PARAM_VAR
currently parsing a $param in a function definition
STATE_FUNC_GLOBAL: in file Parser.inc, constant STATE_FUNC_GLOBAL
currently parsing a "global $var1, $var2;" declaration in a function
STATE_GLOBAL: in file Parser.inc, constant STATE_GLOBAL
currently parsing a global variable declaration
STATE_GLOBAL_VALUE: in file Parser.inc, constant STATE_GLOBAL_VALUE
currently parsing the default value in a global variable declaration
STATE_IMPLEMENTS: in file Parser.inc, constant STATE_IMPLEMENTS
currently parsing an implements clause
STATE_INCLUDE: in file Parser.inc, constant STATE_INCLUDE
currently parsing an include/require/include_once/include_once
STATE_INCLUDE_PARAMS: in file Parser.inc, constant STATE_INCLUDE_PARAMS
currently parsing the stuff in ( ) of a define statement
STATE_INCLUDE_PARAMS_PARENTHESIS: in file Parser.inc, constant STATE_INCLUDE_PARAMS_PARENTHESIS
currently parsing an inner parenthetical statement of an include/includeonce/require/requireonce( )
STATE_INLINE_DOCKEYWORD: in file Parser.inc, constant STATE_INLINE_DOCKEYWORD
currently parsing an inline tag like { @link} in a DocBlock
STATE_LOGICBLOCK: in file Parser.inc, constant STATE_LOGICBLOCK
currently parsing a { } block
STATE_METHOD: in file Parser.inc, constant STATE_METHOD
currently parsing a method using the HighlightParser
STATE_METHOD_LOGICBLOCK: in file Parser.inc, constant STATE_METHOD_LOGICBLOCK
currently parsing the method body using the HighlightParser
STATE_NOEVENTS: in file Parser.inc, constant STATE_NOEVENTS
out of < ? php tag
STATE_OUTPHP: in file Parser.inc, constant STATE_OUTPHP
currently out of php code
STATE_PHPCODE: in file Parser.inc, constant STATE_PHPCODE
currently parsing php code
STATE_QUOTE: in file Parser.inc, constant STATE_QUOTE
currently parsing a quote
STATE_QUOTE_VAR: in file Parser.inc, constant STATE_QUOTE_VAR
currently parsing a {$encapsed_var} using the HighlightParser
STATE_SINGLEQUOTE: in file Parser.inc, constant STATE_SINGLEQUOTE
currently parsing a string enclosed in single quotes (')
STATE_STATIC_VAR: in file Parser.inc, constant STATE_STATIC_VAR
currently parsing a "static $var1, $var2;" declaration in a function
STATE_STATIC_VAR_VALUE: in file Parser.inc, constant STATE_STATIC_VAR_VALUE
currently parsing the value in a "static $var1 = x" declaration in a function
STATE_TAGS: in file Parser.inc, constant STATE_TAGS
currently parsing the @tag block of a docblock
STATE_TUTORIAL_ATTRIBUTE: in file TutorialHighlightParser.inc, constant STATE_TUTORIAL_ATTRIBUTE
currently parsing an open <tag>
STATE_TUTORIAL_CLOSETAG: in file TutorialHighlightParser.inc, constant STATE_TUTORIAL_CLOSETAG
currently parsing a close </tag>
STATE_TUTORIAL_COMMENT: in file TutorialHighlightParser.inc, constant STATE_TUTORIAL_COMMENT
currently parsing a
STATE_TUTORIAL_DOUBLEQUOTE: in file TutorialHighlightParser.inc, constant STATE_TUTORIAL_DOUBLEQUOTE
currently parsing a
STATE_TUTORIAL_ENTITY: in file TutorialHighlightParser.inc, constant STATE_TUTORIAL_ENTITY
currently parsing an &entity;
STATE_TUTORIAL_ITAG: in file TutorialHighlightParser.inc, constant STATE_TUTORIAL_ITAG
currently parsing an {@inline tag}
STATE_TUTORIAL_NOEVENTS: in file TutorialHighlightParser.inc, constant STATE_TUTORIAL_NOEVENTS
currently in starting state
STATE_TUTORIAL_OPENTAG: in file TutorialHighlightParser.inc, constant STATE_TUTORIAL_OPENTAG
currently parsing an open <tag>
STATE_TUTORIAL_SINGLEQUOTE: in file TutorialHighlightParser.inc, constant STATE_TUTORIAL_SINGLEQUOTE
currently parsing a
STATE_VAR: in file Parser.inc, constant STATE_VAR
currently parsing a Class variable
STATE_VAR_ARRAY: in file Parser.inc, constant STATE_VAR_ARRAY
currently parsing a variable value is an array
STATE_VAR_ARRAY_COMMENT: in file Parser.inc, constant STATE_VAR_ARRAY_COMMENT
currently parsing a comment in a variable array value
STATE_XMLTOKEN_ATTRIBUTE: in file Tokenizer.php, constant STATE_XMLTOKEN_ATTRIBUTE
currently parsing an open <tag>
STATE_XMLTOKEN_CDATA: in file Tokenizer.php, constant STATE_XMLTOKEN_CDATA
currently parsing a <!
STATE_XMLTOKEN_CLOSETAG: in file Tokenizer.php, constant STATE_XMLTOKEN_CLOSETAG
currently parsing a close </tag>
STATE_XMLTOKEN_COMMENT: in file Tokenizer.php, constant STATE_XMLTOKEN_COMMENT
currently parsing a
STATE_XMLTOKEN_DEF: in file Tokenizer.php, constant STATE_XMLTOKEN_DEF
currently parsing a <!
STATE_XMLTOKEN_DOUBLEQUOTE: in file Tokenizer.php, constant STATE_XMLTOKEN_DOUBLEQUOTE
currently parsing a
STATE_XMLTOKEN_ENTITY: in file Tokenizer.php, constant STATE_XMLTOKEN_ENTITY
currently parsing an &entity;
STATE_XMLTOKEN_IN_CDATA: in file Tokenizer.php, constant STATE_XMLTOKEN_IN_CDATA
currently parsing a <![CDATA[ ]]>
STATE_XMLTOKEN_NOEVENTS: in file Tokenizer.php, constant STATE_XMLTOKEN_NOEVENTS
currently in starting state
STATE_XMLTOKEN_OPENTAG: in file Tokenizer.php, constant STATE_XMLTOKEN_OPENTAG
currently parsing an open <tag>
STATE_XMLTOKEN_PI: in file Tokenizer.php, constant STATE_XMLTOKEN_PI
currently in processor instruction
STATE_XMLTOKEN_SINGLEQUOTE: in file Tokenizer.php, constant STATE_XMLTOKEN_SINGLEQUOTE
currently parsing a
STATE_XMLTOKEN_XML: in file Tokenizer.php, constant STATE_XMLTOKEN_XML
currently parsing a <?xml
staticvarTagHandler: in file Parser.inc, method Parser::staticvarTagHandler()
handles @staticvar
setId: in file PackagePageElements.inc, method parserXMLDocBookTag::setId()
If the id attribute is present, this method will set its id
setTitle: in file PackagePageElements.inc, method parserXMLDocBookTag::setTitle()
Set the title of a DocBook tag section.
setTOC: in file PackagePageElements.inc, method parserXMLDocBookTag::setTOC()
sets the TOC value
startCData: in file PackagePageElements.inc, method parserXMLDocBookTag::startCData()
Begin a new CData section
setPos: in file WordParser.inc, method WordParser::setPos()
Set the internal cursor within the source code
setSeperator: in file WordParser.inc, method WordParser::setSeperator()
Sets the list of possible separator tokens
setup: in file WordParser.inc, method WordParser::setup()
Initialize the WordParser
setup: in file phpDocumentorTWordParser.inc, method phpDocumentorTWordParser::setup()
Uses http://www.php.net/token_get_all to tokenize the source code.
setup: in file ParserDescCleanup.inc, method ObjectWordParser::setup()
Set the word parser to go.
setWhitespace: in file WordParser.inc, method WordParser::setWhitespace()
set parser to return or strip whitespace

top

t

$targetDir: in file IntermediateParser.inc, variable phpDocumentor_IntermediateParser::$targetDir
used to set the output directory
$templateBase: in file IntermediateParser.inc, variable phpDocumentor_IntermediateParser::$templateBase
used to set the template base directory
$title: in file IntermediateParser.inc, variable phpDocumentor_IntermediateParser::$title
$title: in file create_examples.php, global variable $title
Title of the generated documentation
$tokens: in file Publisher.inc, variable Publisher::$tokens
$type: in file IntermediateParser.inc, variable phpDocumentor_IntermediateParser::$type
type of the current parser Element being handled
top.php: procedural page top.php
tokenizer_test.php: procedural page tokenizer_test.php
tokenizer_ext: in file common.inc.php, constant tokenizer_ext
$type: in file DocBlockTags.inc, variable parserTag::$type
Type is used by many functions to skip the hassle of
$type: in file Errors.inc, variable RecordWarning::$type
name of global variable that descriptors for this warning/error is kept
$type: in file Errors.inc, variable RecordError::$type
name of global variable that descriptors for this warning/error is kept
$tutorial: in file InlineTags.inc, variable parserIdInlineTag::$tutorial
full name of the tutorial
$type: in file InlineTags.inc, variable parserInlineTag::$type
Element type
$title: in file LinkClasses.inc, variable tutorialLink::$title
$type: in file LinkClasses.inc, variable pageLink::$type
$type: in file LinkClasses.inc, variable tutorialLink::$type
$type: in file LinkClasses.inc, variable varLink::$type
$type: in file LinkClasses.inc, variable methodLink::$type
$type: in file LinkClasses.inc, variable globalLink::$type
$type: in file LinkClasses.inc, variable constLink::$type
$type: in file LinkClasses.inc, variable defineLink::$type
$type: in file LinkClasses.inc, variable abstractLink::$type
element type linked to.
$type: in file LinkClasses.inc, variable functionLink::$type
$type: in file LinkClasses.inc, variable classLink::$type
tutorialLink: in file LinkClasses.inc, class tutorialLink
tutorial link
$tutorial: in file ParserData.inc, variable parserData::$tutorial
$type: in file ParserData.inc, variable parserStringWithInlineTags::$type
Type is used by many functions to skip the hassle of if phpDocumentor_get_class($blah) == 'parserBlah'...
$type: in file ParserData.inc, variable parserPage::$type
Type is used by many functions to skip the hassle of if
$type: in file ParserData.inc, variable parserData::$type
Type is used by many functions to skip the hassle of if
$type: in file ParserData.inc, variable parserBase::$type
Type is used by many functions to skip the hassle of if
trimmedStrlen: in file ParserData.inc, method parserStringWithInlineTags::trimmedStrlen()
equivalent to trim(strlen($string))
$tags: in file ParserDocBlock.inc, variable parserDocBlock::$tags
array of parserTags
$type: in file ParserDocBlock.inc, variable parserDesc::$type
Type is used by many functions to skip the hassle of if phpDocumentor_get_class($blah) == 'parserBlah'
$tutorial: in file ParserElements.inc, variable parserClass::$tutorial
$tutorial_type: in file ParserElements.inc, variable parserTutorial::$tutorial_type
Either cls, pkg, or proc
$type: in file ParserElements.inc, variable parserPackagePage::$type
Type is used by many functions to skip the hassle of if phpDocumentor_get_class($blah) == 'parserBlah'
$type: in file ParserElements.inc, variable parserTutorial::$type
Type is used by many functions to skip the hassle of if phpDocumentor_get_class($blah) == 'parserBlah'
$type: in file ParserElements.inc, variable parserVar::$type
Type is used by many functions to skip the hassle of if phpDocumentor_get_class($blah) == 'parserBlah'
$type: in file ParserElements.inc, variable parserMethod::$type
Type is used by many functions to skip the hassle of if phpDocumentor_get_class($blah) == 'parserBlah'
$type: in file ParserElements.inc, variable parserGlobal::$type
Type is used by many functions to skip the hassle of if phpDocumentor_get_class($blah) == 'parserBlah'
$type: in file ParserElements.inc, variable parserClass::$type
Type is used by many functions to skip the hassle of if phpDocumentor_get_class($blah) == 'parserBlah'
$type: in file ParserElements.inc, variable parserConst::$type
Type is used by many functions to skip the hassle of if phpDocumentor_get_class($blah) == 'parserBlah'
$type: in file ParserElements.inc, variable parserDefine::$type
Type is used by many functions to skip the hassle of if phpDocumentor_get_class($blah) == 'parserBlah'
$type: in file ParserElements.inc, variable parserFunction::$type
Type is used by many functions to skip the hassle of if phpDocumentor_get_class($blah) == 'parserBlah'
$type: in file ParserElements.inc, variable parserInclude::$type
Type is used by many functions to skip the hassle of if phpDocumentor_get_class($blah) == 'parserBlah'
Tokenizer.php: procedural page Tokenizer.php
TutorialHighlightParser.inc: procedural page TutorialHighlightParser.inc
TUTORIAL_EVENT_ATTRIBUTE: in file TutorialHighlightParser.inc, constant TUTORIAL_EVENT_ATTRIBUTE
used when a <tag attr="attribute"> is found
TUTORIAL_EVENT_CLOSETAG: in file TutorialHighlightParser.inc, constant TUTORIAL_EVENT_CLOSETAG
used when a close </tag> is found
TUTORIAL_EVENT_COMMENT: in file TutorialHighlightParser.inc, constant TUTORIAL_EVENT_COMMENT
used when a  is found
TUTORIAL_EVENT_DOUBLEQUOTE: in file TutorialHighlightParser.inc, constant TUTORIAL_EVENT_DOUBLEQUOTE
used when a  is found
TUTORIAL_EVENT_ENTITY: in file TutorialHighlightParser.inc, constant TUTORIAL_EVENT_ENTITY
used when an &entity; is found
TUTORIAL_EVENT_ITAG: in file TutorialHighlightParser.inc, constant TUTORIAL_EVENT_ITAG
used when an {@inline tag} is found
TUTORIAL_EVENT_NOEVENTS: in file TutorialHighlightParser.inc, constant TUTORIAL_EVENT_NOEVENTS
starting state
TUTORIAL_EVENT_OPENTAG: in file TutorialHighlightParser.inc, constant TUTORIAL_EVENT_OPENTAG
used when an open <tag> is found
TUTORIAL_EVENT_SINGLEQUOTE: in file TutorialHighlightParser.inc, constant TUTORIAL_EVENT_SINGLEQUOTE
used when a  is found
T_ABSTRACT: in file Parser.inc, constant T_ABSTRACT
T_CONST: in file Parser.inc, constant T_CONST
T_DOC_COMMENT: in file Parser.inc, constant T_DOC_COMMENT
T_FINAL: in file Parser.inc, constant T_FINAL
T_IMPLEMENTS: in file Parser.inc, constant T_IMPLEMENTS
T_INTERFACE: in file Parser.inc, constant T_INTERFACE
T_ML_COMMENT: in file Parser.inc, constant T_ML_COMMENT
T_PRIVATE: in file Parser.inc, constant T_PRIVATE
T_PROTECTED: in file Parser.inc, constant T_PROTECTED
T_PUBLIC: in file Parser.inc, constant T_PUBLIC
tokenEquals: in file phpDocumentorTWordParser.inc, method phpDocumentorTWordParser::tokenEquals()
Utility function to determine whether two tokens from the tokenizer are equal

top

u

$undocumentedElementWarnings: in file IntermediateParser.inc, variable phpDocumentor_IntermediateParser::$undocumentedElementWarnings
set in Setup.inc.php to the value of the undocumentedElementWarnings commandline option.
$uses: in file IntermediateParser.inc, variable phpDocumentor_IntermediateParser::$uses
utilities.php: procedural page utilities.php
$unknown_tags: in file ParserDocBlock.inc, variable parserDocBlock::$unknown_tags
array of unrecognized parserTags
updateGlobals: in file ParserDocBlock.inc, method parserDocBlock::updateGlobals()
replaces nameless global variables in the $funcglobals array with their names
updateModifiers: in file ParserDocBlock.inc, method parserDocBlock::updateModifiers()
updateParams: in file ParserDocBlock.inc, method parserDocBlock::updateParams()
replaces nameless parameters in the $params array with their names
updateStatics: in file ParserDocBlock.inc, method parserDocBlock::updateStatics()
replaces nameless static variables in the $statics array with their names
usesTagHandler: in file Parser.inc, method Parser::usesTagHandler()
handles @uses

top

v

$valid_booleans: in file Io.inc, variable Io::$valid_booleans
A specific array of values that boolean-based arguments can understand, aided by the decideOnOrOff() helper method.
vdump_par: in file utilities.php, function vdump_par()
varLink: in file LinkClasses.inc, class varLink
class variable link
$value: in file ParserData.inc, variable parserStringWithInlineTags::$value
array of strings and parserInlineTags
$value: in file ParserData.inc, variable parserBase::$value
set to different things by its descendants
$var: in file ParserDocBlock.inc, variable parserDocBlock::$var
This is either a parserVarTag or false if no var tag is present
varTagHandler: in file Parser.inc, method Parser::varTagHandler()
handles @var

top

w

writeSource: in file DocBlockTags.inc, method parserFileSourceTag::writeSource()
have the output converter write the source code
$warnings: in file Errors.inc, variable ErrorTracker::$warnings
array of RecordWarnings
WordParser.inc: procedural page WordParser.inc
WordParser: in file WordParser.inc, class WordParser
Retrieves tokens from source code for use by the Parser

top

x

XMLpackagePageParser.inc: procedural page XMLpackagePageParser.inc
XMLPackagePageParser: in file XMLpackagePageParser.inc, method XMLPackagePageParser::XMLPackagePageParser()
Set up the wordparser
XMLPackagePageParser: in file XMLpackagePageParser.inc, class XMLPackagePageParser
Used to parse XML DocBook-based tutorials

top