[phpDocumentor] element index

Package indexes

All elements
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
$_phpDocumentor_setting in Setup.inc.php
$_phpDocumentor_setting is either the value from the web interface, or is set up by Io::parseArgv()
_guessPackage
Guess the package/subpackage based on subdirectory if the --pear option
_IN_PHP5
_IN_PHP5 in common.inc.php
_setupIgnore
Construct the $ignore array
$_implements
parserClass::$_implements in ParserElements.inc
$_modifiers
parserVar::$_modifiers in ParserElements.inc
$_modifiers
parserMethod::$_modifiers in ParserElements.inc
$_xml
parserTutorial::$_xml in ParserElements.inc
a
top
$all_packages
list of all packages encountered while documenting. Used in automatic linking.
addClass
Classes::addClass() in Classes.inc
While parsing, add a class to the list of parsed classes
addClassPackageToFile
adds a package from a class to the current file
addConst
Classes::addConst() in Classes.inc
While parsing, add a variable to the list of parsed variables
addConverter
Add a converter name to use to the list of converters
addDefine
ProceduralPages::addDefine() in ProceduralPages.inc
sets up the $definesbyfile array using $curfile
addElementToPage
adds a processed descendant of parserElement to the $pages array or $privatepages array
addFunction
ProceduralPages::addFunction() in ProceduralPages.inc
sets up the $functionsbyfile array using $curfile
addGlobal
ProceduralPages::addGlobal() in ProceduralPages.inc
sets up the $globalsbyfile array using $curfile
addInclude
ProceduralPages::addInclude() in ProceduralPages.inc
sets up the $includesbyfile array using $curfile
addMethod
Classes::addMethod() in Classes.inc
While parsing, add a method to the list of parsed methods
addPackageParent
If the parent class of $class is in a different package, adds it to the
addPackageToFile
Mark a package as being used in a class
addPage
ProceduralPages::addPage() in ProceduralPages.inc
sets up the $pages array
addPage
Replaces the parserPage represented by $this->pages[$path] with $page
addPageIfNecessary
add a new parserPage to the $pages array if none is found
addPagePackage
ProceduralPages::addPagePackage() in ProceduralPages.inc
Changes the package of the page represented by $path
addPrivatePage
Adds a parserPage element to the parserData element in $this->privatepages[$path]
addUses
Add all the @uses tags from $element to the $uses array so that @usedby
addVar
Classes::addVar() in Classes.inc
While parsing, add a variable to the list of parsed variables
actions.php
actions.php in actions.php
addItem
parserList::addItem() in DescHTML.inc
add an item to a list
addList
parserList::addList() in DescHTML.inc
add a list
addError
add a new error to the $errors array
addError
addError() in Errors.inc
add an Error
addErrorDie
addErrorDie() in Errors.inc
like addError() but exits parsing
addErrorReturn
add a new error to the $errors array and returns the error string
addWarning
add a new warning to the $warnings array
addWarning
addWarning() in Errors.inc
add a Warning
arrayConvert
converter helper used in PHP 4.3.0+
arrayConvert
converter helper for PHP 4.3.0+
abstractLink
abstractLink in LinkClasses.inc
linking classes parent
addLink
tutorialLink::addLink() in LinkClasses.inc
sets up the link
addLink
abstractLink::addLink() in LinkClasses.inc
sets up the link
addLink
methodLink::addLink() in LinkClasses.inc
sets up the link
add
equivalent to the . operator ($a = $b . $c)
addElement
parserData::addElement() in ParserData.inc
add a new element to the tracking array
addLink
parserData::addLink() in ParserData.inc
adds a link
addTutorial
parserData::addTutorial() in ParserData.inc
adds a tutorial parser
add
parserDesc::add() in ParserDocBlock.inc
addAccess
parserDocBlock::addAccess() in ParserDocBlock.inc
add an @access tag to the tags array
addExample
parserDocBlock::addExample() in ParserDocBlock.inc
adds an @example tag
addFileSource
parserDocBlock::addFileSource() in ParserDocBlock.inc
Adds a new @filesource tag to the DocBlock
addFuncGlobal
parserDocBlock::addFuncGlobal() in ParserDocBlock.inc
adds a function declaration of @global to the $funcglobals array
addKeyword
parserDocBlock::addKeyword() in ParserDocBlock.inc
addLink
parserDocBlock::addLink() in ParserDocBlock.inc
creates a parserLinkTag and adds it to the $tags array
addName
parserDocBlock::addName() in ParserDocBlock.inc
Adds a @name tag to the tag list
addPackage
parserDocBlock::addPackage() in ParserDocBlock.inc
addParam
parserDocBlock::addParam() in ParserDocBlock.inc
addProperty
parserDocBlock::addProperty() in ParserDocBlock.inc
Adds a @property(-read or -write) or @method magic tag to the DocBlock
addReturn
parserDocBlock::addReturn() in ParserDocBlock.inc
creates a parserReturnTag and adds it to the $tags array
addSee
parserDocBlock::addSee() in ParserDocBlock.inc
creates a parserLinkTag and adds it to the $tags array
addStaticVar
parserDocBlock::addStaticVar() in ParserDocBlock.inc
addTag
parserDocBlock::addTag() in ParserDocBlock.inc
Used to insert DocBlock Template tags into a docblock
addUnknownTag
parserDocBlock::addUnknownTag() in ParserDocBlock.inc
adds an unknown tag to the $unknown_tags array for use by custom converters
addUses
parserDocBlock::addUses() in ParserDocBlock.inc
Add a @uses tag to the DocBlock
addVar
parserDocBlock::addVar() in ParserDocBlock.inc
creates a parserVarTag and adds it to the $tags array
addGlobals
parserFunction::addGlobals() in ParserElements.inc
Add all "global $var, $var2" declarations to this function
addImplements
parserClass::addImplements() in ParserElements.inc
addParam
parserMethod::addParam() in ParserElements.inc
addParam
parserFunction::addParam() in ParserElements.inc
addSource
parserFunction::addSource() in ParserElements.inc
Set the source code. Always array in PHP 4.3.0+
addStatics
parserFunction::addStatics() in ParserElements.inc
Add all "static $var, $var2 = 6" declarations to this function
addTutorial
parserClass::addTutorial() in ParserElements.inc
$attributes
parserXMLDocBookTag::$attributes in PackagePageElements.inc
Attributes from the XML tag
add
parserXMLDocBookTag::add() in PackagePageElements.inc
Add contents to this tag.
addAttribute
parserXMLDocBookTag::addAttribute() in PackagePageElements.inc
Add an xml tag attribute name="value" pair
addCData
parserXMLDocBookTag::addCData() in PackagePageElements.inc
add a word to CData
addFileSource
phpDocumentorTWordParser::addFileSource() in phpDocumentorTWordParser.inc
Wrapper for addSource() used to retrieve the entire source code organized by line number in setup()
addSource
phpDocumentorTWordParser::addSource() in phpDocumentorTWordParser.inc
Generate source token arrays organized by line number
b
top
bug_772441
bug_772441 in bug-772441.php
builder.php
builder.php in builder.php
bug-560532.php
bug-560532.php in bug-560532.php
bug-772441.php
bug-772441.php in bug-772441.php
backupPos
back the word parser to the previous token as defined by $last_token
Beautifier.php
Beautifier.php in Beautifier.php
backupPos
WordParser::backupPos() in WordParser.inc
Backup to the previous token so that it can be retrieved again in a new context.
backupPos
phpDocumentorTWordParser::backupPos() in phpDocumentorTWordParser.inc
backs the parser up to the previous position
c
top
$classes
used to keep track of inheritance at the smartest level possible for a
$converters
an array of template names indexed by converter name
$curfile
ProceduralPages::$curfile in ProceduralPages.inc
file being parsed, used in every add function to match up elements with the file that contains them
$cur_class
Name of the class currently being parsed.
checkForBugCondition
checkForBugCondition() in Setup.inc.php
Crash in case of known, dangerous bug condition
checkIgnore
Tell whether to ignore a file or a directory allows * and ? wildcards
checkIgnoreTag
ClasselementCmp
does a natural case sort on two class elements (either parserClass, parserMethod or parserVar
Classes
Classes in Classes.inc
Intermediate class parsing structure.
Convert
Interface to the Converter
createDocs
config.php
config.php in config.php
Classes.inc
Classes.inc in Classes.inc
clone.inc.php
clone.inc.php in clone.inc.php
clone5.inc.php
clone5.inc.php in clone5.inc.php
common.inc.php
common.inc.php in common.inc.php
Convert
parserList::Convert() in DescHTML.inc
performs the conversion of list tags
Convert
parserPre::Convert() in DescHTML.inc
performs the conversion of code tags
Convert
parserSamp::Convert() in DescHTML.inc
performs the conversion of sample tags
Convert
parserKbd::Convert() in DescHTML.inc
performs the conversion of keyboard tags
Convert
parserI::Convert() in DescHTML.inc
performs the conversion of italic tags
Convert
parserBr::Convert() in DescHTML.inc
performs the conversion of linebreak tags
Convert
parserCode::Convert() in DescHTML.inc
performs the conversion of code tags
Convert
parserDescVar::Convert() in DescHTML.inc
performs the conversion of variable tags
Convert
parserB::Convert() in DescHTML.inc
performs the conversion of bold tags
$converted_returnType
contains a link to the documentation for a class passed as a type in @return, @var or @param
Convert
parserTag::Convert() in DocBlockTags.inc
Perform the output conversion on this parserTag using the output converter that is passed in
Convert
parserTutorialTag::Convert() in DocBlockTags.inc
process this tag through the given output converter
Convert
parserUsedByTag::Convert() in DocBlockTags.inc
process this tag through the given output converter
Convert
parserUsesTag::Convert() in DocBlockTags.inc
Return a link to documentation for other element, and description of how it is used
Convert
parserSeeTag::Convert() in DocBlockTags.inc
process this tag through the given output converter
Convert
parserReturnTag::Convert() in DocBlockTags.inc
process this tag through the given output converter (sets up the $converted_returnType)
Convert
parserFileSourceTag::Convert() in DocBlockTags.inc
Return a link to the highlighted source and generate the source
Convert
parserNameTag::Convert() in DocBlockTags.inc
process this tag through the given output converter
Convert
parserAccessTag::Convert() in DocBlockTags.inc
process this tag through the given output converter
ConvertSource
convert the source code
ConvertSource
convert the source code
$curfile
$category
category of the [email protected]}
Convert
converter method
Convert
convert part of the tag
Convert
convert the tag
Convert
calls the output conversion
Convert
converter
Convert
only sets a warning and returns empty
ConvertPart
convert part of the tag
$category
abstractLink::$category in LinkClasses.inc
$class
methodLink::$class in LinkClasses.inc
classLink
classLink in LinkClasses.inc
class link
constLink
constLink in LinkClasses.inc
class constant link
$category
parserPage::$category in ParserData.inc
$classelements
parserData::$classelements in ParserData.inc
array of parsed class elements
$clean
parserData::$clean in ParserData.inc
Convert
Use to convert the string to a real string with all inline tags parsed and linked
$category
parserDocBlock::$category in ParserDocBlock.inc
canSource
parserDocBlock::canSource() in ParserDocBlock.inc
Tells the DocBlock it can have a @filesource tag
cantSource
parserDocBlock::cantSource() in ParserDocBlock.inc
Tells the DocBlock it can't have a @filesource tag
changeGlobal
parserDocBlock::changeGlobal() in ParserDocBlock.inc
changeParam
parserDocBlock::changeParam() in ParserDocBlock.inc
changeStatic
parserDocBlock::changeStatic() in ParserDocBlock.inc
$children
parserTutorial::$children in ParserElements.inc
links to the child tutorials, or false if none
$class
parserVar::$class in ParserElements.inc
$class
parserMethod::$class in ParserElements.inc
$class
parserConst::$class in ParserElements.inc
$conflicts
parserElement::$conflicts in ParserElements.inc
$curfile
parserClass::$curfile in ParserElements.inc
Convert
parserPackagePage::Convert() in ParserElements.inc
Convert
parserTutorial::Convert() in ParserElements.inc
$context
XMLPackagePageParser::$context in XMLpackagePageParser.inc
categoryTagHandler
handles @category
checkEventPop
This function checks whether parameter $word is a token for popping the current event off of the Event Stack.
checkEventPop
this function checks whether parameter $word is a token for popping the current event off of the Event Stack.
checkEventPop
this function checks whether parameter $word is a token for popping the current event off of the Event Stack.
checkEventPush
this function checks whether parameter $word is a token for pushing a new event onto the Event Stack.
checkEventPush
this function checks whether parameter $word is a token for pushing a new event onto the Event Stack.
checkEventPush
This function checks whether parameter $word is a token for pushing a new event onto the Event Stack.
configWordParser
Tell the parser's WordParser $wp to set up tokens to parse words by.
configWordParser
tell the parser's WordParser $wp to set up tokens to parse words by.
configWordParser
Give the word parser necessary data to begin a new parse
configWordParser
tell the parser's WordParser $wp to set up tokens to parse words by.
Convert
parserXMLDocBookTag::Convert() in PackagePageElements.inc
calls the output conversion
Convert
parserEntity::Convert() in PackagePageElements.inc
calls the output conversion
Convert
parserCData::Convert() in PackagePageElements.inc
calls the output conversion
concatTokens
phpDocumentorTWordParser::concatTokens() in phpDocumentorTWordParser.inc
Utility function to convert a series of tokens into a string
d
top
$data
phpDocumentor_IntermediateParser::$data in IntermediateParser.inc
$data contains parsed structures for the current page being parsed
$db_template
$defineconflicts
ProceduralPages::$defineconflicts in ProceduralPages.inc
Namespace conflicts within all documented packages of functions
$definesbyfile
ProceduralPages::$definesbyfile in ProceduralPages.inc
array of parsed defines organized by the full path of the file that contains the define.
$definesbynamefile
array of file names organized by defines that are in the file.
$dirs
contents of --directory commandline
debug
debug() in common.inc.php
Debugging output
decideOnOrOff
decideOnOrOff() in Setup.inc.php
Fuzzy logic to interpret the boolean args' intent
dirList
Io::dirList() in Io.inc
displayHelpMsg
create the help message for display on the command-line
DescHTML.inc
DescHTML.inc in DescHTML.inc
DocBlockTags.inc
DocBlockTags.inc in DocBlockTags.inc
$data
RecordWarning::$data in Errors.inc
error string
defineLink
defineLink in LinkClasses.inc
define link
$docblock
parserData::$docblock in ParserData.inc
DocBlock (parserDocBlock) for this page, or false if not set
$desc
parserDocBlock::$desc in ParserDocBlock.inc
$datatype
parserGlobal::$datatype in ParserElements.inc
Name of the global's data type
$docblock
parserElement::$docblock in ParserElements.inc
defaultHandler
Handles all non-inline tags
defaultTagHandler
Handles all standard tags that only have a description
doSimpleList
parserDescParser::doSimpleList() in ParserDescCleanup.inc
Return a simple list, if found
e
top
$event_handlers
the functions which handle output from the Parser
elementCmp
does a natural case sort on two parserElement descendants
EventStack
EventStack in EventStack.inc
An event Stack
EventStack.inc
EventStack.inc in EventStack.inc
$errors
ErrorTracker::$errors in Errors.inc
array of RecordErrors
ErrorTracker
ErrorTracker in Errors.inc
contains all the errors/warnings
Errors.inc
Errors.inc in Errors.inc
$end
parserSourceInlineTag::$end in InlineTags.inc
Last line to display
$elements
parserData::$elements in ParserData.inc
array of parsed elements
explicitDocBlock
Tells this page that its DocBlock was not implicit
$endlinenumber
parserDocBlock::$endlinenumber in ParserDocBlock.inc
Line number in the source on which this docblock ends
$explicitcategory
parserDocBlock::$explicitcategory in ParserDocBlock.inc
fix for bug 708559
$explicitpackage
parserDocBlock::$explicitpackage in ParserDocBlock.inc
fix for bug 591396
$endlinenumber
parserElement::$endlinenumber in ParserElements.inc
line number on file where this element stops
$extends
parserClass::$extends in ParserElements.inc
$eventHandlers
XMLPackagePageParser::$eventHandlers in XMLpackagePageParser.inc
$eventHandlers
$eventHandlers
phpDocumentorTParser::$eventHandlers in phpDocumentorTParser.inc
endTag
Parser::endTag() in Parser.inc
Called to clean up at the end of parsing a @tag in a docblock
exampleTagHandler
handles @example
endCData
parserXMLDocBookTag::endCData() in PackagePageElements.inc
Adds $_cdata to $value
f
top
$files
contents of --filename commandline
$functionconflicts
Namespace conflicts within all documented packages of functions
$functionsbyfile
ProceduralPages::$functionsbyfile in ProceduralPages.inc
array of parsed functions organized by the full path of the file that contains the function.
$functionsbynamefile
array of file names organized by functions that are in the file.
file_dialog.php
file_dialog.php in file_dialog.php
fancy_debug
fancy_debug() in common.inc.php
Returns a formatted var_dump for debugging purposes.
$file
RecordWarning::$file in Errors.inc
file this error occurred in
$fileAlias
abstractLink::$fileAlias in LinkClasses.inc
phpdoc alias _phpdoc_inc for phpdoc.inc
functionLink
functionLink in LinkClasses.inc
function link
$file
parserPage::$file in ParserData.inc
filename.ext (no path)
$funcglobals
parserDocBlock::$funcglobals in ParserDocBlock.inc
array of global variable data.
$file
parserElement::$file in ParserElements.inc
location of this element (filename)
formatFile
format a file or URL
formatString
format an XML string
find_phpdoc.php
find_phpdoc.php in find_phpdoc.php
findGlobal
phpDocumentorTWordParser::findGlobal() in phpDocumentorTWordParser.inc
Tell the phpDocumentorTWordParser to return the entire global variable if it is found.
g
top
$globalconflicts
ProceduralPages::$globalconflicts in ProceduralPages.inc
Namespace conflicts within all documented packages of functions
$globalsbyfile
ProceduralPages::$globalsbyfile in ProceduralPages.inc
array of parsed global variables organized by the full path of the file that contains the global variable definition.
$globalsbynamefile
array of file names organized by global variables that are in the file.
getAllFiles
Take a filename with wildcards and return all files that match the
getBase
Io::getBase() in Io.inc
Retrieve common directory (case-insensitive in windows)
getClass
Classes::getClass() in Classes.inc
Get the parserClass representation of a class from its name and file
getClassByPackage
Search for a class in a package
getClassesInPath
Used by parserData::getClasses() to retrieve classes defined in file $path
getConflicts
If a package contains two classes with the same name, this function finds that conflict
getDefiniteChildren
Get all classes confirmed in parsing to be descended class $parclass in file $file
getDir
getDir() in utilities.php
getDirTree
getEvent
EventStack::getEvent() in EventStack.inc
Get the current event
getParentClass
Find the parent class of a class in file $file
getPathInfo
ProceduralPages::getPathInfo() in ProceduralPages.inc
gathers path-related info about a given element
getReadmeInstallChangelog
getRealPath
ProceduralPages::getRealPath() in ProceduralPages.inc
Ensures the path to the file is an absolute path
getRegExpableSearchString
Converts $s into a string that can be used with preg_match
getRoots
Classes::getRoots() in Classes.inc
Get a list of all root classes indexed by package. Used to generate class trees by Converter
getTutorials
Retrieve tutorial subdirectories and their contents from the list of
get_include_path
getDescription
Get the description of how the element used is being used.
getSourceLink
gets path to the sourcecode file
getSourceLink
Retrieve a converter-specific link to the example
getString
parserTag::getString() in DocBlockTags.inc
Returns the text minus any inline tags
getString
parserAccessTag::getString() in DocBlockTags.inc
No inline tags are possible, returns 'public', 'protected' or 'private'
getProgramListing
Return the source for the example file, enclosed in a <programlisting> tag to use in a tutorial
getString
gets the source string
getString
always gets an empty string
globalLink
globalLink in LinkClasses.inc
global variable link
getClasses
parserData::getClasses() in ParserData.inc
returns a list of all classes declared in a file
getFile
parserPage::getFile() in ParserData.inc
gets the file name
getLink
parserData::getLink() in ParserData.inc
returns a link
getName
parserData::getName() in ParserData.inc
Get the output-safe filename (. changed to _)
getName
parserPage::getName() in ParserData.inc
gets the name
getPackageOutput
gets the package output array
getParseData
parserPage::getParseData() in ParserData.inc
Not implemented in this version
getPath
parserPage::getPath() in ParserData.inc
gets the path
getSourceLocation
gets the source location
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
parserData::getTutorial() in ParserData.inc
If this file has a tutorial associated with it, returns a link to the tutorial.
getType
parserPage::getType() in ParserData.inc
gets the tag type
getType
parserBase::getType() in ParserData.inc
gets the type
getValue
parserBase::getValue() in ParserData.inc
gets the value
getDesc
parserDocBlock::getDesc() in ParserDocBlock.inc
getEndLineNumber
Retrieve ending line number
getExplicitCategory
If the DocBlock has a @category tag, then this returns true
getExplicitPackage
If the DocBlock has a @package tag, then this returns true
getKeyword
parserDocBlock::getKeyword() in ParserDocBlock.inc
getLineNumber
parserDocBlock::getLineNumber() in ParserDocBlock.inc
Retrieve starting line number
getSDesc
parserDocBlock::getSDesc() in ParserDocBlock.inc
getType
parserDocBlock::getType() in ParserDocBlock.inc
$globals
parserFunction::$globals in ParserElements.inc
global declarations parsed from function definition
getChildClassList
parserClass::getChildClassList() in ParserElements.inc
returns a list of all child classes of this class
getClass
parserVar::getClass() in ParserElements.inc
Retrieve the class name
getClass
parserMethod::getClass() in ParserElements.inc
Return name of the class that contains this method
getClass
parserConst::getClass() in ParserElements.inc
Retrieve the class name
getConflicts
parserFunction::getConflicts() in ParserElements.inc
Returns all functions in other packages that have the same name as this function
getConflicts
parserClass::getConflicts() in ParserElements.inc
Returns all classes in other packages that have the same name as this class
getConflicts
parserDefine::getConflicts() in ParserElements.inc
Returns all defines in other packages that have the same name as this define
getConflicts
parserGlobal::getConflicts() in ParserElements.inc
Returns all global variables in other packages that have the same name as this global variable
getConstNames
parserClass::getConstNames() in ParserElements.inc
getConsts
parserClass::getConsts() in ParserElements.inc
getDataType
parserGlobal::getDataType() in ParserElements.inc
Retrieve converter-specific representation of the data type
getEndLineNumber
parserElement::getEndLineNumber() in ParserElements.inc
getExtends
parserClass::getExtends() in ParserElements.inc
getFile
parserElement::getFile() in ParserElements.inc
getFunctionCall
parserMethod::getFunctionCall() in ParserElements.inc
adds "constructor " to start of function call if $isConstructor is true
getFunctionCall
parserFunction::getFunctionCall() in ParserElements.inc
Get a human-friendly description of the function call
getImplements
parserClass::getImplements() in ParserElements.inc
getImplements
parserMethod::getImplements() in ParserElements.inc
getInheritedConsts
parserClass::getInheritedConsts() in ParserElements.inc
getInheritedMethods
getInheritedVars
parserClass::getInheritedVars() in ParserElements.inc
getIntricateFunctionCall
getIntricateFunctionCall
Like getFunctionCall(), but has no English or pre-determined formatting.
getLineNumber
parserElement::getLineNumber() in ParserElements.inc
getLink
parserConst::getLink() in ParserElements.inc
quick way to link to this element
getLink
parserDefine::getLink() in ParserElements.inc
quick way to link to this element
getLink
parserTutorial::getLink() in ParserElements.inc
Get a link to this tutorial, or to any subsection of this tutorial
getLink
parserVar::getLink() in ParserElements.inc
quick way to link to this element
getLink
parserGlobal::getLink() in ParserElements.inc
quick way to link to this element
getLink
parserMethod::getLink() in ParserElements.inc
quick way to link to this element
getLink
parserFunction::getLink() in ParserElements.inc
quick way to link to this element
getLink
parserClass::getLink() in ParserElements.inc
quick way to link to this element
getMethod
parserClass::getMethod() in ParserElements.inc
getMethodNames
parserClass::getMethodNames() in ParserElements.inc
getMethods
parserClass::getMethods() in ParserElements.inc
getModifiers
parserClass::getModifiers() in ParserElements.inc
Get the PHP5+ modifiers for this class
getModifiers
parserVar::getModifiers() in ParserElements.inc
Return a list of access modifiers (static/private/etc.)
getModifiers
parserMethod::getModifiers() in ParserElements.inc
Return name of the class that contains this method
getName
parserElement::getName() in ParserElements.inc
getNext
parserTutorial::getNext() in ParserElements.inc
Retrieve converter-specific link to the next tutorial's documentation
getOverrides
parserVar::getOverrides() in ParserElements.inc
getOverrides
parserMethod::getOverrides() in ParserElements.inc
getOverridingMethods
getOverridingMethodsForClass
getOverridingVars
parserVar::getOverridingVars() in ParserElements.inc
getOverridingVarsForClass
getPackage
parserElement::getPackage() in ParserElements.inc
getParam
parserFunction::getParam() in ParserElements.inc
getParent
parserClass::getParent() in ParserElements.inc
retrieve object that represents the parent class
getParent
parserTutorial::getParent() in ParserElements.inc
Retrieve converter-specific link to the parent tutorial's documentation
getParentClassTree
parserClass::getParentClassTree() in ParserElements.inc
getPath
parserElement::getPath() in ParserElements.inc
getPrev
parserTutorial::getPrev() in ParserElements.inc
Retrieve converter-specific link to the previous tutorial's documentation
getReturnsReference
getSource
parserFunction::getSource() in ParserElements.inc
getSourceLocation
parserClass::getSourceLocation() in ParserElements.inc
getTitle
parserTutorial::getTitle() in ParserElements.inc
Retrieve the title of the tutorial, or of any subsection
getTutorial
parserClass::getTutorial() in ParserElements.inc
Get the associated tutorial for this class, if any
getVar
parserClass::getVar() in ParserElements.inc
getVarNames
parserClass::getVarNames() in ParserElements.inc
getVars
parserClass::getVars() in ParserElements.inc
getParserEventName
searches for a parser event name based on its number
getParserEventName
XMLPackagePageParser::getParserEventName() in XMLpackagePageParser.inc
debugging function
getParserEventName
getParserEventName
getParserEventName
Debugging function, takes an event number and attempts to return its name
getWord
Retrieve the next token
globalTagHandler
handles @global
getId
parserXMLDocBookTag::getId() in PackagePageElements.inc
Return converter-specific formatting of ID.
getSubsection
parserXMLDocBookTag::getSubsection() in PackagePageElements.inc
Retrieve the contents of a subsection
getTitle
parserXMLDocBookTag::getTitle() in PackagePageElements.inc
Retrieve Converter-specific formatting of the title of this element
getTOC
parserXMLDocBookTag::getTOC() in PackagePageElements.inc
Retrieve either the table of contents index, or the location that the TOC will go
getBlock
WordParser::getBlock() in WordParser.inc
Unused
getFileSource
phpDocumentorTWordParser::getFileSource() in phpDocumentorTWordParser.inc
gets the source code tokens
getPos
WordParser::getPos() in WordParser.inc
Returns the current pointer position, or 1 character after the end of the word
getSource
phpDocumentorTWordParser::getSource() in phpDocumentorTWordParser.inc
loads up next set of source code
getSource
WordParser::getSource() in WordParser.inc
Retrieve source code for the last function/method
getWord
WordParser::getWord() in WordParser.inc
Retrieve a token from the token list
getWord
phpDocumentorTWordParser::getWord() in phpDocumentorTWordParser.inc
Retrieve a token for the phpDocumentorTParser
getWord
ObjectWordParser::getWord() in ParserDescCleanup.inc
h
top
$hidden
contents of --hidden commandline
handleClass
handles post-parsing of classes
handleConst
handles post-parsing of class constants
handleDefine
handles post-parsing of defines
handleDocBlock
handles post-parsing of DocBlocks
HandleEvent
called via Parser::parse() and Parser's inherited method Publisher::publishEvent()
handleFunction
handles post-parsing of functions
handleGlobal
handles post-parsing of global variables
handleInclude
handles post-parsing of include/require/include_once/require_once
handleMethod
handles post-parsing of class methods
handlePackagePage
handles post-parsing of Package-level documentation pages.
handlePage
handles post-parsing of procedural pages
handleTutorial
handle post-parsing of Tutorials.
handleVar
handles post-parsing of class vars
htmlArraySelect
htmlArraySelect() in utilities.php
Returns a select box based on an key,value array where selected is based on key
HighlightParserTests.php
HighlightParserTests.php in HighlightParserTests.php
HandleEvent
parserTag::HandleEvent() in DocBlockTags.inc
Called by the parserDescParser when processing a description.
handleEvent
This function subscribes to two events in the Parser in order to keep track of line number information and file name.
hasClasses
parserData::hasClasses() in ParserData.inc
Does this package have classes?
hasExplicitDocBlock
If the page-level DocBlock was present in the source, returns true
hasInlineTag
Determine whether the string contains any inline tags
hasInterfaces
parserData::hasInterfaces() in ParserData.inc
Does this package have interfaces?
$hasaccess
parserDocBlock::$hasaccess in ParserDocBlock.inc
whether this DocBlock has an @access tag
$hasname
parserDocBlock::$hasname in ParserDocBlock.inc
whether this DocBlock has a @name tag
hasInheritDoc
parserDocBlock::hasInheritDoc() in ParserDocBlock.inc
hasInheritDoc
parserDesc::hasInheritDoc() in ParserDocBlock.inc
hasSource
parserDesc::hasSource() in ParserDocBlock.inc
hasConst
parserClass::hasConst() in ParserElements.inc
hasMethod
parserClass::hasMethod() in ParserElements.inc
hasSource
parserFunction::hasSource() in ParserElements.inc
Determine whether the source code has been requested via [email protected]}
hasVar
parserClass::hasVar() in ParserElements.inc
handleInlineDockeyword
handler for INLINE_DOCKEYWORD.
HighlightParser.inc
HighlightParser.inc in HighlightParser.inc
hasTitle
parserXMLDocBookTag::hasTitle() in PackagePageElements.inc
Determine whether the docbook element has a title
i
top
$ignore
Io::$ignore in Io.inc
Format: array(array(regexp-ready string to search for whole path,
$ignorepages
ProceduralPages::$ignorepages in ProceduralPages.inc
array of all procedural pages ordered by name
$ignoresymlinks
contents of --ignoresymlinks commandline
$ignore_files
contents of --ignore commandline
$includesbyfile
ProceduralPages::$includesbyfile in ProceduralPages.inc
array of parsed includes organized by the full path of the file that contains the include.
$interface
$interface in Setup.inc.php
$interface is either 'web' or is not set at all
ignorePage
ProceduralPages::ignorePage() in ProceduralPages.inc
moves a page from the $pages array to the $ignorepages array
Inherit
Classes::Inherit() in Classes.inc
Main processing engine for setting up class inheritance.
Io
Io::Io() in Io.inc
creates an array $this->phpDocOptions and sets program options in it.
Io
Io in Io.inc
Class to handle file and user io opperations
Ioinc_mystrucsort
Sorting functions for the file list
Ioinc_sortfiles
Sorting functions for the file list
isIncludeable
calls http://www.php.net/file_exists for each value in include_path,
IntermediateParser.inc
IntermediateParser.inc in IntermediateParser.inc
Io.inc
Io.inc in Io.inc
IntermediateParserTests.php
IntermediateParserTests.php in IntermediateParserTests.php
$items
parserList::$items in DescHTML.inc
$isvalid
parserAccessTag::$isvalid in DocBlockTags.inc
set to true if the returned tag has a value type of private, protected
$id
parserIdInlineTag::$id in InlineTags.inc
section/subsection name
$inlinetype
always 'source'
$inlinetype
always 'toc'
$inlinetype
the name of the inline tag (like link)
$inlinetype
always 'inheritdoc'
$inlinetype
always 'id'
InlineTags.inc
InlineTags.inc in InlineTags.inc
$id
parserPage::$id in ParserData.inc
not implemented in this version, will be used to link xml output pages
isClean
parserData::isClean() in ParserData.inc
checks if the element is "cleaned" already
$ignore
parserClass::$ignore in ParserElements.inc
Used to determine whether a class should be ignored or not. Helps maintain integrity of parsing
$ini
parserTutorial::$ini in ParserElements.inc
output from tutorialname.ext.ini
$isConstructor
parserMethod::$isConstructor in ParserElements.inc
$isDestructor
parserMethod::$isDestructor in ParserElements.inc
isChildOf
parserTutorial::isChildOf() in ParserElements.inc
Determine if this parserTutorial object is a child of another
isInterface
parserClass::isInterface() in ParserElements.inc
$inlineTagHandlers
phpDocumentorTParser::$inlineTagHandlers in phpDocumentorTParser.inc
incdataHandler
Handler for real character data
invalidTagHandler
Handles tags like [email protected]' that only work in PHP 4.3.0+
k
top
$keyword
parserStaticvarTag::$keyword in DocBlockTags.inc
always 'staticvar'
$keyword
parserSeeTag::$keyword in DocBlockTags.inc
always 'see'
$keyword
parserReturnTag::$keyword in DocBlockTags.inc
always 'return'
$keyword
parserTag::$keyword in DocBlockTags.inc
tag name (see, access, etc.)
$keyword
parserTutorialTag::$keyword in DocBlockTags.inc
Always "tutorial"
$keyword
parserVarTag::$keyword in DocBlockTags.inc
always 'var'
$keyword
parserUsesTag::$keyword in DocBlockTags.inc
Always "uses"
$keyword
parserUsedByTag::$keyword in DocBlockTags.inc
Always "usedby"
$keyword
always 'property-write'
$keyword
parserPropertyTag::$keyword in DocBlockTags.inc
always 'property'
$keyword
parserLicenseTag::$keyword in DocBlockTags.inc
always 'license'
$keyword
parserFileSourceTag::$keyword in DocBlockTags.inc
Always "filesource"
$keyword
parserExampleTag::$keyword in DocBlockTags.inc
always "example"
$keyword
parserLinkTag::$keyword in DocBlockTags.inc
always 'link'
$keyword
parserMethodTag::$keyword in DocBlockTags.inc
always 'method'
$keyword
always 'property-read'
$keyword
parserParamTag::$keyword in DocBlockTags.inc
always 'param'
$keyword
parserNameTag::$keyword in DocBlockTags.inc
tag name
$keyword
parserAccessTag::$keyword in DocBlockTags.inc
tag name
l
top
$last
phpDocumentor_IntermediateParser::$last in IntermediateParser.inc
$lasttype
type of the last parser Element handled
$lasterror
index in $errors of last error triggered
$lastwarning
index in $warnings of last warning triggered
$linenum
line number of the file this error occurred in
$linenum
$linktext
text to display in the link, can be different from the link for standard
LinkClasses.inc
LinkClasses.inc in LinkClasses.inc
$links
parserData::$links in ParserData.inc
array of links descended from abstractLink
$linenumber
parserDocBlock::$linenumber in ParserDocBlock.inc
Line number in the source on which this docblock begins
listParams
parserDocBlock::listParams() in ParserDocBlock.inc
listProperties
parserDocBlock::listProperties() in ParserDocBlock.inc
listTags
parserDocBlock::listTags() in ParserDocBlock.inc
$linenumber
parserElement::$linenumber in ParserElements.inc
Line number in the source on which this element appears
$linked_element
parserTutorial::$linked_element in ParserElements.inc
The documentable element this tutorial is linked to
listGlobals
parserFunction::listGlobals() in ParserElements.inc
listParams
parserFunction::listParams() in ParserElements.inc
listStatics
parserFunction::listStatics() in ParserElements.inc
m
top
main
tests_phpDocumentorSetupTests::main() in phpDocumentorSetupTests.php
main
tests_phpDocumentorTParserTests::main() in phpDocumentorTParserTests.php
main
tests_ParserPageTests::main() in ParserPageTests.php
main
tests_ParserClassTests::main() in ParserClassTests.php
main
tests_IntermediateParserTests::main() in IntermediateParserTests.php
main
tests_HighlightParserTests::main() in HighlightParserTests.php
methodLink
methodLink in LinkClasses.inc
method link
$modDate
parserPage::$modDate in ParserData.inc
not implemented yet
n
top
$num
EventStack::$num in EventStack.inc
The number of events in the stack
new_phpdoc.php
new_phpdoc.php in new_phpdoc.php
nextFile
Classes::nextFile() in Classes.inc
Prepare to parse a new file
$numbered
parserList::$numbered in DescHTML.inc
$num
RecordWarning::$num in Errors.inc
error number
$name
abstractLink::$name in LinkClasses.inc
$name
parserPage::$name in ParserData.inc
phpdoc-safe name (only letters, numbers and _)
$name
parserElement::$name in ParserElements.inc
name of this element, or include type if element is a parserInclude
$name
parserTutorial::$name in ParserElements.inc
filename minus extension of this tutorial (used for @tutorial tag)
$next
parserTutorial::$next in ParserElements.inc
link to the next tutorial in a document series, or false if none
newLineNum
wraps the current line (via the converter) and resets it to empty
newLineNum
advances output to a new line
nextToken
Retrieve the position of the next token that will be parsed in the internal token array
$name
parserXMLDocBookTag::$name in PackagePageElements.inc
Name of the tag
nextIsObjectOrNonNL
Determine if the next word is an inline tag
o
top
Output
call this method once parsing has completed.
output
prints the warning
output
RecordError::output() in Errors.inc
prints the error
$origName
parserPage::$origName in ParserData.inc
original phpdoc-safe name (only letters, numbers and _)
overridePackage
parserDocBlock::overridePackage() in ParserDocBlock.inc
set the element's package to the passed values. Used in phpDocumentor_IntermediateParser to align package of
ObjectWordParser
ObjectWordParser::ObjectWordParser() in ParserDescCleanup.inc
ObjectWordParser
ObjectWordParser in ParserDescCleanup.inc
Like WordParser but designed to handle an array with strings and
p
top
$packagecategories
Used to determine the category for tutorials.
$packageoutput
array of packages to parser and output documentation for, if not all packages should be documented
$packages
Packages to create documentation for
$package_pages
array of parsed package pages
$package_parents
Keeps track of packages of classes that have parent classes in another package. Used in automatic linking.
$pageclasspackages
array of packages assigned to classes in a file, ordered by fullpath
$pageconflicts
ProceduralPages::$pageconflicts in ProceduralPages.inc
Namespace conflicts within all documented pages
$pagepackages
ProceduralPages::$pagepackages in ProceduralPages.inc
array of packages ordered by full path
$pages
ProceduralPages::$pages in ProceduralPages.inc
array of all procedural pages ordered by name
$pages
$parse
The main parser
$parsePrivate
set in Setup.inc.php to the value of the parseprivate commandline
$pathpages
ProceduralPages::$pathpages in ProceduralPages.inc
array of all procedural page names ordered by full path to the file
$phpDocOptions
Holds all the options that are avaible to the cmd line interface
$phpDocumentor_DefaultCategoryName
default package name, set using -dn --defaultcategoryname
$phpDocumentor_DefaultPackageName
default package name, set using -dn --defaultpackagename
$popEvent
Publisher::$popEvent in Publisher.inc
$privatepages
Put away a page that has been @ignored or @access private if !$parsePrivate
$private_class
this variable is used to prevent parsing of elements with an @ignore tag
$proceduralpages
used to keep track of all elements in a procedural page. Handles name
$pushEvent
Publisher::$pushEvent in Publisher.inc
parseArgv
Io::parseArgv() in Io.inc
Parses $_SERVER['argv'] and creates a setup array
parseHiddenFiles
parseIni
Parse configuration file phpDocumentor.ini
parsePackagePage
Backward-compatibility only, use the new tutorials for more power
pathMatchesParsedFile
checks to see if the parsed file matches the given path
PATH_DELIMITER
PATH_DELIMITER in common.inc.php
phpdoc.php
phpdoc.php in phpdoc.php
ParserDescCleanup.inc
ParserDescCleanup.inc in ParserDescCleanup.inc
phpdoc.inc
phpdoc.inc in phpdoc.inc
ProceduralPages.inc
ProceduralPages.inc in ProceduralPages.inc
Publisher.inc
Publisher.inc in Publisher.inc
phpDocumentor_clone
phpDocumentor_clone() in clone.inc.php
Clone an object in PHP 4
phpDocumentor_ConfigFileList
used in phpdoc.php and new_phpdoc.php
phpDocumentor_get_class
phpDocumentor_get_class() in common.inc.php
Returns a lower-cased version of get_class for PHP 5
phpDocumentor_IntermediateParser
phpDocumentor_IntermediateParser in IntermediateParser.inc
The phpDocumentor_IntermediateParser Class
phpDocumentor_IntermediateParser
sets up basic data structures
phpDocumentor_out
phpDocumentor_out() in Setup.inc.php
Print parse information if quiet setting is off
phpDocumentor_parse_ini_file
Parse an .ini file
PHPDOCUMENTOR_PDP_EVENT_B
PHPDOCUMENTOR_PDP_EVENT_B in ParserDescCleanup.inc
when <b> is found in a desc
PHPDOCUMENTOR_PDP_EVENT_BR
PHPDOCUMENTOR_PDP_EVENT_BR in ParserDescCleanup.inc
when <br> is found in a desc
PHPDOCUMENTOR_PDP_EVENT_CODE
PHPDOCUMENTOR_PDP_EVENT_CODE in ParserDescCleanup.inc
when <code> is found in a desc
PHPDOCUMENTOR_PDP_EVENT_DOUBLECR
PHPDOCUMENTOR_PDP_EVENT_DOUBLECR in ParserDescCleanup.inc
when \n\n is found in a desc
PHPDOCUMENTOR_PDP_EVENT_ESCAPE
PHPDOCUMENTOR_PDP_EVENT_ESCAPE in ParserDescCleanup.inc
when the << potential escape for tags is found in a desc
PHPDOCUMENTOR_PDP_EVENT_ESCAPE_CODE
PHPDOCUMENTOR_PDP_EVENT_ESCAPE_CODE in ParserDescCleanup.inc
when << /code>> is found in a <code></code> section
PHPDOCUMENTOR_PDP_EVENT_ESCAPE_PRE
PHPDOCUMENTOR_PDP_EVENT_ESCAPE_PRE in ParserDescCleanup.inc
when << /pre>> is found in a <pre></pre> section
PHPDOCUMENTOR_PDP_EVENT_I
PHPDOCUMENTOR_PDP_EVENT_I in ParserDescCleanup.inc
when <i> is found in a desc
PHPDOCUMENTOR_PDP_EVENT_KBD
PHPDOCUMENTOR_PDP_EVENT_KBD in ParserDescCleanup.inc
when <kbd> is found in a desc
PHPDOCUMENTOR_PDP_EVENT_LIST
PHPDOCUMENTOR_PDP_EVENT_LIST in ParserDescCleanup.inc
when <ul>/<ol> is found in a desc
PHPDOCUMENTOR_PDP_EVENT_P
PHPDOCUMENTOR_PDP_EVENT_P in ParserDescCleanup.inc
when <p> is found in a desc
PHPDOCUMENTOR_PDP_EVENT_PRE
PHPDOCUMENTOR_PDP_EVENT_PRE in ParserDescCleanup.inc
when <pre> is found in a desc
PHPDOCUMENTOR_PDP_EVENT_SAMP
PHPDOCUMENTOR_PDP_EVENT_SAMP in ParserDescCleanup.inc
when <samp> is found in a desc
PHPDOCUMENTOR_PDP_EVENT_SIMLIST
PHPDOCUMENTOR_PDP_EVENT_SIMLIST in ParserDescCleanup.inc
when a simple list is found in a desc
PHPDOCUMENTOR_PDP_EVENT_VAR
PHPDOCUMENTOR_PDP_EVENT_VAR in ParserDescCleanup.inc
when <var> is found in a desc
PHPDOCUMENTOR_PDP_STATE_B
PHPDOCUMENTOR_PDP_STATE_B in ParserDescCleanup.inc
when <b> is found in a desc
PHPDOCUMENTOR_PDP_STATE_BR
PHPDOCUMENTOR_PDP_STATE_BR in ParserDescCleanup.inc
when <br> is found in a desc
PHPDOCUMENTOR_PDP_STATE_CODE
PHPDOCUMENTOR_PDP_STATE_CODE in ParserDescCleanup.inc
when <code> is found in a desc
PHPDOCUMENTOR_PDP_STATE_DOUBLECR
PHPDOCUMENTOR_PDP_STATE_DOUBLECR in ParserDescCleanup.inc
when \n\n is found in a desc
PHPDOCUMENTOR_PDP_STATE_ESCAPE
PHPDOCUMENTOR_PDP_STATE_ESCAPE in ParserDescCleanup.inc
when the << potential escape for tags is found in a desc
PHPDOCUMENTOR_PDP_STATE_ESCAPE_CODE
PHPDOCUMENTOR_PDP_STATE_ESCAPE_CODE in ParserDescCleanup.inc
when << /code>> is found in a <code></code> section
PHPDOCUMENTOR_PDP_STATE_ESCAPE_PRE
PHPDOCUMENTOR_PDP_STATE_ESCAPE_PRE in ParserDescCleanup.inc
when << /pre>> is found in a <pre></pre> section
PHPDOCUMENTOR_PDP_STATE_I
PHPDOCUMENTOR_PDP_STATE_I in ParserDescCleanup.inc
when <i> is found in a desc
PHPDOCUMENTOR_PDP_STATE_KBD
PHPDOCUMENTOR_PDP_STATE_KBD in ParserDescCleanup.inc
when <kbd> is found in a desc
PHPDOCUMENTOR_PDP_STATE_LIST
PHPDOCUMENTOR_PDP_STATE_LIST in ParserDescCleanup.inc
when <ul>/<ol> is found in a desc
PHPDOCUMENTOR_PDP_STATE_P
PHPDOCUMENTOR_PDP_STATE_P in ParserDescCleanup.inc
when <p> is found in a desc
PHPDOCUMENTOR_PDP_STATE_PRE
PHPDOCUMENTOR_PDP_STATE_PRE in ParserDescCleanup.inc
when <pre> is found in a desc
PHPDOCUMENTOR_PDP_STATE_SAMP
PHPDOCUMENTOR_PDP_STATE_SAMP in ParserDescCleanup.inc
when <samp> is found in a desc
PHPDOCUMENTOR_PDP_STATE_SIMLIST
PHPDOCUMENTOR_PDP_STATE_SIMLIST in ParserDescCleanup.inc
when a simple list is found in a desc
PHPDOCUMENTOR_PDP_STATE_VAR
PHPDOCUMENTOR_PDP_STATE_VAR in ParserDescCleanup.inc
when <var> is found in a desc
phpDocumentor_setup
phpDocumentor_setup in Setup.inc.php
phpDocumentor_setup
Checks PHP version, makes sure it is 4.2.0+, and chooses the
PHPDOCUMENTOR_VER
PHPDOCUMENTOR_VER in common.inc.php
PHPDOCUMENTOR_WEBSITE
PHPDOCUMENTOR_WEBSITE in common.inc.php
PHPDOCUMENTOR_WINDOWS
PHPDOCUMENTOR_WINDOWS in common.inc.php
PHPDOC_WEBROOT_DIR
PHPDOC_WEBROOT_DIR in file_dialog.php
PHPUnit_MAIN_METHOD
PHPUnit_MAIN_METHOD in IntermediateParserTests.php
popEvent
EventStack::popEvent() in EventStack.inc
Pop an event from the stack
ProceduralPages
ProceduralPages in ProceduralPages.inc
Intermediate procedural page parsing structure.
processChild
This function recursively climbs up the class tree, setting inherited information like package and adds the elements to phpDocumentor_IntermediateParser.
Publisher
Publisher in Publisher.inc
a class for handling the publishing of data
publishEvent
Publisher::publishEvent() in Publisher.inc
Publish an event
pushEvent
EventStack::pushEvent() in EventStack.inc
Push an event onto the stack
ParserClassTests.php
ParserClassTests.php in ParserClassTests.php
ParserPageTests.php
ParserPageTests.php in ParserPageTests.php
phpDocumentorSetupTests.php
phpDocumentorSetupTests.php in phpDocumentorSetupTests.php
phpDocumentorTParserTests.php
phpDocumentorTParserTests.php in phpDocumentorTParserTests.php
parserB
parserB in DescHTML.inc
Used for <b> in a description
parserBr
parserBr in DescHTML.inc
Used for <br> in a description
parserCode
parserCode in DescHTML.inc
Used for <code> in a description
parserDescVar
parserDescVar in DescHTML.inc
Used for <var> in a description
parserI
parserI in DescHTML.inc
Used for <i> in a description
parserKbd
parserKbd in DescHTML.inc
Used for <kbd> in a description
parserList
parserList::parserList() in DescHTML.inc
Constructor - create a new list
parserList
parserList in DescHTML.inc
Used for lists <ol> and <ul>
parserPre
parserPre in DescHTML.inc
Used for <pre> in a description
parserSamp
parserSamp in DescHTML.inc
Used for <samp> in a description
$path
parserFileSourceTag::$path in DocBlockTags.inc
parserAccessTag
parserAccessTag in DocBlockTags.inc
This class represents the @access tag
parserAccessTag
checks $value to make sure it is private, protected or public, otherwise it's not a valid @access tag
parserExampleTag
Reads and parses the example file indicated
parserExampleTag
parserExampleTag in DocBlockTags.inc
represents "@example"
parserFileSourceTag
Set $source to $value, and set up path
parserFileSourceTag
parserFileSourceTag in DocBlockTags.inc
represents "@filesource"
parserLicenseTag
set up the license tag
parserLicenseTag
parserLicenseTag in DocBlockTags.inc
represents the "@see" tag
parserLinkTag
parserLinkTag::parserLinkTag() in DocBlockTags.inc
sets up the link tag
parserLinkTag
parserLinkTag in DocBlockTags.inc
represents the "@link" tag
parserMethodTag
parserMethodTag in DocBlockTags.inc
represents the "@method" tag
parserNameTag
parserNameTag in DocBlockTags.inc
This class represents the @name tag
parserNameTag
parserNameTag::parserNameTag() in DocBlockTags.inc
set up the name tag
parserParamTag
parserParamTag in DocBlockTags.inc
represents the "@param" tag
parserPropertyReadTag
parserPropertyReadTag in DocBlockTags.inc
represents the "@property-read" tag
parserPropertyTag
parserPropertyTag in DocBlockTags.inc
represents the "@property" tag
parserPropertyTag
set up the property tag
parserPropertyWriteTag
parserPropertyWriteTag in DocBlockTags.inc
represents the "@property-write" tag
parserReturnTag
set up the tag
parserReturnTag
parserReturnTag in DocBlockTags.inc
represents the "@return" tag
parserSeeTag
parserSeeTag::parserSeeTag() in DocBlockTags.inc
sets up the see tag
parserSeeTag
parserSeeTag in DocBlockTags.inc
represents the "@see" tag
parserStaticvarTag
parserStaticvarTag in DocBlockTags.inc
represents the "@staticvar" tag
parserTag
parserTag in DocBlockTags.inc
used to represent standard tags like @access, etc.
parserTag
parserTag::parserTag() in DocBlockTags.inc
Set up the tag
parserTutorialTag
parserTutorialTag in DocBlockTags.inc
represents "@tutorial"
parserUsedByTag
set up the usedby tag
parserUsedByTag
parserUsedByTag in DocBlockTags.inc
This is a virtual tag, it is created by @uses to cross-reference the used element
parserUsesTag
parserUsesTag in DocBlockTags.inc
represents the "@uses" tag
parserUsesTag
parserUsesTag::parserUsesTag() in DocBlockTags.inc
set up the uses tag
parserVarTag
parserVarTag in DocBlockTags.inc
represents the "@var" tag
$phpDocumentor_errors
$phpDocumentor_errors in Errors.inc
$phpDocumentor_error_descrip
Error messages for phpDocumentor parser errors
$phpDocumentor_warning_descrip
Error messages for phpDocumentor parser warnings
PDERROR_ACCESS_WRONG_PARAM
warning triggered when the arguments to @access are neither public nor private
PDERROR_BEAUTIFYING_FAILED
warning triggered by an unterminated entity in a tutorial
PDERROR_CANNOT_EXTEND_SELF
warning triggered if someone brilliant tries "class X extends X {"
PDERROR_CANT_HAVE_INLINE_IN_TAGNAME
warning triggered when an inline tag is found inside an xml tag name
PDERROR_CANT_NEST_IN_B
warning triggered when another tag is nested in &lt;b&gt;
PDERROR_CHILD_TUTORIAL_NOT_FOUND
warning triggered when a tutorial's child in the .ini file doesn't exist in the
PDERROR_CLASS_CONFLICT
warning triggered when classes in the same package have the same name
PDERROR_CLASS_EXISTS
PDERROR_CLASS_EXISTS in Errors.inc
warning triggered when inheritance could be from more than one class
PDERROR_CLASS_NOT_IN_PACKAGE
warning triggered when a getClassByPackage is called and can't find the class
PDERROR_CLASS_PARENT_NOT_FOUND
warning triggered when an entire page is ignored because of @access private
PDERROR_CONVERTER_NOT_FOUND
warning triggered when a converter is passed to
PDERROR_CONVERTER_OVR_GFCT
warning triggered when a child converter doesn't override
PDERROR_DANGEROUS_PHP_BUG_EXISTS
warning triggered when the PHP version being used has dangerous bug/behavior
PDERROR_DB_TEMPLATE_UNTERMINATED
warning triggered when a docblock template is never turned off
PDERROR_DOCBLOCK_CONFLICT
warning triggered by a page-level docblock preceding a source element
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
PDERROR_DUMB_USES in Errors.inc
warning triggered by improper "@uses blah"
PDERROR_ELEMENT_IGNORED
warning triggered when a duplicate element is encountered that will be
PDERROR_EMPTY_EXAMPLE_TITLE
warning triggered by @example path/to/example with no title
PDERROR_EXAMPLE_NOT_FOUND
warning triggered when an example's path from @example /path/to/example.php
PDERROR_FUNCTION_HAS_NONAME
warning triggered by a function with no name
PDERROR_GLOBAL_NOT_FOUND
warning triggered when there are multiple @name tags in a docblock
PDERROR_ID_MUST_BE_INLINE
warning triggered when an id attribute in a tutorial docbook tag is not
PDERROR_IGNORE_TAG_IGNORED
warning triggered when an @ignore tag is used in a DocBlock preceding
PDERROR_ILLEGAL_PACKAGENAME
warning triggered when the package or subpackage name is illegal
PDERROR_INHERITANCE_CONFLICT
warning triggered when inheritance could be from more than one class
PDERROR_INHERITDOC_DONT_WORK_HERE
warning triggered by [email protected]} in a non-inheritable situation
PDERROR_INLINETAG_IN_SEE
warning triggered when an example's path from @example /path/to/example.php
PDERROR_INTERNAL_NOT_CLOSED
warning triggered when an [email protected]}} tag is not closed
PDERROR_INVALID_VALUES
warning triggered if a command line option does not have a valid value passed in
PDERROR_LOOP_RECURSION_LIMIT_REACHED
warning triggered when the a loop recursion tripwire has been tripped
PDERROR_MALFORMED_GLOBAL_TAG
warning triggered when there are multiple @name tags in a docblock
PDERROR_MALFORMED_TAG
PDERROR_MALFORMED_TAG in Errors.inc
warning triggered by an empty tag
PDERROR_MISSING_PROPERTY_TAG_NAME
warning triggered when any of [email protected]}}, [email protected]}},
PDERROR_MULTIPLE_ACCESS_TAGS
warning triggered when there are multiple @access tags in a docblock
PDERROR_MULTIPLE_CATEGORY_TAGS
warning triggered by more than 1 @category tag
PDERROR_MULTIPLE_GLOBAL_TAGS
warning triggered when there are multiple @name tags in a docblock
PDERROR_MULTIPLE_NAME_TAGS
warning triggered when there are multiple @name tags in a docblock
PDERROR_MULTIPLE_PACKAGE_TAGS
warning triggered when there are multiple @package tags in a docblock
PDERROR_MULTIPLE_PARENT
warning triggered when inheritance could be from more than one class
PDERROR_MULTIPLE_RETURN_TAGS
warning triggered when there are multiple @return tags in a docblock
PDERROR_MULTIPLE_SUBPACKAGE_TAGS
warning triggered when there are multiple @subpackage tags in a docblock
PDERROR_MULTIPLE_VAR_TAGS
warning triggered when there are multiple @var tags in a docblock
PDERROR_NAME_ALIAS_SAME_AS_TARGET
warning triggered when the alias value in an page-level docblock's @name tag
PDERROR_NEED_WHITESPACE
warning triggered when an entire page is ignored because of @access private
PDERROR_NESTED_INTERNAL
warning triggered when [email protected]}} is nested inside another [email protected]}}
PDERROR_NOTODO_INCLUDE
warning triggered when @todo is used on an include element
PDERROR_NO_CONVERTERS
PDERROR_NO_CONVERTERS in Errors.inc
warning triggered when a converter is passed to
PDERROR_NO_CONVERTER_HANDLER
warning triggered when an example's path from @example /path/to/example.php
PDERROR_NO_DOCBOOK_ID
PDERROR_NO_DOCBOOK_ID in Errors.inc
warning triggered in tutorial parsing if there is a missing [email protected]} inline tag
PDERROR_NO_PACKAGE_TAG
warning triggered when no @package tag is used in a page-level
PDERROR_NO_PAGE_LEVELDOCBLOCK
warning triggered when a file does not contain a page-level docblock
PDERROR_OVERRIDDEN_PACKAGE_TAGS
warning triggered when there a @package tag is used in a function,
PDERROR_OVERRIDDEN_SUBPACKAGE_TAGS
warning triggered when there a @subpackage tag is used in a function,
PDERROR_PACKAGECAT_SET
warning triggered when a package is already associated with a category, and
PDERROR_PACKAGEOUTPUT_DELETES_PARENT_FILE
warning triggered when there are multiple @name tags in a docblock
PDERROR_PARENT_NOT_FOUND
warning triggered when parent class doesn't exist
PDERROR_PARSEPRIVATE
PDERROR_PARSEPRIVATE in Errors.inc
warning triggered when an entire page is ignored because of @access private
PDERROR_PDFFUNCTION_NO_FUNC
warning triggered when a <pdffunction:funcname /> tag is used in the PDF
PDERROR_PDF_METHOD_DOESNT_EXIST
warning triggered when a <pdffunction:funcname /> tag is used in the PDF
PDERROR_PDF_TEMPVAR_DOESNT_EXIST
warning triggered when a <pdffunction:funcname arg=$tempvar/> tag
PDERROR_PRIVATE_ASSUMED
warning triggered when no @access private tag is used in a
PDERROR_SOURCECODE_IGNORED
warning triggered by sourcecode="on", if PHP < 4.3.0
PDERROR_SOURCE_TAG_FUNCTION_NOT_FOUND
warning triggered when a { @source } inline tag is used in a docblock not
PDERROR_SOURCE_TAG_IGNORED
warning triggered when an [email protected]} tag is found in a short description
PDERROR_TAG_NOT_HANDLED
warning triggered by @filesource, if PHP < 4.3.0
PDERROR_TEMPLATEDIR_DOESNT_EXIST
warning triggered by non-existent template directory
PDERROR_TEXT_OUTSIDE_LI
warning triggered when text in a docblock list is not contained in
PDERROR_TUTORIAL_IS_OWN_CHILD
warning triggered when a tutorial lists itself as a child tutorial
PDERROR_TUTORIAL_IS_OWN_GRANDPA
warning triggered when a tutorial's child lists the parent tutorial
PDERROR_TUTORIAL_NOT_FOUND
warning triggered when a tutorial is referenced
PDERROR_TUTORIAL_SUBSECTION_NOT_FOUND
warning triggered when a subsection's title is asked for, but the subsection
PDERROR_UL_IN_UL
PDERROR_UL_IN_UL in Errors.inc
warning triggered if <ul> is nested inside <ul> and not <li>
PDERROR_UNCLOSED_TAG
PDERROR_UNCLOSED_TAG in Errors.inc
warning triggered when a DocBlock html tag is unclosed
PDERROR_UNDOCUMENTED_ELEMENT
warning triggered when a class or method hasn't got docblock
PDERROR_UNKNOWN_COMMANDLINE
warning triggered when an entire page is ignored because of @access private
PDERROR_UNKNOWN_TAG
PDERROR_UNKNOWN_TAG in Errors.inc
warning triggered when classes in the same package have the same name
PDERROR_UNMATCHED_LIST_TAG
warning triggered when a docblock has an unmatched &lt;ol&gt; or &lt;ul&gt;
PDERROR_UNMATCHED_TUTORIAL_TAG
warning triggered when a docbook tag is not properly matched
PDERROR_UNTERMINATED_ATTRIB
warning triggered when a subsection's title is asked for, but the subsection
PDERROR_UNTERMINATED_ENTITY
warning triggered by an unterminated entity in a tutorial
PDERROR_UNTERMINATED_INLINE_TAG
warning triggered when an [email protected] tag} is not terminated
$package
parserIdInlineTag::$package in InlineTags.inc
package of the [email protected]}
parserExampleInlineTag
constructor
parserExampleInlineTag
parserExampleInlineTag in InlineTags.inc
Represents the example inline tag, used to display an example file inside a docblock or tutorial
parserIdInlineTag
parserIdInlineTag in InlineTags.inc
Represents the inline [email protected]} tag for tutorials
parserIdInlineTag
constructor
parserInheritdocInlineTag
Does nothing, overrides parent constructor
parserInheritdocInlineTag
parserInheritdocInlineTag in InlineTags.inc
Represents the inheritdoc inline tag, used by classes/methods/vars to inherit documentation from the parent class if possible
parserInlineTag
sets up the tag
parserInlineTag
parserInlineTag in InlineTags.inc
Use this element to represent an [email protected] tag} like [email protected]}
parserLinkInlineTag
sets up the tag
parserLinkInlineTag
parserLinkInlineTag in InlineTags.inc
represents inline links
parserSourceInlineTag
constructor
parserSourceInlineTag
parserSourceInlineTag in InlineTags.inc
represents inline source tag, used for function/method source
parserTocInlineTag
constructor
parserTocInlineTag
parserTocInlineTag in InlineTags.inc
Represents [email protected]} for table of contents generation in tutorials
parserTutorialInlineTag
constructor
parserTutorialInlineTag
parserTutorialInlineTag in InlineTags.inc
Represents inline links to external tutorial documentation
$package
abstractLink::$package in LinkClasses.inc
$path
abstractLink::$path in LinkClasses.inc
pageLink
pageLink in LinkClasses.inc
procedural page link
$package
parserPage::$package in ParserData.inc
$packageOutput
parserPage::$packageOutput in ParserData.inc
Used to limit output, contains contents of --packageoutput commandline.
$parent
parserData::$parent in ParserData.inc
parserPage element that is this parserData's parent, or false if not set.
$parserVersion
parserPage::$parserVersion in ParserData.inc
$path
parserPage::$path in ParserData.inc
$privateclasselements
array of parsed class elements with @access private
$privateelements
array of parsed elements with @access private
parserBase
parserBase in ParserData.inc
Base class for all elements
parserData
parserData in ParserData.inc
Contains an in-memory representation of all documentable elements (parserPage, parserFunction, parserDefine, parserInclude, parserClass, parserMethod, parserVar) and their DocBlocks (parserDocBlock).
parserPage
parserPage::parserPage() in ParserData.inc
sets package to default package
parserPage
parserPage in ParserData.inc
Contains information about a PHP file, used to group procedural elements together.
parserStringWithInlineTags
parserStringWithInlineTags in ParserData.inc
Used to represent strings that contain inline tags, so that they can be properly parsed at link time
ParserData.inc
ParserData.inc in ParserData.inc
$package
parserDocBlock::$package in ParserDocBlock.inc
$packagedescrip
parserDocBlock::$packagedescrip in ParserDocBlock.inc
description of package parsed from @package tag
$params
parserDocBlock::$params in ParserDocBlock.inc
array of param data.
$processed_desc
parserDocBlock::$processed_desc in ParserDocBlock.inc
$processed_sdesc
parserDocBlock::$processed_sdesc in ParserDocBlock.inc
$properties
parserDocBlock::$properties in ParserDocBlock.inc
parserDesc
parserDesc in ParserDocBlock.inc
represents a short or long description in a DocBlock (parserDocBlock)
parserDocBlock
parserDocBlock::parserDocBlock() in ParserDocBlock.inc
sets package to default
parserDocBlock
parserDocBlock in ParserDocBlock.inc
Represents a docblock and its components, $desc, $sdesc, $tags, and also $params for functions
ParserDocBlock.inc
ParserDocBlock.inc in ParserDocBlock.inc
postProcess
parserDocBlock::postProcess() in ParserDocBlock.inc
Parse out any html tags from doc comments, and make them into
$package
parserTutorial::$package in ParserElements.inc
$package
parserPackagePage::$package in ParserElements.inc
$params
parserFunction::$params in ParserElements.inc
parameters parsed from function definition.
$parent
parserClass::$parent in ParserElements.inc
Format: array(file, parent) where parent class is found or false if no parent
$parent
parserTutorial::$parent in ParserElements.inc
link to the parent tutorial in a document series, or false if none
$path
parserTutorial::$path in ParserElements.inc
path to the tutorial page
$path
parserElement::$path in ParserElements.inc
full path location of this element (filename)
$prev
parserTutorial::$prev in ParserElements.inc
link to the previous tutorial in a document series, or false if none
parserClass
parserClass in ParserElements.inc
parserConst
parserConst::parserConst() in ParserElements.inc
parserConst
parserConst in ParserElements.inc
parserDefine
parserDefine in ParserElements.inc
parserElement
parserElement in ParserElements.inc
all elements except parserPackagePage descend from this abstract class
parserFunction
parserFunction in ParserElements.inc
parserGlobal
parserGlobal in ParserElements.inc
parserInclude
parserInclude in ParserElements.inc
parserMethod
parserMethod in ParserElements.inc
parserMethod
parserMethod::parserMethod() in ParserElements.inc
parserPackagePage
parserPackagePage
parserPackagePage in ParserElements.inc
parserTutorial
parserTutorial::parserTutorial() in ParserElements.inc
parserTutorial
parserTutorial in ParserElements.inc
parserVar
parserVar in ParserElements.inc
parserVar
parserVar::parserVar() in ParserElements.inc
ParserElements.inc
ParserElements.inc in ParserElements.inc
$package
ppageParser::$package in Parser.inc
$pars
XMLPackagePageParser::$pars in XMLpackagePageParser.inc
packageTagHandler
handles @package
paramTagHandler
handles @param
parse
phpDocumentorTParser::parse() in phpDocumentorTParser.inc
Parse a new file
parse
ppageParser::parse() in Parser.inc
Parse a new file
parse
parserDescParser::parse() in ParserDescCleanup.inc
Parse a long or short description for tags
parse
Parser::parse() in Parser.inc
Parse a new file
parse
XMLPackagePageParser::parse() in XMLpackagePageParser.inc
Parse a new file
parse
Parse a new file
parse
phpDocumentor_TutorialHighlightParser::parse() in TutorialHighlightParser.inc
Parse a new file
Parser
Parser::Parser() in Parser.inc
Set up invariant parsing variables
Parser
Parser in Parser.inc
PHP Parser for PHP 4.2.3-
parserDescParser
parserDescParser in ParserDescCleanup.inc
Parses a DocBlock description to retrieve abstract representations of
parserDescParser
parserDescParser::parserDescParser() in ParserDescCleanup.inc
sets $wp to be a ObjectWordParser
PARSER_EVENT_ACCESS_MODIFIER
used when parsing an access modifier
PARSER_EVENT_ARRAY
PARSER_EVENT_ARRAY in Parser.inc
used when an array definition is encountered in parsing
PARSER_EVENT_CLASS
PARSER_EVENT_CLASS in Parser.inc
used when a class definition is encountered in parsing
PARSER_EVENT_CLASS_CONSTANT
used when a class implements interfaces
PARSER_EVENT_CLASS_MEMBER
used by the HighlightParser only, when ->var or ->function() is encountered in a method
PARSER_EVENT_COMMENT
PARSER_EVENT_COMMENT in Parser.inc
used when short comment // is encountered in parsing
PARSER_EVENT_COMMENTBLOCK
used when long comment /x x/ where x is an asterisk is encountered in parsing
PARSER_EVENT_DEFINE
PARSER_EVENT_DEFINE in Parser.inc
used when a define statement is encountered in parsing
PARSER_EVENT_DEFINE_GLOBAL
used when parsing a global variable declaration
PARSER_EVENT_DEFINE_PARAMS
used when a define statement opening parenthesis is encountered in parsing
PARSER_EVENT_DEFINE_PARAMS_PARENTHESIS
used when a define statement's opening parenthesis is encountered in parsing
PARSER_EVENT_DESC
PARSER_EVENT_DESC in Parser.inc
used when parsing the desc part of a docblock
PARSER_EVENT_DOCBLOCK
PARSER_EVENT_DOCBLOCK in Parser.inc
used when a DocBlock is encountered in parsing
PARSER_EVENT_DOCBLOCK_TEMPLATE
used when encountering a /**#@+ comment marking a new docblock template
PARSER_EVENT_DOCKEYWORD
used when a @tag is encountered in DocBlock parsing
PARSER_EVENT_DOCKEYWORD_EMAIL
used when a <[email protected]> is encountered in parsing an @author tag
PARSER_EVENT_END_DOCBLOCK_TEMPLATE
used when encountering a /**#@-* / comment (no space) marking the end of using a docblock template
PARSER_EVENT_END_STATEMENT
PARSER_EVENT_EOFQUOTE
PARSER_EVENT_EOFQUOTE in Parser.inc
used when a <<< is encountered in parsing
PARSER_EVENT_ESCAPE
PARSER_EVENT_ESCAPE in Parser.inc
used when a backslash is encountered in parsing a string or other escapable entity
PARSER_EVENT_FUNCTION
PARSER_EVENT_FUNCTION in Parser.inc
used when a function definition is encountered in parsing
PARSER_EVENT_FUNCTION_PARAMS
used when a function statement opening parenthesis is encountered in parsing
PARSER_EVENT_FUNCTION_PARAM_VAR
used when a $param is encountered in a function definition
PARSER_EVENT_FUNC_GLOBAL
used when parsing a "global $var1, $var2;" declaration in a function
PARSER_EVENT_GLOBAL_VALUE
used when parsing the default value in a global variable declaration
PARSER_EVENT_IMPLEMENTS
used when a class implements interfaces
PARSER_EVENT_INCLUDE
PARSER_EVENT_INCLUDE in Parser.inc
used when an include/require/include_once/include_once statement is encountered in parsing
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
used when an inner ( ) is encountered while parsing an include/require/include_once/include_once statement
PARSER_EVENT_INLINE_DOCKEYWORD
used when an inline [email protected]} is encountered in parsing a DocBlock
PARSER_EVENT_LOGICBLOCK
{ encountered in parsing a function or php code
PARSER_EVENT_METHOD
PARSER_EVENT_METHOD in Parser.inc
used by the HighlightParser only, when a method starts
PARSER_EVENT_METHOD_LOGICBLOCK
used by the HighlightParser only, when a method body is parsed
PARSER_EVENT_NOEVENTS
PARSER_EVENT_NOEVENTS in Parser.inc
used for the beginning of parsing, before first < ? php encountered
PARSER_EVENT_OUTPHP
PARSER_EVENT_OUTPHP in Parser.inc
used when a ? > (with no space) is encountered in parsing
PARSER_EVENT_PHPCODE
PARSER_EVENT_PHPCODE in Parser.inc
used when php code processor instruction (< ? php) is encountered in parsing
PARSER_EVENT_QUOTE
PARSER_EVENT_QUOTE in Parser.inc
used when double quotation mark (") encountered in parsing
PARSER_EVENT_QUOTE_VAR
used by the HighlightParser only, when {$var} is encountered in a string
PARSER_EVENT_SINGLEQUOTE
used when a single quote (') is encountered in parsing
PARSER_EVENT_STATIC_VAR
used when parsing a "static $var1, $var2;" declaration in a function
PARSER_EVENT_STATIC_VAR_VALUE
used when parsing the value in a "static $var1 = x" declaration in a function
PARSER_EVENT_TAGS
PARSER_EVENT_TAGS in Parser.inc
used when parsing the @tag block of a docblock
PARSER_EVENT_VAR
PARSER_EVENT_VAR in Parser.inc
used when a var statement is encountered in parsing a class definition
PARSER_EVENT_VAR_ARRAY
used when a variable value is an array
PARSER_EVENT_VAR_ARRAY_COMMENT
used when a comment is found in a variable array value
parseString
Parse a new file
Parser.inc
Parser.inc in Parser.inc
phpDocumentorTParser.inc
phpDocumentorTParser.inc in phpDocumentorTParser.inc
phpDocumentorTParser
phpDocumentorTParser in phpDocumentorTParser.inc
Tokenizer-based parser for PHP source code
phpDocumentorTParser
Constructor
PHPDOCUMENTOR_EVENT_CLASS
Class published to IntermediateParser with this event
PHPDOCUMENTOR_EVENT_CONST
Class Constant published to IntermediateParser with this event
PHPDOCUMENTOR_EVENT_DEFINE
Constant (define) published to IntermediateParser with this event
PHPDOCUMENTOR_EVENT_DOCBLOCK
DocBlock published to IntermediateParser with this event
PHPDOCUMENTOR_EVENT_DOCBLOCK_TEMPLATE
used when a docblock template is encountered in the source
PHPDOCUMENTOR_EVENT_END_DOCBLOCK_TEMPLATE
used when a docblock template is encountered in the source
PHPDOCUMENTOR_EVENT_END_PAGE
used to inform phpDocumentor_IntermediateParser that the current file has been completely parsed.
PHPDOCUMENTOR_EVENT_FUNCTION
Function published to IntermediateParser with this event
PHPDOCUMENTOR_EVENT_GLOBAL
used when a global variable definition is encountered in the source
PHPDOCUMENTOR_EVENT_INCLUDE
Include (include/require/include_once/include_once) published to IntermediateParser with this event
PHPDOCUMENTOR_EVENT_MESSAGE
PHPDOCUMENTOR_EVENT_NEWFILE
use to inform ErrorTracker of a new file being parsed
PHPDOCUMENTOR_EVENT_NEWLINENUM
use to inform ErrorTracker of the next line number being parsed
PHPDOCUMENTOR_EVENT_NEWSTATE
use to inform IntermediateParser of a new element being parsed
PHPDOCUMENTOR_EVENT_PACKAGEPAGE
Package-level page published to IntermediateParser with this event
PHPDOCUMENTOR_EVENT_PAGE
New File (page) published to IntermediateParser with this event
PHPDOCUMENTOR_EVENT_README_INSTALL_CHANGELOG
Contents of README/INSTALL/CHANGELOG files published to IntermediateParser with this event
PHPDOCUMENTOR_EVENT_TUTORIAL
Tutorial published to IntermediateParser with this event
PHPDOCUMENTOR_EVENT_VAR
Class Variable published to IntermediateParser with this event
phpDocumentor_HighlightParser
Initialize the $tokenpushEvent, $wordpushEvent arrays
phpDocumentor_HighlightParser
phpDocumentor_HighlightParser in HighlightParser.inc
Highlights source code using parse()
phpDocumentor_HighlightWordParser
phpDocumentor_HighlightWordParser in HighlightParser.inc
Retrieve tokens from an array of tokens organized by line numbers
PHPDOCUMENTOR_PDP_EVENT_ATTRIBUTES
PHPDOCUMENTOR_PDP_EVENT_ATTRIBUTES in XMLpackagePageParser.inc
when tag attributes name="value" are found
PHPDOCUMENTOR_PDP_EVENT_CDATA
PHPDOCUMENTOR_PDP_EVENT_CDATA in XMLpackagePageParser.inc
when <![CDATA[ ]]> is found
PHPDOCUMENTOR_PDP_EVENT_ENTITY
PHPDOCUMENTOR_PDP_EVENT_ENTITY in XMLpackagePageParser.inc
when tag attributes name="value" are found
PHPDOCUMENTOR_PDP_EVENT_PROGRAMLISTING
PHPDOCUMENTOR_PDP_EVENT_PROGRAMLISTING in XMLpackagePageParser.inc
when <programlisting> is found
PHPDOCUMENTOR_PDP_EVENT_TAG
PHPDOCUMENTOR_PDP_EVENT_TAG in XMLpackagePageParser.inc
when a DocBook <tag> is found
PHPDOCUMENTOR_PDP_STATE_ATTRIBUTES
PHPDOCUMENTOR_PDP_STATE_ATTRIBUTES in XMLpackagePageParser.inc
when tag attributes name="value" are found
PHPDOCUMENTOR_PDP_STATE_CDATA
PHPDOCUMENTOR_PDP_STATE_CDATA in XMLpackagePageParser.inc
when <![CDATA[ ]]> is found
PHPDOCUMENTOR_PDP_STATE_ENTITY
PHPDOCUMENTOR_PDP_STATE_ENTITY in XMLpackagePageParser.inc
when tag attributes name="value" are found
PHPDOCUMENTOR_PDP_STATE_PROGRAMLISTING
PHPDOCUMENTOR_PDP_STATE_PROGRAMLISTING in XMLpackagePageParser.inc
when <programlisting> is found
PHPDOCUMENTOR_PDP_STATE_TAG
PHPDOCUMENTOR_PDP_STATE_TAG in XMLpackagePageParser.inc
when a DocBook <tag> is found
phpDocumentor_peardoc2_XML_Beautifier
This is just like XML_Beautifier, but uses phpDocumentor_XML_Beautifier_Tokenizer
phpDocumentor_TutorialHighlightParser
phpDocumentor_TutorialHighlightParser in TutorialHighlightParser.inc
Highlights source code using parse()
phpDocumentor_TutorialHighlightParser
Initialize the $tokenpushEvent, $wordpushEvent arrays
phpDocumentor_XML_Beautifier_Tokenizer
Highlights source code using parse()
phpDocumentor_XML_Beautifier_Tokenizer
Initialize the $tokenpushEvent, $wordpushEvent arrays
PHPDOC_BEAUTIFIER_CDATA
PHPDOC_BEAUTIFIER_CDATA in Tokenizer.php
do not remove, needed in plain renderer
PHPDOC_XMLTOKEN_EVENT_ATTRIBUTE
used when a <tag attr="attribute"> is found
PHPDOC_XMLTOKEN_EVENT_CDATA
used when a <! is found
PHPDOC_XMLTOKEN_EVENT_CLOSETAG
used when a close </tag> is found
PHPDOC_XMLTOKEN_EVENT_COMMENT
used when a <!-- comment --> is found
PHPDOC_XMLTOKEN_EVENT_DEF
PHPDOC_XMLTOKEN_EVENT_DEF in Tokenizer.php
used when a <! is found
PHPDOC_XMLTOKEN_EVENT_DOUBLEQUOTE
used when a <!-- comment --> is found
PHPDOC_XMLTOKEN_EVENT_ENTITY
used when an &entity; is found
PHPDOC_XMLTOKEN_EVENT_IN_CDATA
used when a <![CDATA[ section is found
PHPDOC_XMLTOKEN_EVENT_NOEVENTS
starting state
PHPDOC_XMLTOKEN_EVENT_OPENTAG
used when an open <tag> is found
PHPDOC_XMLTOKEN_EVENT_PI
PHPDOC_XMLTOKEN_EVENT_PI in Tokenizer.php
used when a processor instruction is found
PHPDOC_XMLTOKEN_EVENT_SINGLEQUOTE
used when a <!-- comment --> is found
PHPDOC_XMLTOKEN_EVENT_XML
PHPDOC_XMLTOKEN_EVENT_XML in Tokenizer.php
used when a <?xml is found
ppageParser
set up invariant Parser variables
ppageParser
ppageParser in Parser.inc
Global package page parser
propertyTagHandler
Handles @property(-read or -write) and @method magic tag
parserCData
parserCData in PackagePageElements.inc
Represents <![CDATA[ ]]> sections.
parserEntity
parserEntity::parserEntity() in PackagePageElements.inc
sets up the entity
parserEntity
parserEntity in PackagePageElements.inc
a standard entity like &rdquo;
parserXMLDocBookTag
sets up the tag
parserXMLDocBookTag
parserXMLDocBookTag in PackagePageElements.inc
a standard XML DocBook Tag
PackagePageElements.inc
PackagePageElements.inc in PackagePageElements.inc
phpDocumentorTWordParser.inc
phpDocumentorTWordParser.inc in phpDocumentorTWordParser.inc
phpDocumentorTWordParser
phpDocumentorTWordParser in phpDocumentorTWordParser.inc
Like WordParser, but expects an array of tokens from the tokenizer instead of a string.
q
top
$quietMode
set in Setup.inc.php to the value of the quitemode commandline option.
r
top
$render
Used to organize output from the Parser before Conversion
$ric
phpDocumentor_IntermediateParser::$ric in IntermediateParser.inc
Stores parsed CHANGELOG/INSTALL/README files
readCommandLineSettings
Get phpDocumentor settings from command-line or web interface
readConfigFile
Get phpDocumentor settings from a user configuration file
readPhpFile
Reads a file and returns it as a string Does basic error checking
recurseDir
recurseDir() in utilities.php
removeNonMatches
Removes files from the $dir array that do not match the search string in
replaceElement
ProceduralPages::replaceElement() in ProceduralPages.inc
Used to align an element with the package of its parent page prior to Conversion.
$returnType
parserVarTag::$returnType in DocBlockTags.inc
the type a var has
$returnType
parserReturnTag::$returnType in DocBlockTags.inc
the type a function returns
$returnType
parserPropertyTag::$returnType in DocBlockTags.inc
the type a property has
$returnType
parserMethodTag::$returnType in DocBlockTags.inc
the return type a method has
RecordError
RecordError in Errors.inc
encapsulates error information
RecordWarning
RecordWarning in Errors.inc
encapsulates warning information
RecordWarning
Constructor
returnErrors
Get sorted array of all non-fatal errors in parsing/conversion
returnLastError
Get the error message of the last error
returnLastWarning
Get the warning message of the last warning
returnWarnings
Get sorted array of all warnings in parsing/conversion
$return
parserDocBlock::$return in ParserDocBlock.inc
This is either a parserReturnTag or false if no return tag is present
replaceInheritDoc
parserDesc::replaceInheritDoc() in ParserDocBlock.inc
replaces [email protected]} with the contents of the parent DocBlock
replaceInheritDoc
resetParams
parserDocBlock::resetParams() in ParserDocBlock.inc
$returnsreference
parserFunction::$returnsreference in ParserElements.inc
Function returns a reference to an element, instead of a value
$refsect1id
XMLPackagePageParser::$refsect1id in XMLpackagePageParser.inc
$refsect2id
XMLPackagePageParser::$refsect2id in XMLpackagePageParser.inc
$refsect3id
XMLPackagePageParser::$refsect3id in XMLpackagePageParser.inc
returnTagHandler
handles @return
s
top
$setup
Used to parse command-line options
$stack
EventStack::$stack in EventStack.inc
The stack
$subscriber
Publisher::$subscriber in Publisher.inc
Array of references objects that have Subscribed to this publisher
Setup.inc.php
Setup.inc.php in Setup.inc.php
setClassParent
Find the parent class of $class, and set up structures to note this fact
setDirectoriesToParse
setFilesToParse
setIgnore
setJavadocDesc
setMemoryLimit
Allow a memory_limit setting in phpDocumentor.ini to override php.ini or default memory limit
setName
ProceduralPages::setName() in ProceduralPages.inc
Change a page's name from its file to alias $name
setPackageOutput
setParseBase
ProceduralPages::setParseBase() in ProceduralPages.inc
sets the parser base
setParsePrivate
set display of elements marked with @access private
setParsePrivate
setQuietMode
setQuietMode
set parsing information output mode (quiet or verbose)
setTargetDir
Sets the output directory
setTargetDir
setTemplateBase
Sets the template base directory
setTemplateBase
setTitle
setUndocumentedElementWarnings
setUndocumentedElementWarningsMode
show warnings for undocumented elements
setupPagePackages
if there is one class package in a file, the parent path inherits the package if its package is default.
setupPages
ProceduralPages::setupPages() in ProceduralPages.inc
Adjusts packages of all pages and removes name conflicts within a package
setup_dirs
setup_dirs() in Io.inc
Recursively move contents of $struc into associative array
set_dir
set_dir() in Io.inc
Recursively add all the subdirectories of $contents to $dir without erasing anything in
showImage
showImage() in utilities.php
Allows png's with alpha transparency to be displayed in IE 6
SMART_PATH_DELIMITER
SMART_PATH_DELIMITER in common.inc.php
subscribe
Publisher::subscribe() in Publisher.inc
Adds a subscriber to the $subscriber array().
suite
tests_HighlightParserTests::suite() in HighlightParserTests.php
suite
tests_IntermediateParserTests::suite() in IntermediateParserTests.php
suite
tests_phpDocumentorTParserTests::suite() in phpDocumentorTParserTests.php
suite
tests_ParserPageTests::suite() in ParserPageTests.php
suite
tests_ParserClassTests::suite() in ParserClassTests.php
suite
tests_phpDocumentorSetupTests::suite() in phpDocumentorSetupTests.php
switchDirTree
switchDirTree() in utilities.php
$source
parserFileSourceTag::$source in DocBlockTags.inc
$source
tokenized source organized by line numbers for php 4.3.0+, the old
$start
First line of source code to display
$subpackage
subpackage of the [email protected]}
setPath
set the path
setSource
sets the source tag's value
setSource
sets the source
setTOC
set the TOC
stringConvert
converter helper used in PHP 4.2.3-
Strlen
only used to determine blank lines. [email protected]} will not be blank, probably
Strlen
parserInlineTag::Strlen() in InlineTags.inc
get length of the tag
$section
tutorialLink::$section in LinkClasses.inc
$subpackage
abstractLink::$subpackage in LinkClasses.inc
$source
parserPage::$source in ParserData.inc
Tokenized source code of the file
$sourceLocation
parserPage::$sourceLocation in ParserData.inc
relative source location
$subpackage
parserPage::$subpackage in ParserData.inc
setDocBlock
parserData::setDocBlock() in ParserData.inc
sets the docblock
setFile
parserPage::setFile() in ParserData.inc
Sets the name to display in documentation (can be an alias set with @name)
setName
parserPage::setName() in ParserData.inc
sets the name
setPackageOutput
loads the package output array
setParent
parserData::setParent() in ParserData.inc
sets the parent
setPath
parserPage::setPath() in ParserData.inc
sets the path to the file
setSource
Pass source code to any [email protected]} tags contained within the string for later conversion.
setSource
parserPage::setSource() in ParserData.inc
Sets the source code of the file for highlighting.
setSourceLocation
sets the source location
setValue
parserBase::setValue() in ParserData.inc
sets the given value
$sdesc
parserDocBlock::$sdesc in ParserDocBlock.inc
$statics
parserDocBlock::$statics in ParserDocBlock.inc
array of static variable data.
$subpackage
parserDocBlock::$subpackage in ParserDocBlock.inc
$subpackagedescrip
description of subpackage parsed from @package tag
setDesc
parserDocBlock::setDesc() in ParserDocBlock.inc
setEndLineNumber
Sets the ending line number for the DocBlock
setExplicitCategory
Used if this docblock has a @category tag.
setExplicitPackage
Used if this docblock has a @package tag.
setLineNumber
parserDocBlock::setLineNumber() in ParserDocBlock.inc
Sets the starting line number for the DocBlock
setShortDesc
parserDocBlock::setShortDesc() in ParserDocBlock.inc
Set the short description of the DocBlock
setSource
parserDocBlock::setSource() in ParserDocBlock.inc
$source
parserFunction::$source in ParserElements.inc
$sourceLocation
parserClass::$sourceLocation in ParserElements.inc
$statics
parserFunction::$statics in ParserElements.inc
static variable declarations parsed from function definition
setAccessModifiers
parserClass::setAccessModifiers() in ParserElements.inc
Use this method to set access modifiers for a class
setConstructor
parserMethod::setConstructor() in ParserElements.inc
Use this method to tell the parser that this method is the class constructor
setDataType
parserGlobal::setDataType() in ParserElements.inc
Sets the name of the global variable's type
setDestructor
parserMethod::setDestructor() in ParserElements.inc
Use this method to tell the parser that this method is the class constructor
setDocBlock
parserElement::setDocBlock() in ParserElements.inc
setEndLineNumber
parserElement::setEndLineNumber() in ParserElements.inc
Sets the ending line number of elements
setExtends
parserClass::setExtends() in ParserElements.inc
setFile
parserElement::setFile() in ParserElements.inc
setInterface
parserClass::setInterface() in ParserElements.inc
Use this method to set the type of class to be an interface
setLineNumber
parserElement::setLineNumber() in ParserElements.inc
Set starting line number
setModifiers
parserMethod::setModifiers() in ParserElements.inc
Return name of the class that contains this method
setModifiers
parserVar::setModifiers() in ParserElements.inc
Return name of the class that contains this method
setModifiers
parserClass::setModifiers() in ParserElements.inc
Set the PHP5+ modifiers for this class
setName
parserElement::setName() in ParserElements.inc
setNext
parserTutorial::setNext() in ParserElements.inc
setParent
parserTutorial::setParent() in ParserElements.inc
setParent
parserClass::setParent() in ParserElements.inc
setParentNoClass
parserClass::setParentNoClass() in ParserElements.inc
setPath
parserElement::setPath() in ParserElements.inc
setPrev
parserTutorial::setPrev() in ParserElements.inc
setReturnsReference
sets $returnsreference to true
setSourceLocation
parserClass::setSourceLocation() in ParserElements.inc
$source_location
phpDocumentorTParser::$source_location in phpDocumentorTParser.inc
relative path of the parsed file from the base parse directory
$subpackage
setLineNum
Start the parsing at a certain line number
setLineNum
Start the parsing at a certain line number
setup
Initialize the parser object
setupStates
Parser::setupStates() in Parser.inc
setup the parser tokens, and the pushEvent/popEvent arrays
setupStates
set up invariant Parser variables
setupStates
Initialize all parser state variables
setupStates
XMLPackagePageParser::setupStates() in XMLpackagePageParser.inc
setup the parser tokens, and the pushEvent/popEvent arrays
setupStates
parserDescParser::setupStates() in ParserDescCleanup.inc
setup the parser tokens, and the pushEvent/popEvent arrays
setupStates
Initialize all parser state variables
setupStates
Initialize all parser state variables
STATE_ACCESS_MODIFIER
STATE_ACCESS_MODIFIER in Parser.inc
currently parsing an access modifier
STATE_ARRAY
STATE_ARRAY in Parser.inc
currently parsing an array
STATE_CLASS
STATE_CLASS in Parser.inc
currently parsing a class definition
STATE_CLASS_CONSTANT
STATE_CLASS_CONSTANT in Parser.inc
currently parsing a class constant
STATE_CLASS_MEMBER
STATE_CLASS_MEMBER in Parser.inc
currently parsing a class member using the HighlightParser
STATE_COMMENT
STATE_COMMENT in Parser.inc
currently parsing a short comment //
STATE_COMMENTBLOCK
STATE_COMMENTBLOCK in Parser.inc
currently parsing a long comment /x x/ where x is an asterisk
STATE_DEFINE
STATE_DEFINE in Parser.inc
currently parsing a define statement
STATE_DEFINE_PARAMS
STATE_DEFINE_PARAMS in Parser.inc
currently parsing the stuff in ( ) of a define statement
STATE_DEFINE_PARAMS_PARENTHESIS
currently parsing an inner parenthetical statement of a define( )
STATE_DESC
STATE_DESC in Parser.inc
currently parsing the desc part of a docblock
STATE_DOCBLOCK
STATE_DOCBLOCK in Parser.inc
currently parsing a DocBlock
STATE_DOCBLOCK_TEMPLATE
currently parsing the value in a "static $var1 = x" declaration in a function
STATE_DOCKEYWORD
STATE_DOCKEYWORD in Parser.inc
currently parsing a @tag in a DocBlock
STATE_DOCKEYWORD_EMAIL
currently parsing an email in brackets in an @author tag of a DocBlock
STATE_END_CLASS
STATE_END_CLASS in Parser.inc
used to tell Render that a class has been completely parsed, and to flush buffers
STATE_END_DOCBLOCK_TEMPLATE
currently parsing the value in a "static $var1 = x" declaration in a function
STATE_EOFQUOTE
STATE_EOFQUOTE in Parser.inc
currently parsing a string defined using Perl <<<
STATE_ESCAPE
STATE_ESCAPE in Parser.inc
used when a backslash is encountered in parsing a string or other escapable entity
STATE_FUNCTION
STATE_FUNCTION in Parser.inc
currently parsing a Function or Method
STATE_FUNCTION_PARAMS
STATE_FUNCTION_PARAMS in Parser.inc
currently parsing the stuff in ( ) of a function definition
STATE_FUNCTION_PARAM_VAR
currently parsing a $param in a function definition
STATE_FUNC_GLOBAL
STATE_FUNC_GLOBAL in Parser.inc
currently parsing a "global $var1, $var2;" declaration in a function
STATE_GLOBAL
STATE_GLOBAL in Parser.inc
currently parsing a global variable declaration
STATE_GLOBAL_VALUE
STATE_GLOBAL_VALUE in Parser.inc
currently parsing the default value in a global variable declaration
STATE_IMPLEMENTS
STATE_IMPLEMENTS in Parser.inc
currently parsing an implements clause
STATE_INCLUDE
STATE_INCLUDE in Parser.inc
currently parsing an include/require/include_once/include_once
STATE_INCLUDE_PARAMS
STATE_INCLUDE_PARAMS in Parser.inc
currently parsing the stuff in ( ) of a define statement
STATE_INCLUDE_PARAMS_PARENTHESIS
currently parsing an inner parenthetical statement of an include/includeonce/require/requireonce( )
STATE_INLINE_DOCKEYWORD
currently parsing an inline tag like { @link} in a DocBlock
STATE_LOGICBLOCK
STATE_LOGICBLOCK in Parser.inc
currently parsing a { } block
STATE_METHOD
STATE_METHOD in Parser.inc
currently parsing a method using the HighlightParser
STATE_METHOD_LOGICBLOCK
currently parsing the method body using the HighlightParser
STATE_NOEVENTS
STATE_NOEVENTS in Parser.inc
out of < ? php tag
STATE_OUTPHP
STATE_OUTPHP in Parser.inc
currently out of php code
STATE_PHPCODE
STATE_PHPCODE in Parser.inc
currently parsing php code
STATE_QUOTE
STATE_QUOTE in Parser.inc
currently parsing a quote
STATE_QUOTE_VAR
STATE_QUOTE_VAR in Parser.inc
currently parsing a {$encapsed_var} using the HighlightParser
STATE_SINGLEQUOTE
STATE_SINGLEQUOTE in Parser.inc
currently parsing a string enclosed in single quotes (')
STATE_STATIC_VAR
STATE_STATIC_VAR in Parser.inc
currently parsing a "static $var1, $var2;" declaration in a function
STATE_STATIC_VAR_VALUE
currently parsing the value in a "static $var1 = x" declaration in a function
STATE_TAGS
STATE_TAGS in Parser.inc
currently parsing the @tag block of a docblock
STATE_TUTORIAL_ATTRIBUTE
STATE_TUTORIAL_ATTRIBUTE in TutorialHighlightParser.inc
currently parsing an open <tag>
STATE_TUTORIAL_CLOSETAG
STATE_TUTORIAL_CLOSETAG in TutorialHighlightParser.inc
currently parsing a close </tag>
STATE_TUTORIAL_COMMENT
STATE_TUTORIAL_COMMENT in TutorialHighlightParser.inc
currently parsing a <!-- comment -->
STATE_TUTORIAL_DOUBLEQUOTE
STATE_TUTORIAL_DOUBLEQUOTE in TutorialHighlightParser.inc
currently parsing a <!-- comment -->
STATE_TUTORIAL_ENTITY
STATE_TUTORIAL_ENTITY in TutorialHighlightParser.inc
currently parsing an &entity;
STATE_TUTORIAL_ITAG
STATE_TUTORIAL_ITAG in TutorialHighlightParser.inc
currently parsing an [email protected] tag}
STATE_TUTORIAL_NOEVENTS
STATE_TUTORIAL_NOEVENTS in TutorialHighlightParser.inc
currently in starting state
STATE_TUTORIAL_OPENTAG
STATE_TUTORIAL_OPENTAG in TutorialHighlightParser.inc
currently parsing an open <tag>
STATE_TUTORIAL_SINGLEQUOTE
STATE_TUTORIAL_SINGLEQUOTE in TutorialHighlightParser.inc
currently parsing a <!-- comment -->
STATE_VAR
STATE_VAR in Parser.inc
currently parsing a Class variable
STATE_VAR_ARRAY
STATE_VAR_ARRAY in Parser.inc
currently parsing a variable value is an array
STATE_VAR_ARRAY_COMMENT
currently parsing a comment in a variable array value
STATE_XMLTOKEN_ATTRIBUTE
STATE_XMLTOKEN_ATTRIBUTE in Tokenizer.php
currently parsing an open <tag>
STATE_XMLTOKEN_CDATA
STATE_XMLTOKEN_CDATA in Tokenizer.php
currently parsing a <!
STATE_XMLTOKEN_CLOSETAG
STATE_XMLTOKEN_CLOSETAG in Tokenizer.php
currently parsing a close </tag>
STATE_XMLTOKEN_COMMENT
STATE_XMLTOKEN_COMMENT in Tokenizer.php
currently parsing a <!-- comment -->
STATE_XMLTOKEN_DEF
STATE_XMLTOKEN_DEF in Tokenizer.php
currently parsing a <!
STATE_XMLTOKEN_DOUBLEQUOTE
currently parsing a <!-- comment -->
STATE_XMLTOKEN_ENTITY
STATE_XMLTOKEN_ENTITY in Tokenizer.php
currently parsing an &entity;
STATE_XMLTOKEN_IN_CDATA
STATE_XMLTOKEN_IN_CDATA in Tokenizer.php
currently parsing a <![CDATA[ ]]>
STATE_XMLTOKEN_NOEVENTS
STATE_XMLTOKEN_NOEVENTS in Tokenizer.php
currently in starting state
STATE_XMLTOKEN_OPENTAG
STATE_XMLTOKEN_OPENTAG in Tokenizer.php
currently parsing an open <tag>
STATE_XMLTOKEN_PI
STATE_XMLTOKEN_PI in Tokenizer.php
currently in processor instruction
STATE_XMLTOKEN_SINGLEQUOTE
currently parsing a <!-- comment -->
STATE_XMLTOKEN_XML
STATE_XMLTOKEN_XML in Tokenizer.php
currently parsing a <?xml
staticvarTagHandler
handles @staticvar
setId
parserXMLDocBookTag::setId() in PackagePageElements.inc
If the id attribute is present, this method will set its id
setTitle
parserXMLDocBookTag::setTitle() in PackagePageElements.inc
Set the title of a DocBook tag section.
setTOC
parserXMLDocBookTag::setTOC() in PackagePageElements.inc
sets the TOC value
startCData
parserXMLDocBookTag::startCData() in PackagePageElements.inc
Begin a new CData section
setPos
WordParser::setPos() in WordParser.inc
Set the internal cursor within the source code
setSeperator
WordParser::setSeperator() in WordParser.inc
Sets the list of possible separator tokens
setup
WordParser::setup() in WordParser.inc
Initialize the WordParser
setup
phpDocumentorTWordParser::setup() in phpDocumentorTWordParser.inc
Uses http://www.php.net/token_get_all to tokenize the source code.
setup
ObjectWordParser::setup() in ParserDescCleanup.inc
Set the word parser to go.
setWhitespace
WordParser::setWhitespace() in WordParser.inc
set parser to return or strip whitespace
t
top
$targetDir
used to set the output directory
$templateBase
used to set the template base directory
$title
$tokens
Publisher::$tokens in Publisher.inc
$type
phpDocumentor_IntermediateParser::$type in IntermediateParser.inc
type of the current parser Element being handled
top.php
top.php in top.php
tests_HighlightParserTests
tests_HighlightParserTests in HighlightParserTests.php
tests_IntermediateParserTests
tests_IntermediateParserTests in IntermediateParserTests.php
tests_ParserClassTests
tests_ParserClassTests in ParserClassTests.php
tests_ParserPageTests
tests_ParserPageTests in ParserPageTests.php
tests_phpDocumentorSetupTests
tests_phpDocumentorSetupTests in phpDocumentorSetupTests.php
tests_phpDocumentorTParserTests
tests_phpDocumentorTParserTests in phpDocumentorTParserTests.php
tokenizer_ext
tokenizer_ext in common.inc.php
$type
parserTag::$type in DocBlockTags.inc
Type is used by many functions to skip the hassle of
$type
RecordWarning::$type in Errors.inc
name of global variable that descriptors for this warning/error is kept
$type
RecordError::$type in Errors.inc
name of global variable that descriptors for this warning/error is kept
$tutorial
full name of the tutorial
$type
parserInlineTag::$type in InlineTags.inc
Element type
$title
tutorialLink::$title in LinkClasses.inc
$type
pageLink::$type in LinkClasses.inc
$type
tutorialLink::$type in LinkClasses.inc
$type
varLink::$type in LinkClasses.inc
$type
methodLink::$type in LinkClasses.inc
$type
globalLink::$type in LinkClasses.inc
$type
constLink::$type in LinkClasses.inc
$type
defineLink::$type in LinkClasses.inc
$type
abstractLink::$type in LinkClasses.inc
element type linked to.
$type
functionLink::$type in LinkClasses.inc
$type
classLink::$type in LinkClasses.inc
tutorialLink
tutorialLink in LinkClasses.inc
tutorial link
$tutorial
parserData::$tutorial in ParserData.inc
$type
Type is used by many functions to skip the hassle of if phpDocumentor_get_class($blah) == 'parserBlah'...
$type
parserPage::$type in ParserData.inc
Type is used by many functions to skip the hassle of if
$type
parserData::$type in ParserData.inc
Type is used by many functions to skip the hassle of if
$type
parserBase::$type in ParserData.inc
Type is used by many functions to skip the hassle of if
trimmedStrlen
equivalent to trim(strlen($string))
$tags
parserDocBlock::$tags in ParserDocBlock.inc
array of parserTags
$type
parserDesc::$type in ParserDocBlock.inc
Type is used by many functions to skip the hassle of if phpDocumentor_get_class($blah) == 'parserBlah'
$tutorial
parserClass::$tutorial in ParserElements.inc
$tutorial_type
parserTutorial::$tutorial_type in ParserElements.inc
Either cls, pkg, or proc
$type
parserPackagePage::$type in ParserElements.inc
Type is used by many functions to skip the hassle of if phpDocumentor_get_class($blah) == 'parserBlah'
$type
parserTutorial::$type in ParserElements.inc
Type is used by many functions to skip the hassle of if phpDocumentor_get_class($blah) == 'parserBlah'
$type
parserVar::$type in ParserElements.inc
Type is used by many functions to skip the hassle of if phpDocumentor_get_class($blah) == 'parserBlah'
$type
parserMethod::$type in ParserElements.inc
Type is used by many functions to skip the hassle of if phpDocumentor_get_class($blah) == 'parserBlah'
$type
parserGlobal::$type in ParserElements.inc
Type is used by many functions to skip the hassle of if phpDocumentor_get_class($blah) == 'parserBlah'
$type
parserClass::$type in ParserElements.inc
Type is used by many functions to skip the hassle of if phpDocumentor_get_class($blah) == 'parserBlah'
$type
parserConst::$type in ParserElements.inc
Type is used by many functions to skip the hassle of if phpDocumentor_get_class($blah) == 'parserBlah'
$type
parserDefine::$type in ParserElements.inc
Type is used by many functions to skip the hassle of if phpDocumentor_get_class($blah) == 'parserBlah'
$type
parserFunction::$type in ParserElements.inc
Type is used by many functions to skip the hassle of if phpDocumentor_get_class($blah) == 'parserBlah'
$type
parserInclude::$type in ParserElements.inc
Type is used by many functions to skip the hassle of if phpDocumentor_get_class($blah) == 'parserBlah'
Tokenizer.php
Tokenizer.php in Tokenizer.php
TutorialHighlightParser.inc
TutorialHighlightParser.inc in TutorialHighlightParser.inc
TUTORIAL_EVENT_ATTRIBUTE
TUTORIAL_EVENT_ATTRIBUTE in TutorialHighlightParser.inc
used when a <tag attr="attribute"> is found
TUTORIAL_EVENT_CLOSETAG
TUTORIAL_EVENT_CLOSETAG in TutorialHighlightParser.inc
used when a close </tag> is found
TUTORIAL_EVENT_COMMENT
TUTORIAL_EVENT_COMMENT in TutorialHighlightParser.inc
used when a <!-- comment --> is found
TUTORIAL_EVENT_DOUBLEQUOTE
TUTORIAL_EVENT_DOUBLEQUOTE in TutorialHighlightParser.inc
used when a <!-- comment --> is found
TUTORIAL_EVENT_ENTITY
TUTORIAL_EVENT_ENTITY in TutorialHighlightParser.inc
used when an &entity; is found
TUTORIAL_EVENT_ITAG
TUTORIAL_EVENT_ITAG in TutorialHighlightParser.inc
used when an [email protected] tag} is found
TUTORIAL_EVENT_NOEVENTS
TUTORIAL_EVENT_NOEVENTS in TutorialHighlightParser.inc
starting state
TUTORIAL_EVENT_OPENTAG
TUTORIAL_EVENT_OPENTAG in TutorialHighlightParser.inc
used when an open <tag> is found
TUTORIAL_EVENT_SINGLEQUOTE
TUTORIAL_EVENT_SINGLEQUOTE in TutorialHighlightParser.inc
used when a <!-- comment --> is found
T_ABSTRACT
T_ABSTRACT in Parser.inc
T_CONST
T_CONST in Parser.inc
T_DOC_COMMENT
T_DOC_COMMENT in Parser.inc
T_FINAL
T_FINAL in Parser.inc
T_IMPLEMENTS
T_IMPLEMENTS in Parser.inc
T_INTERFACE
T_INTERFACE in Parser.inc
T_ML_COMMENT
T_ML_COMMENT in Parser.inc
T_PRIVATE
T_PRIVATE in Parser.inc
T_PROTECTED
T_PROTECTED in Parser.inc
T_PUBLIC
T_PUBLIC in Parser.inc
tokenEquals
phpDocumentorTWordParser::tokenEquals() in phpDocumentorTWordParser.inc
Utility function to determine whether two tokens from the tokenizer are equal
u
top
$undocumentedElementWarnings
set in Setup.inc.php to the value of the undocumentedElementWarnings commandline option.
$uses
phpDocumentor_IntermediateParser::$uses in IntermediateParser.inc
utilities.php
utilities.php in utilities.php
$unknown_tags
parserDocBlock::$unknown_tags in ParserDocBlock.inc
array of unrecognized parserTags
updateGlobals
parserDocBlock::updateGlobals() in ParserDocBlock.inc
replaces nameless global variables in the $funcglobals array with their names
updateModifiers
parserDocBlock::updateModifiers() in ParserDocBlock.inc
updateParams
parserDocBlock::updateParams() in ParserDocBlock.inc
replaces nameless parameters in the $params array with their names
updateStatics
parserDocBlock::updateStatics() in ParserDocBlock.inc
replaces nameless static variables in the $statics array with their names
usesTagHandler
handles @uses
v
top
$valid_booleans
A specific array of values that boolean-based arguments can understand, aided by the decideOnOrOff() helper method.
vdump_par
vdump_par() in utilities.php
varLink
varLink in LinkClasses.inc
class variable link
$value
array of strings and parserInlineTags
$value
parserBase::$value in ParserData.inc
set to different things by its descendants
$var
parserDocBlock::$var in ParserDocBlock.inc
This is either a parserVarTag or false if no var tag is present
varTagHandler
handles @var
w
top
writeSource
have the output converter write the source code
$warnings
array of RecordWarnings
WordParser.inc
WordParser.inc in WordParser.inc
WordParser
WordParser in WordParser.inc
Retrieves tokens from source code for use by the Parser
x
top
XMLpackagePageParser.inc
XMLpackagePageParser.inc in XMLpackagePageParser.inc
XMLPackagePageParser
Set up the wordparser
XMLPackagePageParser
XMLPackagePageParser in XMLpackagePageParser.inc
Used to parse XML DocBook-based tutorials
a b c d e f g h i k l m n o p q r s t u v w x _