Index of All Elements

Package Indexes

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

[Top]

a

$addLooseObjects: in file class.pdf.php, variable Cpdf::$addLooseObjects
array contains infomation about how the loose objects are to be added to the document
$all_packages: in file IntermediateParser.inc, variable phpDocumentor_IntermediateParser::$all_packages
list of all packages encountered while documenting. Used in automatic linking.
$all_packages: in file Converter.inc, variable Converter::$all_packages
All packages encountered in parsing
$arc4: in file class.pdf.php, variable Cpdf::$arc4
the ancryption array for the document encryption is stored here
$arc4_objnum: in file class.pdf.php, variable Cpdf::$arc4_objnum
the object Id of the encryption information
$attributes: in file PackagePageElements.inc, variable parserXMLDocBookTag::$attributes
Attributes from the XML tag
$autoload_filters: in file Smarty.class.php, variable Smarty::$autoload_filters
This indicates which filters are automatically loaded into Smarty.
abstractLink: in file LinkClasses.inc, class abstractLink
linking classes parent
add: in file PackagePageElements.inc, method parserXMLDocBookTag::add()
Add contents to this tag.
add: in file ParserData.inc, method parserStringWithInlineTags::add()
equivalent to the . operator ($a = $b . $c)
add: in file ParserDocBlock.inc, method parserDesc::add()
addAccess: in file ParserDocBlock.inc, method parserDocBlock::addAccess()
add an @access tag to the tags array
addAttribute: in file PackagePageElements.inc, method parserXMLDocBookTag::addAttribute()
Add an xml tag attribute name="value" pair
addCData: in file PackagePageElements.inc, method parserXMLDocBookTag::addCData()
add a word to CData
addClass: in file Classes.inc, method Classes::addClass()
While parsing, add a class to the list of parsed classes
addClassPackageToFile: in file ProceduralPages.inc, method ProceduralPages::addClassPackageToFile()
adds a package from a class to the current file
addConst: in file Classes.inc, method Classes::addConst()
While parsing, add a variable to the list of parsed variables
addConverter: in file IntermediateParser.inc, method phpDocumentor_IntermediateParser::addConverter()
Add a converter name to use to the list of converters
addDefine: in file ProceduralPages.inc, method ProceduralPages::addDefine()
sets up the $definesbyfile array using $curfile
addDestination: in file class.pdf.php, method Cpdf::addDestination()
create a labelled destination within the document
addElement: in file ParserData.inc, method parserData::addElement()
add a new element to the tracking array
addElementToPage: in file IntermediateParser.inc, method phpDocumentor_IntermediateParser::addElementToPage()
adds a processed descendant of parserElement to the $pages array or $privatepages array
addError: in file Errors.inc, function addError()
add an Error
addError: in file Errors.inc, method ErrorTracker::addError()
add a new error to the $errors array
addErrorDie: in file Errors.inc, function addErrorDie()
like addError() but exits parsing
addErrorReturn: in file Errors.inc, method ErrorTracker::addErrorReturn()
add a new error to the $errors array and returns the error string
addExample: in file ParserDocBlock.inc, method parserDocBlock::addExample()
adds an @example tag
addFileSource: in file ParserDocBlock.inc, method parserDocBlock::addFileSource()
Adds a new @filesource tag to the DocBlock
addFileSource: in file phpDocumentorTWordParser.inc, method phpDocumentorTWordParser::addFileSource()
Wrapper for addSource() used to retrieve the entire source code organized by line number in setup()
addFuncGlobal: in file ParserDocBlock.inc, method parserDocBlock::addFuncGlobal()
adds a function declaration of @global to the $funcglobals array
addFunction: in file ProceduralPages.inc, method ProceduralPages::addFunction()
sets up the $functionsbyfile array using $curfile
addGlobal: in file ProceduralPages.inc, method ProceduralPages::addGlobal()
sets up the $globalsbyfile array using $curfile
addGlobals: in file ParserElements.inc, method parserFunction::addGlobals()
Add all "global $var, $var2" declarations to this function
addHHP: in file CHMdefaultConverter.inc, method CHMdefaultConverter::addHHP()
addImage: in file class.pdf.php, method Cpdf::addImage()
add an image into the document, from a GD object
addImplements: in file ParserElements.inc, method parserClass::addImplements()
addInclude: in file ProceduralPages.inc, method ProceduralPages::addInclude()
sets up the $includesbyfile array using $curfile
addInfo: in file class.pdf.php, method Cpdf::addInfo()
add content to the documents info object
addInternalLink: in file class.pdf.php, method Cpdf::addInternalLink()
add a link in the document to an internal destination (ie. within the document)
addItem: in file TreeMenu.php, method HTML_TreeMenu::addItem()
This function adds an item to the the tree.
addItem: in file DescHTML.inc, method parserList::addItem()
add an item to a list
addItem: in file TreeMenu.php, method HTML_TreeNode::addItem()
Adds a new subnode to this node.
addJpegFromFile: in file class.pdf.php, method Cpdf::addJpegFromFile()
add a JPEG image into the document, from a file
addKeyword: in file ParserDocBlock.inc, method parserDocBlock::addKeyword()
addKLink: in file CHMdefaultConverter.inc, method CHMdefaultConverter::addKLink()
Add an item to the index.hhk file
addLink: in file ParserDocBlock.inc, method parserDocBlock::addLink()
creates a parserLinkTag and adds it to the $tags array
addLink: in file LinkClasses.inc, method tutorialLink::addLink()
sets up the link
addLink: in file LinkClasses.inc, method abstractLink::addLink()
sets up the link
addLink: in file ParserData.inc, method parserData::addLink()
adds a link
addLink: in file LinkClasses.inc, method methodLink::addLink()
sets up the link
addLink: in file class.pdf.php, method Cpdf::addLink()
add a link in the document to an external URL
addList: in file DescHTML.inc, method parserList::addList()
add a list
addMessage: in file class.pdf.php, method Cpdf::addMessage()
used to add messages for use in debugging
addMessage: in file class.phpdocpdf.php, method phpdocpdf::addMessage()
addMethod: in file Classes.inc, method Classes::addMethod()
While parsing, add a method to the list of parsed methods
addName: in file ParserDocBlock.inc, method parserDocBlock::addName()
Adds a @name tag to the tag list
addObject: in file class.pdf.php, method Cpdf::addObject()
after an object has been created, it wil only show if it has been added, using this function.
addPackage: in file ParserDocBlock.inc, method parserDocBlock::addPackage()
addPackageParent: in file IntermediateParser.inc, method phpDocumentor_IntermediateParser::addPackageParent()
If the parent class of $class is in a different package, adds it to the
addPackageToFile: in file Classes.inc, method Classes::addPackageToFile()
Mark a package as being used in a class
addPage: in file ProceduralPages.inc, method ProceduralPages::addPage()
sets up the $pages array
addPage: in file IntermediateParser.inc, method phpDocumentor_IntermediateParser::addPage()
Replaces the parserPage represented by $this->pages[$path] with $page
addPageIfNecessary: in file IntermediateParser.inc, method phpDocumentor_IntermediateParser::addPageIfNecessary()
add a new parserPage to the $pages array if none is found
addPagePackage: in file ProceduralPages.inc, method ProceduralPages::addPagePackage()
Changes the package of the page represented by $path
addParam: in file ParserElements.inc, method parserMethod::addParam()
addParam: in file ParserElements.inc, method parserFunction::addParam()
addParam: in file ParserDocBlock.inc, method parserDocBlock::addParam()
addPngFromFile: in file class.pdf.php, method Cpdf::addPngFromFile()
add a PNG image into the document, from a file
addPrivatePage: in file IntermediateParser.inc, method phpDocumentor_IntermediateParser::addPrivatePage()
Adds a parserPage element to the parserData element in $this->privatepages[$path]
addProperty: in file ParserDocBlock.inc, method parserDocBlock::addProperty()
Adds a @property(-read or -write) or @method magic tag to the DocBlock
addReturn: in file ParserDocBlock.inc, method parserDocBlock::addReturn()
creates a parserReturnTag and adds it to the $tags array
addSee: in file ParserDocBlock.inc, method parserDocBlock::addSee()
creates a parserLinkTag and adds it to the $tags array
addSource: in file ParserElements.inc, method parserFunction::addSource()
Set the source code. Always array in PHP 4.3.0+
addSource: in file phpDocumentorTWordParser.inc, method phpDocumentorTWordParser::addSource()
Generate source token arrays organized by line number
addSourceTOC: in file CHMdefaultConverter.inc, method CHMdefaultConverter::addSourceTOC()
addStatics: in file ParserElements.inc, method parserFunction::addStatics()
Add all "static $var, $var2 = 6" declarations to this function
addStaticVar: in file ParserDocBlock.inc, method parserDocBlock::addStaticVar()
addSummaryToPackageXml: in file XMLDocBookpeardoc2Converter.inc, method XMLDocBookpeardoc2Converter::addSummaryToPackageXml()
addTag: in file ParserDocBlock.inc, method parserDocBlock::addTag()
Used to insert DocBlock Template tags into a docblock
addText: in file class.pdf.php, method Cpdf::addText()
add text to the document, at a specified location, size and angle on the page
addTextWrap: in file class.pdf.php, method Cpdf::addTextWrap()
add text to the page, but ensure that it fits within a certain width if it does not fit then put in as much as possible, splitting at word boundaries and return the remainder.
addTOC: in file CHMdefaultConverter.inc, method CHMdefaultConverter::addTOC()
addTutorial: in file ParserElements.inc, method parserClass::addTutorial()
addTutorial: in file ParserData.inc, method parserData::addTutorial()
adds a tutorial parser
addUnknownTag: in file ParserDocBlock.inc, method parserDocBlock::addUnknownTag()
adds an unknown tag to the $unknown_tags array for use by custom converters
addUses: in file IntermediateParser.inc, method phpDocumentor_IntermediateParser::addUses()
Add all the @uses tags from $element to the $uses array so that @usedby
addUses: in file ParserDocBlock.inc, method parserDocBlock::addUses()
Add a @uses tag to the DocBlock
addVar: in file ParserDocBlock.inc, method parserDocBlock::addVar()
creates a parserVarTag and adds it to the $tags array
addVar: in file Classes.inc, method Classes::addVar()
While parsing, add a variable to the list of parsed variables
addWarning: in file Errors.inc, method ErrorTracker::addWarning()
add a new warning to the $warnings array
addWarning: in file Errors.inc, function addWarning()
add a Warning
adv_htmlentities: in file Converter.inc, function adv_htmlentities()
smart htmlentities, doesn't entity the allowed tags list
alink: in file class.ezpdf.php, method Cezpdf::alink()
append: in file Smarty.class.php, method Smarty::append()
appends values to template variables
append_by_ref: in file Smarty.class.php, method Smarty::append_by_ref()
appends values to template variables by reference
ARC4: in file class.pdf.php, method Cpdf::ARC4()
ARC4 encrypt a text string
ARC4_init: in file class.pdf.php, method Cpdf::ARC4_init()
initialize the ARC4 encryption
arrayConvert: in file InlineTags.inc, method parserSourceInlineTag::arrayConvert()
converter helper used in PHP 4.3.0+
arrayConvert: in file InlineTags.inc, method parserExampleInlineTag::arrayConvert()
converter helper for PHP 4.3.0+
assign: in file Smarty.class.php, method Smarty::assign()
assigns values to template variables
assign_by_ref: in file Smarty.class.php, method Smarty::assign_by_ref()
assigns values to template variables by reference
AttrToString: in file Converter.inc, method Converter::AttrToString()
Convert the attribute of a Tutorial docbook tag's attribute list

