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 _ top

_

$_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()
_guessPackage: in file IntermediateParser.inc, method phpDocumentor_IntermediateParser::_guessPackage()
Guess the package/subpackage based on subdirectory if the --pear option
_IN_PHP5: in file common.inc.php, constant _IN_PHP5
_setupIgnore: in file Io.inc, method Io::_setupIgnore()
Construct the $ignore array
$_implements: in file ParserElements.inc, variable parserClass::$_implements
$_modifiers: in file ParserElements.inc, variable parserVar::$_modifiers
$_modifiers: in file ParserElements.inc, variable parserMethod::$_modifiers
$_xml: in file ParserElements.inc, variable parserTutorial::$_xml

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 ProceduralPages.inc, method ProceduralPages::addPage()
sets up the $pages array
addPage: in file IntermediateParser.inc, method phpDocumentor_IntermediateParser::addPage()
Replaces the parserPage represented by $this->pages[$path] with $page
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]
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
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

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

$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.
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()
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
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
$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: 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
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
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,
$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, class Io
Class to handle file and user io opperations
Io: in file Io.inc, method Io::Io()
creates an array $this->phpDocOptions and sets program options in it.
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