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