[Top]

b

$base_dir: in file XMLDocBookConverter.inc, variable XMLDocBookConverter::$base_dir
target directory passed on the command-line.
$base_dir: in file CHMdefaultConverter.inc, variable CHMdefaultConverter::$base_dir
target directory passed on the command-line.
$base_dir: in file XMLDocBookpeardoc2Converter.inc, variable XMLDocBookpeardoc2Converter::$base_dir
target directory passed on the command-line.
$base_dir: in file HTMLSmartyConverter.inc, variable HTMLSmartyConverter::$base_dir
target directory passed on the command-line.
$base_dir: in file HTMLframesConverter.inc, variable HTMLframesConverter::$base_dir
target directory passed on the command-line.
$booleanize: in file Config_File.class.php, variable Config_File::$booleanize
Controls whether config values of on/true/yes and off/false/no get converted to boolean values automatically.
backupPos: in file phpDocumentorTWordParser.inc, method phpDocumentorTWordParser::backupPos()
backs the parser up to the previous position
backupPos: in file HighlightParser.inc, method phpDocumentor_HighlightWordParser::backupPos()
back the word parser to the previous token as defined by $last_token
backupPos: in file WordParser.inc, method WordParser::backupPos()
Backup to the previous token so that it can be retrieved again in a new context.
Bolden: in file Converter.inc, method Converter::Bolden()
Used to convert the contents of <b> in a docblock
Br: in file XMLDocBookpeardoc2Converter.inc, method XMLDocBookpeardoc2Converter::Br()
Br: in file Converter.inc, method Converter::Br()
Used to convert <br> in a docblock
bullet: in file class.phpdocpdf.php, method phpdocpdf::bullet()
Beautifier.php: procedural page Beautifier.php
block.strip.php: procedural page block.strip.php
block.textformat.php: procedural page block.textformat.php

[Top]

c

$cache_dir: in file Smarty.class.php, variable Smarty::$cache_dir
The name of the directory for cache files.
$cache_handler_func: in file Smarty.class.php, variable Smarty::$cache_handler_func
The function used for cache file handling. If not set, built-in caching is used.
$cache_lifetime: in file Smarty.class.php, variable Smarty::$cache_lifetime
This is the number of seconds cached content will persist.
$cache_modified_check: in file Smarty.class.php, variable Smarty::$cache_modified_check
Only used when $caching is enabled. If true, then If-Modified-Since headers are respected with cached content, and appropriate HTTP headers are sent.
$caching: in file Smarty.class.php, variable Smarty::$caching
This enables template caching.
$callback: in file class.pdf.php, variable Cpdf::$callback
array which forms a stack to keep track of nested callback functions
$catalogId: in file class.pdf.php, variable Cpdf::$catalogId
the objectId (number within the objects array) of the document catalog
$category: in file XMLDocBookConverter.inc, variable XMLDocBookConverter::$category
peardoc2 Category
$category: in file LinkClasses.inc, variable abstractLink::$category
$category: in file XMLDocBookpeardoc2Converter.inc, variable XMLDocBookpeardoc2Converter::$category
peardoc2 Category
$category: in file ParserData.inc, variable parserPage::$category
$category: in file InlineTags.inc, variable parserIdInlineTag::$category
category of the {@id}
$category: in file ParserDocBlock.inc, variable parserDocBlock::$category
$checkpoint: in file class.pdf.php, variable Cpdf::$checkpoint
store the stack for the transaction commands, each item in here is a record of the values of all the variables within the class, so that the user can rollback at will (from each 'start' command) note that this includes the objects array, so these can be large.
$children: in file ParserElements.inc, variable parserTutorial::$children
links to the child tutorials, or false if none
$class: in file XMLDocBookConverter.inc, variable XMLDocBookConverter::$class
name of current class being converted
$class: in file ParserElements.inc, variable parserVar::$class
$class: in file XMLDocBookpeardoc2Converter.inc, variable XMLDocBookpeardoc2Converter::$class
name of current class being converted
$class: in file ParserElements.inc, variable parserConst::$class
$class: in file Converter.inc, variable Converter::$class
set to a classname if currently parsing a class, false if not
$class: in file ParserElements.inc, variable parserMethod::$class
$class: in file LinkClasses.inc, variable methodLink::$class
$classelements: in file ParserData.inc, variable parserData::$classelements
array of parsed class elements
$classes: in file IntermediateParser.inc, variable phpDocumentor_IntermediateParser::$classes
used to keep track of inheritance at the smartest level possible for a
$classes: in file Converter.inc, variable Converter::$classes
All class information, organized by path, and by package
$classpackage_pagenums: in file PDFdefaultConverter.inc, variable PDFdefaultConverter::$classpackage_pagenums
$class_contents: in file Converter.inc, variable Converter::$class_contents
alphabetical index of all methods and vars in a class by package/subpackage
$class_data: in file Converter.inc, variable Converter::$class_data
template for the class currently being processed
$class_data: in file XMLDocBookConverter.inc, variable XMLDocBookConverter::$class_data
template for the class currently being processed
$class_data: in file XMLDocBookpeardoc2Converter.inc, variable XMLDocBookpeardoc2Converter::$class_data
template for the class currently being processed
$class_dir: in file XMLDocBookConverter.inc, variable XMLDocBookConverter::$class_dir
output directory for the current class being processed
$class_dir: in file XMLDocBookpeardoc2Converter.inc, variable XMLDocBookpeardoc2Converter::$class_dir
output directory for the current class being processed
$class_dir: in file HTMLframesConverter.inc, variable HTMLframesConverter::$class_dir
output directory for the current class being processed
$class_dir: in file HTMLSmartyConverter.inc, variable HTMLSmartyConverter::$class_dir
output directory for the current class being processed
$class_dir: in file CHMdefaultConverter.inc, variable CHMdefaultConverter::$class_dir
output directory for the current class being processed
$class_elements: in file Converter.inc, variable Converter::$class_elements
alphabetized index of classes by package
$clean: in file ParserData.inc, variable parserData::$clean
used by phpDocumentor_IntermediateParser::handleDocBlock() to
$compiler_class: in file Smarty.class.php, variable Smarty::$compiler_class
The class used for compiling templates.
$compiler_file: in file Smarty.class.php, variable Smarty::$compiler_file
The file that contains the compiler class. This can a full pathname, or relative to the php_include path.
$compile_check: in file Smarty.class.php, variable Smarty::$compile_check
This tells Smarty whether to check for recompiling or not. Recompiling does not need to happen unless a template or config file is changed.
$compile_dir: in file Smarty.class.php, variable Smarty::$compile_dir
The directory where compiled templates are located.
$compile_id: in file Smarty.class.php, variable Smarty::$compile_id
Set this if you want different sets of compiled files for the same templates. This is useful for things like different languages.
$config_booleanize: in file Smarty.class.php, variable Smarty::$config_booleanize
This tells whether or not to automatically booleanize config file variables.
$config_class: in file Smarty.class.php, variable Smarty::$config_class
The class used to load config vars.
$config_dir: in file Smarty.class.php, variable Smarty::$config_dir
The directory where config files are located.
$config_fix_newlines: in file Smarty.class.php, variable Smarty::$config_fix_newlines
This tells whether or not automatically fix newlines in config files.
$config_overwrite: in file Smarty.class.php, variable Smarty::$config_overwrite
This tells if config file vars of the same name overwrite each other or not.
$config_read_hidden: in file Smarty.class.php, variable Smarty::$config_read_hidden
This tells whether hidden sections [.foobar] are readable from the tempalates or not. Normally you would never allow this since that is the point behind hidden sections: the application can access them, but the templates cannot.
$conflicts: in file ParserElements.inc, variable parserElement::$conflicts
$context: in file XMLpackagePageParser.inc, variable XMLPackagePageParser::$context
$converted_returnType: in file DocBlockTags.inc, variable parserReturnTag::$converted_returnType
contains a link to the documentation for a class passed as a type in @return, @var or @param
$converter: in file class.phpdocpdf.php, variable phpdocpdf::$converter
$converters: in file IntermediateParser.inc, variable phpDocumentor_IntermediateParser::$converters
an array of template names indexed by converter name
$cssClass: in file TreeMenu.php, variable HTML_TreeNode::$cssClass
The css class for this node
$curclasspackage: in file PDFdefaultConverter.inc, variable PDFdefaultConverter::$curclasspackage
$curfile: in file ProceduralPages.inc, variable ProceduralPages::$curfile
file being parsed, used in every add function to match up elements with the file that contains them
$curfile: in file Errors.inc, variable ErrorTracker::$curfile
$curfile: in file ParserElements.inc, variable parserClass::$curfile
$curfile: in file Converter.inc, variable Converter::$curfile
full path of the current file being converted
$curpage: in file Converter.inc, variable Converter::$curpage
current procedural page being processed
$curpagepackage: in file PDFdefaultConverter.inc, variable PDFdefaultConverter::$curpagepackage
$current: in file CHMdefaultConverter.inc, variable CHMdefaultConverter::$current
contains all of the template procedural page element loop data needed for the current template
$current: in file XMLDocBookpeardoc2Converter.inc, variable XMLDocBookpeardoc2Converter::$current
contains all of the template procedural page element loop data needed for the current template
$current: in file XMLDocBookConverter.inc, variable XMLDocBookConverter::$current
contains all of the template procedural page element loop data needed for the current template
$current: in file HTMLframesConverter.inc, variable HTMLframesConverter::$current
contains all of the template procedural page element loop data needed for the current template
$current: in file HTMLSmartyConverter.inc, variable HTMLSmartyConverter::$current
contains all of the template procedural page element loop data needed for the current template
$currentBaseFont: in file class.pdf.php, variable Cpdf::$currentBaseFont
the current base font
$currentclass: in file HTMLSmartyConverter.inc, variable HTMLSmartyConverter::$currentclass
contains all of the template class element loop data needed for the current template
$currentclass: in file XMLDocBookConverter.inc, variable XMLDocBookConverter::$currentclass
contains all of the template class element loop data needed for the current template
$currentclass: in file HTMLframesConverter.inc, variable HTMLframesConverter::$currentclass
contains all of the template class element loop data needed for the current template
$currentclass: in file CHMdefaultConverter.inc, variable CHMdefaultConverter::$currentclass
contains all of the template class element loop data needed for the current template
$currentclass: in file XMLDocBookpeardoc2Converter.inc, variable XMLDocBookpeardoc2Converter::$currentclass
contains all of the template class element loop data needed for the current template
$currentColour: in file class.pdf.php, variable Cpdf::$currentColour
current colour for fill operations, defaults to inactive value, all three components should be between 0 and 1 inclusive when active
$currentContents: in file class.pdf.php, variable Cpdf::$currentContents
object number of the currently active contents block
$currentFont: in file class.pdf.php, variable Cpdf::$currentFont
a record of the current font
$currentFontNum: in file class.pdf.php, variable Cpdf::$currentFontNum
the number of the current font within the font array
$currentLineStyle: in file class.pdf.php, variable Cpdf::$currentLineStyle
current style that lines are drawn in
$currentNode: in file class.pdf.php, variable Cpdf::$currentNode
$currentPage: in file class.pdf.php, variable Cpdf::$currentPage
object number of the current page
$currentStrokeColour: in file class.pdf.php, variable Cpdf::$currentStrokeColour
current colour for stroke operations (lines etc.)
$currentTextState: in file class.pdf.php, variable Cpdf::$currentTextState
track if the current font is bolded or italicised
$cur_class: in file IntermediateParser.inc, variable phpDocumentor_IntermediateParser::$cur_class
Name of the class currently being parsed.
canSource: in file ParserDocBlock.inc, method parserDocBlock::canSource()
Tells the DocBlock it can have a @filesource tag
cantSource: in file ParserDocBlock.inc, method parserDocBlock::cantSource()
Tells the DocBlock it can't have a @filesource tag
categoryTagHandler: in file Parser.inc, method Parser::categoryTagHandler()
handles @category
Cezpdf: in file class.ezpdf.php, method Cezpdf::Cezpdf()
Cezpdf: in file class.ezpdf.php, class Cezpdf
This class will take the basic interaction facilities of the Cpdf class and make more useful functions so that the user does not have to know all the ins and outs of pdf presentation to produce something pretty.
changeGlobal: in file ParserDocBlock.inc, method parserDocBlock::changeGlobal()
changeParam: in file ParserDocBlock.inc, method parserDocBlock::changeParam()
changeStatic: in file ParserDocBlock.inc, method parserDocBlock::changeStatic()
checkAllHere: in file class.pdf.php, method Cpdf::checkAllHere()
should be used for internal checks, not implemented as yet
checkEventPop: in file TutorialHighlightParser.inc, method phpDocumentor_TutorialHighlightParser::checkEventPop()
This function checks whether parameter $word is a token for popping the current event off of the Event Stack.
checkEventPop: in file Tokenizer.php, method phpDocumentor_XML_Beautifier_Tokenizer::checkEventPop()
this function checks whether parameter $word is a token for popping the current event off of the Event Stack.
checkEventPop: in file Parser.inc, method Parser::checkEventPop()
this function checks whether parameter $word is a token for popping the current event off of the Event Stack.
checkEventPush: in file TutorialHighlightParser.inc, method phpDocumentor_TutorialHighlightParser::checkEventPush()
This function checks whether parameter $word is a token for pushing a new event onto the Event Stack.
checkEventPush: in file Parser.inc, method Parser::checkEventPush()
this function checks whether parameter $word is a token for pushing a new event onto the Event Stack.
checkEventPush: in file Tokenizer.php, method phpDocumentor_XML_Beautifier_Tokenizer::checkEventPush()
this function checks whether parameter $word is a token for pushing a new event onto the Event Stack.
checkForBugCondition: in file Setup.inc.php, function checkForBugCondition()
Crash in case of known, dangerous bug condition
checkIgnore: in file Io.inc, method Io::checkIgnore()
Tell whether to ignore a file or a directory allows * and ? wildcards
checkIgnoreTag: in file Setup.inc.php, method phpDocumentor_setup::checkIgnoreTag()
checkState: in file Converter.inc, method Converter::checkState()
Compare parserStringWithInlineTags::Convert() cache state to $state
CHMdefaultConverter: in file CHMdefaultConverter.inc, method CHMdefaultConverter::CHMdefaultConverter()
sets $base_dir to $targetDir
CHMdefaultConverter: in file CHMdefaultConverter.inc, class CHMdefaultConverter
Generates files that MS HTML Help Worshop can use to create a MS Windows compiled help file (CHM)
ClasselementCmp: in file IntermediateParser.inc, method phpDocumentor_IntermediateParser::ClasselementCmp()
does a natural case sort on two class elements (either parserClass, parserMethod or parserVar
Classes: in file Classes.inc, class Classes
Intermediate class parsing structure.
classLink: in file LinkClasses.inc, class classLink
class link
cleanup: in file Converter.inc, method Converter::cleanup()
Finish up parsing/cleanup directories
clear: in file Config_File.class.php, method Config_File::clear()
Clear loaded config data for a certain file or all files.
clear_all_assign: in file Smarty.class.php, method Smarty::clear_all_assign()
clear all the assigned template variables.
clear_all_cache: in file Smarty.class.php, method Smarty::clear_all_cache()
clear the entire contents of cache (all templates)
clear_assign: in file Smarty.class.php, method Smarty::clear_assign()
clear the given assigned template variable.
clear_cache: in file Smarty.class.php, method Smarty::clear_cache()
clear cached content for the given template and cache id
clear_compiled_tpl: in file Smarty.class.php, method Smarty::clear_compiled_tpl()
clears compiled version of specified template resource, or all compiled template files if one is not specified.
clear_config: in file Smarty.class.php, method Smarty::clear_config()
clear configuration values
closeObject: in file class.pdf.php, method Cpdf::closeObject()
close an object
concatTokens: in file phpDocumentorTWordParser.inc, method phpDocumentorTWordParser::concatTokens()
Utility function to convert a series of tokens into a string
configWordParser: in file Parser.inc, method Parser::configWordParser()
tell the parser's WordParser $wp to set up tokens to parse words by.
configWordParser: in file Tokenizer.php, method phpDocumentor_XML_Beautifier_Tokenizer::configWordParser()
tell the parser's WordParser $wp to set up tokens to parse words by.
configWordParser: in file TutorialHighlightParser.inc, method phpDocumentor_TutorialHighlightParser::configWordParser()
Tell the parser's WordParser $wp to set up tokens to parse words by.
configWordParser: in file HighlightParser.inc, method phpDocumentor_HighlightParser::configWordParser()
Give the word parser necessary data to begin a new parse
Config_File: in file Config_File.class.php, class Config_File
Config file reading class
Config_File: in file Config_File.class.php, method Config_File::Config_File()
Constructs a new config file class.
config_load: in file Smarty.class.php, method Smarty::config_load()
load configuration values
constLink: in file LinkClasses.inc, class constLink
class constant link
Convert: in file InlineTags.inc, method parserTocInlineTag::Convert()
converter method
Convert: in file ParserData.inc, method parserStringWithInlineTags::Convert()
Use to convert the string to a real string with all inline tags parsed and linked
Convert: in file IntermediateParser.inc, method phpDocumentor_IntermediateParser::Convert()
Interface to the Converter
Convert: in file PackagePageElements.inc, method parserXMLDocBookTag::Convert()
calls the output conversion
Convert: in file InlineTags.inc, method parserTutorialInlineTag::Convert()
convert part of the tag
Convert: in file PackagePageElements.inc, method parserEntity::Convert()
calls the output conversion
Convert: in file InlineTags.inc, method parserInheritdocInlineTag::Convert()
only sets a warning and returns empty
Convert: in file InlineTags.inc, method parserIdInlineTag::Convert()
converter
Convert: in file ParserElements.inc, method parserPackagePage::Convert()
Convert: in file ParserElements.inc, method parserTutorial::Convert()
Convert: in file PackagePageElements.inc, method parserCData::Convert()
calls the output conversion
Convert: in file InlineTags.inc, method parserLinkInlineTag::Convert()
calls the output conversion
Convert: in file InlineTags.inc, method parserSourceInlineTag::Convert()
convert the tag
Convert: in file DocBlockTags.inc, method parserFileSourceTag::Convert()
Return a link to the highlighted source and generate the source
Convert: in file DocBlockTags.inc, method parserReturnTag::Convert()
process this tag through the given output converter (sets up the $converted_returnType)
Convert: in file DocBlockTags.inc, method parserNameTag::Convert()
process this tag through the given output converter
Convert: in file DocBlockTags.inc, method parserAccessTag::Convert()
process this tag through the given output converter
Convert: in file DocBlockTags.inc, method parserSeeTag::Convert()
process this tag through the given output converter
Convert: in file DocBlockTags.inc, method parserTag::Convert()
Perform the output conversion on this parserTag using the output converter that is passed in
Convert: in file DocBlockTags.inc, method parserUsedByTag::Convert()
process this tag through the given output converter
Convert: in file DocBlockTags.inc, method parserTutorialTag::Convert()
process this tag through the given output converter
Convert: in file DescHTML.inc, method parserPre::Convert()
performs the conversion of code tags
Convert: in file DescHTML.inc, method parserList::Convert()
performs the conversion of list tags
Convert: in file DescHTML.inc, method parserBr::Convert()
performs the conversion of linebreak tags
Convert: in file DescHTML.inc, method parserB::Convert()
performs the conversion of bold tags
Convert: in file Converter.inc, method Converter::Convert()
Convert all elements to output format
Convert: in file DescHTML.inc, method parserCode::Convert()
performs the conversion of code tags
Convert: in file DescHTML.inc, method parserDescVar::Convert()
performs the conversion of variable tags
Convert: in file DescHTML.inc, method parserKbd::Convert()
performs the conversion of keyboard tags
Convert: in file DescHTML.inc, method parserI::Convert()
performs the conversion of italic tags
Convert: in file DocBlockTags.inc, method parserUsesTag::Convert()
Return a link to documentation for other element, and description of how it is used
Convert: in file DescHTML.inc, method parserSamp::Convert()
performs the conversion of sample tags
convertClass: in file CHMdefaultConverter.inc, method CHMdefaultConverter::convertClass()
Converts class for template output
convertClass: in file PDFdefaultConverter.inc, method PDFdefaultConverter::convertClass()
convertClass: in file XMLDocBookpeardoc2Converter.inc, method XMLDocBookpeardoc2Converter::convertClass()
Converts class for template output
convertClass: in file Converter.inc, method Converter::convertClass()
Default Class Handler
convertClass: in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::convertClass()
Converts class for template output
convertClass: in file XMLDocBookConverter.inc, method XMLDocBookConverter::convertClass()
Converts class for template output
convertClass: in file HTMLframesConverter.inc, method HTMLframesConverter::convertClass()
Converts class for template output
convertConst: in file PDFdefaultConverter.inc, method PDFdefaultConverter::convertConst()
convertConst: in file HTMLframesConverter.inc, method HTMLframesConverter::convertConst()
Converts class variables for template output
convertConst: in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::convertConst()
Converts class variables for template output
convertConst: in file Converter.inc, method Converter::convertConst()
Converts class constants for template output.
convertConst: in file CHMdefaultConverter.inc, method CHMdefaultConverter::convertConst()
Converts class constants for template output
convertDefine: in file XMLDocBookConverter.inc, method XMLDocBookConverter::convertDefine()
Converts defines for template output
convertDefine: in file XMLDocBookpeardoc2Converter.inc, method XMLDocBookpeardoc2Converter::convertDefine()
Converts defines for template output
convertDefine: in file Converter.inc, method Converter::convertDefine()
Converts defines for template output
convertDefine: in file PDFdefaultConverter.inc, method PDFdefaultConverter::convertDefine()
convertDefine: in file HTMLframesConverter.inc, method HTMLframesConverter::convertDefine()
Converts defines for template output
convertDefine: in file CHMdefaultConverter.inc, method CHMdefaultConverter::convertDefine()
Converts defines for template output
convertDefine: in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::convertDefine()
Converts defines for template output
convertDocBlock: in file PDFdefaultConverter.inc, method PDFdefaultConverter::convertDocBlock()
Converter: in file Converter.inc, method Converter::Converter()
Initialize Converter data structures
Converter: in file Converter.inc, class Converter
Base class for all output converters.
ConvertErrorLog: in file CHMdefaultConverter.inc, method CHMdefaultConverter::ConvertErrorLog()
Create errors.html template file output
ConvertErrorLog: in file XMLDocBookpeardoc2Converter.inc, method XMLDocBookpeardoc2Converter::ConvertErrorLog()
Create errors.html template file output
ConvertErrorLog: in file Converter.inc, method Converter::ConvertErrorLog()
Convert the phpDocumentor parsing/conversion error log
ConvertErrorLog: in file XMLDocBookConverter.inc, method XMLDocBookConverter::ConvertErrorLog()
Create errors.html template file output
ConvertErrorLog: in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::ConvertErrorLog()
Create errors.html template file output
ConvertErrorLog: in file HTMLframesConverter.inc, method HTMLframesConverter::ConvertErrorLog()
Create errors.html template file output
convertFunction: in file Converter.inc, method Converter::convertFunction()
Converts function for template output
convertFunction: in file CHMdefaultConverter.inc, method CHMdefaultConverter::convertFunction()
Converts function for template output
convertFunction: in file XMLDocBookpeardoc2Converter.inc, method XMLDocBookpeardoc2Converter::convertFunction()
Converts function for template output - does nothing in peardoc2!
convertFunction: in file XMLDocBookConverter.inc, method XMLDocBookConverter::convertFunction()
Converts function for template output
convertFunction: in file PDFdefaultConverter.inc, method PDFdefaultConverter::convertFunction()
convertFunction: in file HTMLframesConverter.inc, method HTMLframesConverter::convertFunction()
Converts function for template output
convertFunction: in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::convertFunction()
Converts function for template output
convertGlobal: in file PDFdefaultConverter.inc, method PDFdefaultConverter::convertGlobal()
convertGlobal: in file XMLDocBookpeardoc2Converter.inc, method XMLDocBookpeardoc2Converter::convertGlobal()
Converts global variables for template output
convertGlobal: in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::convertGlobal()
Converts global variables for template output
convertGlobal: in file HTMLframesConverter.inc, method HTMLframesConverter::convertGlobal()
Converts global variables for template output
convertGlobal: in file CHMdefaultConverter.inc, method CHMdefaultConverter::convertGlobal()
Converts global variables for template output
convertGlobal: in file XMLDocBookConverter.inc, method XMLDocBookConverter::convertGlobal()
Converts global variables for template output
convertGlobal: in file Converter.inc, method Converter::convertGlobal()
Converts global variables for template output
convertInclude: in file PDFdefaultConverter.inc, method PDFdefaultConverter::convertInclude()
convertInclude: in file CHMdefaultConverter.inc, method CHMdefaultConverter::convertInclude()
Converts include elements for template output
convertInclude: in file HTMLframesConverter.inc, method HTMLframesConverter::convertInclude()
Converts include elements for template output
convertInclude: in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::convertInclude()
Converts include elements for template output
convertInclude: in file XMLDocBookConverter.inc, method XMLDocBookConverter::convertInclude()
Converts include elements for template output
convertInclude: in file XMLDocBookpeardoc2Converter.inc, method XMLDocBookpeardoc2Converter::convertInclude()
Converts include elements for template output
convertInclude: in file Converter.inc, method Converter::convertInclude()
Converts includes for template output
convertMethod: in file Converter.inc, method Converter::convertMethod()
Converts method for template output
convertMethod: in file XMLDocBookpeardoc2Converter.inc, method XMLDocBookpeardoc2Converter::convertMethod()
Converts method for template output
convertMethod: in file HTMLframesConverter.inc, method HTMLframesConverter::convertMethod()
Converts class methods for template output
convertMethod: in file PDFdefaultConverter.inc, method PDFdefaultConverter::convertMethod()
convertMethod: in file CHMdefaultConverter.inc, method CHMdefaultConverter::convertMethod()
Converts class methods for template output
convertMethod: in file XMLDocBookConverter.inc, method XMLDocBookConverter::convertMethod()
Converts method for template output
convertMethod: in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::convertMethod()
Converts class methods for template output
convertPackagepage: in file CHMdefaultConverter.inc, method CHMdefaultConverter::convertPackagepage()
Converts package page and sets its package as used in $package_pages
convertPackagepage: in file PDFdefaultConverter.inc, method PDFdefaultConverter::convertPackagepage()
convertPackagePage: in file XMLDocBookpeardoc2Converter.inc, method XMLDocBookpeardoc2Converter::convertPackagePage()
Does nothing - use tutorials for DocBook
convertPackagepage: in file HTMLframesConverter.inc, method HTMLframesConverter::convertPackagepage()
Converts package page and sets its package as used in $package_pages
convertPackagepage: in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::convertPackagepage()
Converts package page and sets its package as used in $package_pages
convertPackagePage: in file XMLDocBookConverter.inc, method XMLDocBookConverter::convertPackagePage()
Converts package page and sets its package as used in $package_pages
convertPage: in file XMLDocBookConverter.inc, method XMLDocBookConverter::convertPage()
converts procedural pages for template output
convertPage: in file XMLDocBookpeardoc2Converter.inc, method XMLDocBookpeardoc2Converter::convertPage()
converts procedural pages for template output
convertPage: in file HTMLframesConverter.inc, method HTMLframesConverter::convertPage()
converts procedural pages for template output
convertPage: in file CHMdefaultConverter.inc, method CHMdefaultConverter::convertPage()
converts procedural pages for template output
convertPage: in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::convertPage()
converts procedural pages for template output
convertPage: in file PDFdefaultConverter.inc, method PDFdefaultConverter::convertPage()
convertPage: in file Converter.inc, method Converter::convertPage()
Default Page Handler
convertParams: in file PDFdefaultConverter.inc, method PDFdefaultConverter::convertParams()
ConvertPart: in file InlineTags.inc, method parserLinkInlineTag::ConvertPart()
convert part of the tag
ConvertSource: in file DocBlockTags.inc, method parserFileSourceTag::ConvertSource()
convert the source code
ConvertSource: in file DocBlockTags.inc, method parserExampleTag::ConvertSource()
convert the source code
ConvertTitle: in file Converter.inc, method Converter::ConvertTitle()
Convert the title of a Tutorial docbook tag section
ConvertTodoList: in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::ConvertTodoList()
ConvertTodoList: in file CHMdefaultConverter.inc, method CHMdefaultConverter::ConvertTodoList()
ConvertTodoList: in file HTMLframesConverter.inc, method HTMLframesConverter::ConvertTodoList()
ConvertTodoList: in file Converter.inc, method Converter::ConvertTodoList()
Convert the list of all @todo tags
convertTutorial: in file CHMdefaultConverter.inc, method CHMdefaultConverter::convertTutorial()
convertTutorial: in file XMLDocBookpeardoc2Converter.inc, method XMLDocBookpeardoc2Converter::convertTutorial()
Convert tutorials for output
convertTutorial: in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::convertTutorial()
convertTutorial: in file Converter.inc, method Converter::convertTutorial()
Default Tutorial Handler
convertTutorial: in file HTMLframesConverter.inc, method HTMLframesConverter::convertTutorial()
convertTutorial: in file XMLDocBookConverter.inc, method XMLDocBookConverter::convertTutorial()
convertTutorial: in file PDFdefaultConverter.inc, method PDFdefaultConverter::convertTutorial()
convertVar: in file HTMLframesConverter.inc, method HTMLframesConverter::convertVar()
Converts class variables for template output
convertVar: in file Converter.inc, method Converter::convertVar()
Converts class variables for template output.
convertVar: in file XMLDocBookpeardoc2Converter.inc, method XMLDocBookpeardoc2Converter::convertVar()
Does nothing in this converter
convertVar: in file XMLDocBookConverter.inc, method XMLDocBookConverter::convertVar()
Converts class variables for template output.
convertVar: in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::convertVar()
Converts class variables for template output
convertVar: in file CHMdefaultConverter.inc, method CHMdefaultConverter::convertVar()
Converts class variables for template output
convertVar: in file PDFdefaultConverter.inc, method PDFdefaultConverter::convertVar()
Convert_RIC: in file Converter.inc, method Converter::Convert_RIC()
Convert README/INSTALL/CHANGELOG file contents to output format
Convert_RIC: in file CHMdefaultConverter.inc, method CHMdefaultConverter::Convert_RIC()
Convert README/INSTALL/CHANGELOG file contents to output format
Convert_RIC: in file PDFdefaultConverter.inc, method PDFdefaultConverter::Convert_RIC()
Convert README/INSTALL/CHANGELOG file contents to output format
Convert_RIC: in file HTMLframesConverter.inc, method HTMLframesConverter::Convert_RIC()
Convert README/INSTALL/CHANGELOG file contents to output format
Convert_RIC: in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::Convert_RIC()
Convert README/INSTALL/CHANGELOG file contents to output format
copyFile: in file Converter.inc, method Converter::copyFile()
Copies a file from the template directory to the target directory
copyMediaRecursively: in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::copyMediaRecursively()
copyMediaRecursively: in file HTMLframesConverter.inc, method HTMLframesConverter::copyMediaRecursively()
copyMediaRecursively: in file CHMdefaultConverter.inc, method CHMdefaultConverter::copyMediaRecursively()
Cpdf: in file class.pdf.php, method Cpdf::Cpdf()
class constructor
Cpdf: in file class.pdf.php, class Cpdf
Cpdf
createDocs: in file Setup.inc.php, method phpDocumentor_setup::createDocs()
createParentDir: in file Converter.inc, method Converter::createParentDir()
Recursively creates all subdirectories that don't exist in the $dir path
curve: in file class.pdf.php, method Cpdf::curve()
draw a bezier curve based on 4 control points
Classes.inc: procedural page Classes.inc
clone.inc.php: procedural page clone.inc.php
clone5.inc.php: procedural page clone5.inc.php
common.inc.php: procedural page common.inc.php
Converter.inc: procedural page Converter.inc
CHMdefaultConverter.inc: procedural page CHMdefaultConverter.inc
class.ezpdf.php: procedural page class.ezpdf.php
class.pdf.php: procedural page class.pdf.php
class.phpdocpdf.php: procedural page class.phpdocpdf.php
Config_File.class.php: procedural page Config_File.class.php
core.assemble_plugin_filepath.php: procedural page core.assemble_plugin_filepath.php
core.assign_smarty_interface.php: procedural page core.assign_smarty_interface.php
core.create_dir_structure.php: procedural page core.create_dir_structure.php
core.display_debug_console.php: procedural page core.display_debug_console.php
core.get_include_path.php: procedural page core.get_include_path.php
core.get_microtime.php: procedural page core.get_microtime.php
core.get_php_resource.php: procedural page core.get_php_resource.php
core.is_secure.php: procedural page core.is_secure.php
core.is_trusted.php: procedural page core.is_trusted.php
core.load_plugins.php: procedural page core.load_plugins.php
core.load_resource_plugin.php: procedural page core.load_resource_plugin.php
core.process_cached_inserts.php: procedural page core.process_cached_inserts.php
core.process_compiled_include.php: procedural page core.process_compiled_include.php
core.read_cache_file.php: procedural page core.read_cache_file.php
core.rmdir.php: procedural page core.rmdir.php
core.rm_auto.php: procedural page core.rm_auto.php
core.run_insert_handler.php: procedural page core.run_insert_handler.php
core.smarty_include_php.php: procedural page core.smarty_include_php.php
core.write_cache_file.php: procedural page core.write_cache_file.php
core.write_compiled_include.php: procedural page core.write_compiled_include.php
core.write_compiled_resource.php: procedural page core.write_compiled_resource.php
core.write_file.php: procedural page core.write_file.php

[Top]

d

$data: in file Errors.inc, variable RecordWarning::$data
error string
$data: in file IntermediateParser.inc, variable phpDocumentor_IntermediateParser::$data
$data contains parsed structures for the current page being parsed
$datatype: in file ParserElements.inc, variable parserGlobal::$datatype
Name of the global's data type
$db_template: in file IntermediateParser.inc, variable phpDocumentor_IntermediateParser::$db_template
$debugging: in file Smarty.class.php, variable Smarty::$debugging
If debugging is enabled, a debug console window will display when the page loads (make sure your browser allows unrequested popup windows)
$debugging_ctrl: in file Smarty.class.php, variable Smarty::$debugging_ctrl
This determines if debugging is enable-able from the browser.
$debug_tpl: in file Smarty.class.php, variable Smarty::$debug_tpl
This is the path to the debug console template. If not set, the default one will be used.
$defaultClass: in file TreeMenu.php, variable HTML_TreeMenu_DHTML::$defaultClass
The default CSS class for the nodes
$default_modifiers: in file Smarty.class.php, variable Smarty::$default_modifiers
This is a list of the modifiers to apply to all template variables.
$default_resource_type: in file Smarty.class.php, variable Smarty::$default_resource_type
This is the resource type to be used when not specified
$default_template_handler_func: in file Smarty.class.php, variable Smarty::$default_template_handler_func
If a template cannot be found, this PHP function will be executed.
$defineconflicts: in file ProceduralPages.inc, variable ProceduralPages::$defineconflicts
Namespace conflicts within all documented packages of functions
$definesbyfile: in file ProceduralPages.inc, variable ProceduralPages::$definesbyfile
array of parsed defines organized by the full path of the file that contains the define.
$definesbynamefile: in file ProceduralPages.inc, variable ProceduralPages::$definesbynamefile
array of file names organized by defines that are in the file.
$define_elements: in file Converter.inc, variable Converter::$define_elements
alphabetized index of defines by package
$desc: in file ParserDocBlock.inc, variable parserDocBlock::$desc
$destinations: in file class.pdf.php, variable Cpdf::$destinations
store label->id pairs for named destinations, these will be used to replace internal links
$dirs: in file Setup.inc.php, variable phpDocumentor_setup::$dirs
contents of --directory commandline
$docblock: in file ParserData.inc, variable parserData::$docblock
DocBlock (parserDocBlock) for this page, or false if not set
$docblock: in file ParserElements.inc, variable parserElement::$docblock
debug: in file common.inc.php, function debug()
Debugging output
decideOnOrOff: in file Setup.inc.php, function decideOnOrOff()
Fuzzy logic to interpret the boolean args' intent
defaultHandler: in file Parser.inc, method ppageParser::defaultHandler()
Handles all non-inline tags
defaultTagHandler: in file Parser.inc, method Parser::defaultTagHandler()
Handles all standard tags that only have a description
defineLink: in file LinkClasses.inc, class defineLink
define link
dirList: in file Io.inc, method Io::dirList()
DIR_SEP: in file Smarty.class.php, constant DIR_SEP
DIR_SEP isn't used anymore, but third party apps might
display: in file Smarty.class.php, method Smarty::display()
executes & displays the template results
displayHelpMsg: in file Io.inc, method Io::displayHelpMsg()
create the help message for display on the command-line
doSimpleList: in file ParserDescCleanup.inc, method parserDescParser::doSimpleList()
Return a simple list, if found
dots: in file class.phpdocpdf.php, method phpdocpdf::dots()
DescHTML.inc: procedural page DescHTML.inc
DocBlockTags.inc: procedural page DocBlockTags.inc

[Top]

e

$elements: in file ParserData.inc, variable parserData::$elements
array of parsed elements
$elements: in file Converter.inc, variable Converter::$elements
alphabetical index of all elements
$encrypted: in file class.pdf.php, variable Cpdf::$encrypted
a flag to say if a document is to be encrypted or not
$encryptionKey: in file class.pdf.php, variable Cpdf::$encryptionKey
the ancryption key for the encryption of all the document content (structure is not encrypted)
$end: in file InlineTags.inc, variable parserSourceInlineTag::$end
Last line to display
$endlinenumber: in file ParserElements.inc, variable parserElement::$endlinenumber
line number on file where this element stops
$endlinenumber: in file ParserDocBlock.inc, variable parserDocBlock::$endlinenumber
Line number in the source on which this docblock ends
$ensureVisible: in file TreeMenu.php, variable HTML_TreeNode::$ensureVisible
Should this node be made visible?
$errors: in file Errors.inc, variable ErrorTracker::$errors
array of RecordErrors
$eventHandlers: in file XMLpackagePageParser.inc, variable XMLPackagePageParser::$eventHandlers
$eventHandlers: in file phpDocumentorTParser.inc, variable phpDocumentorTParser::$eventHandlers
$eventHandlers: in file Tokenizer.php, variable phpDocumentor_XML_Beautifier_Tokenizer::$eventHandlers
$events: in file TreeMenu.php, variable HTML_TreeNode::$events
Javascript event handlers;
$event_handlers: in file IntermediateParser.inc, variable phpDocumentor_IntermediateParser::$event_handlers
the functions which handle output from the Parser
$expanded: in file TreeMenu.php, variable HTML_TreeNode::$expanded
Whether this node is expanded or not
$explicitcategory: in file ParserDocBlock.inc, variable parserDocBlock::$explicitcategory
fix for bug 708559
$explicitpackage: in file ParserDocBlock.inc, variable parserDocBlock::$explicitpackage
fix for bug 591396
$extends: in file ParserElements.inc, variable parserClass::$extends
$ez: in file class.ezpdf.php, variable Cezpdf::$ez
$ezPageCount: in file class.ezpdf.php, variable Cezpdf::$ezPageCount
$ezPages: in file class.ezpdf.php, variable Cezpdf::$ezPages
elementCmp: in file IntermediateParser.inc, method phpDocumentor_IntermediateParser::elementCmp()
does a natural case sort on two parserElement descendants
ellipse: in file class.pdf.php, method Cpdf::ellipse()
draw an ellipse note that the part and filled ellipse are just special cases of this function
EncloseList: in file Converter.inc, method Converter::EncloseList()
Used to convert the contents of <ol> or <ul> in a docblock
EncloseParagraph: in file Converter.inc, method Converter::EncloseParagraph()
Used to enclose a paragraph in a docblock
encryptInit: in file class.pdf.php, method Cpdf::encryptInit()
initialize the encryption for processing a particular object
endCData: in file PackagePageElements.inc, method parserXMLDocBookTag::endCData()
Adds $_cdata to $value
endClass: in file Converter.inc, method Converter::endClass()
Called by walk() while converting, when the last class element has been parsed.
endClass: in file HTMLframesConverter.inc, method HTMLframesConverter::endClass()
Writes out the template file of $class_data and unsets the template to save memory
endClass: in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::endClass()
Writes out the template file of $class_data and unsets the template to save memory
endClass: in file CHMdefaultConverter.inc, method CHMdefaultConverter::endClass()
Writes out the template file of $class_data and unsets the template to save memory
endClass: in file XMLDocBookpeardoc2Converter.inc, method XMLDocBookpeardoc2Converter::endClass()
Writes out the template file of $class_data and unsets the template to save memory
endClass: in file XMLDocBookConverter.inc, method XMLDocBookConverter::endClass()
Writes out the template file of $class_data and unsets the template to save memory
endPage: in file XMLDocBookConverter.inc, method XMLDocBookConverter::endPage()
Writes out the template file of $page_data and unsets the template to save memory
endPage: in file CHMdefaultConverter.inc, method CHMdefaultConverter::endPage()
Writes out the template file of $page_data and unsets the template to save memory
endPage: in file HTMLframesConverter.inc, method HTMLframesConverter::endPage()
Writes out the template file of $page_data and unsets the template to save memory
endPage: in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::endPage()
Writes out the template file of $page_data and unsets the template to save memory
endPage: in file Converter.inc, method Converter::endPage()
Called by walk() while converting, when the last procedural page element has been parsed.
endTag: in file Parser.inc, method Parser::endTag()
Called to clean up at the end of parsing a @tag in a docblock
ErrorTracker: in file Errors.inc, class ErrorTracker
contains all the errors/warnings
EventStack: in file EventStack.inc, class EventStack
An event Stack
exampleProgramExample: in file XMLDocBookpeardoc2Converter.inc, method XMLDocBookpeardoc2Converter::exampleProgramExample()
Used to convert the {@example} inline tag in a docblock.
exampleProgramExample: in file Converter.inc, method Converter::exampleProgramExample()
Used to convert the {@example} inline tag in a docblock.
exampleTagHandler: in file Parser.inc, method Parser::exampleTagHandler()
handles @example
execTemplate: in file class.ezpdf.php, method Cezpdf::execTemplate()
explicitDocBlock: in file ParserData.inc, method parserData::explicitDocBlock()
Tells this page that its DocBlock was not implicit
ezColumnsStart: in file class.ezpdf.php, method Cezpdf::ezColumnsStart()
ezColumnsStop: in file class.ezpdf.php, method Cezpdf::ezColumnsStop()
ezGetCurrentPageNumber: in file class.ezpdf.php, method Cezpdf::ezGetCurrentPageNumber()
ezImage: in file class.ezpdf.php, method Cezpdf::ezImage()
ezInsertMode: in file class.ezpdf.php, method Cezpdf::ezInsertMode()
ezNewPage: in file class.ezpdf.php, method Cezpdf::ezNewPage()
ezNewPage: in file class.phpdocpdf.php, method phpdocpdf::ezNewPage()
ezOutput: in file class.phpdocpdf.php, method phpdocpdf::ezOutput()
ezOutput: in file class.ezpdf.php, method Cezpdf::ezOutput()
ezProcessText: in file class.phpdocpdf.php, method phpdocpdf::ezProcessText()
ezProcessText: in file class.ezpdf.php, method Cezpdf::ezProcessText()
ezPRVTaddPageNumbers: in file class.ezpdf.php, method Cezpdf::ezPRVTaddPageNumbers()
ezPRVTcleanUp: in file class.ezpdf.php, method Cezpdf::ezPRVTcleanUp()
ezPrvtGetTextWidth: in file class.ezpdf.php, method Cezpdf::ezPrvtGetTextWidth()
ezPRVTpageNumberSearch: in file class.ezpdf.php, method Cezpdf::ezPRVTpageNumberSearch()
ezPrvtTableColumnHeadings: in file class.ezpdf.php, method Cezpdf::ezPrvtTableColumnHeading