[ 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 ]
[ _ ]
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
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
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.
in file create_examples.php, global variable $base_package default package name, used to change all non-included files to this package
$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.
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
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 Converter.inc, variable Converter::$class set to a classname if currently parsing a class, false if not
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.
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
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
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 XMLDocBookConverter.inc, variable XMLDocBookConverter::$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
$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
in file HTMLSmartyConverter.inc, variable HTMLSmartyConverter::$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 HTMLframesConverter.inc, variable HTMLframesConverter::$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 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
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.
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.
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.
in file Converter.inc, method Converter::checkState() Compare parserStringWithInlineTags::Convert() cache state to $state
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)
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.
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.
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.
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
in file class.pdf.php, variable Cpdf::$firstPageId the objectId of the first page of the document
$fix_newlines
in file Config_File.class.php, variable Config_File::$fix_newlines Controls whether or not to fix mac or dos formatted newlines.
$fontFamilies
in file class.pdf.php, variable Cpdf::$fontFamilies store the information about the relationship between font families this used so that the code knows which font is the bold version of another font, etc.
$fonts
in file class.pdf.php, variable Cpdf::$fonts array carrying information about the fonts that the system currently knows about
in file ProceduralPages.inc, variable ProceduralPages::$functionsbyfile array of parsed functions organized by the full path of the file that contains the function.
in file class.pdf.php, method Cpdf::filledRectangle() a filled rectangle, note that it is the width and height of the rectangle which are the secondary paramaters, not
findGlobal
in file phpDocumentorTWordParser.inc, method phpDocumentorTWordParser::findGlobal() Tell the phpDocumentorTWordParser to return the entire global variable if it is found.
in file HTMLframesConverter.inc, method HTMLframesConverter::formatIndex() HTMLdefaultConverter uses this function to format template index.html and packages.html
formatIndex
in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::formatIndex() HTMLdefaultConverter uses this function to format template index.html and packages.html
in file CHMdefaultConverter.inc, method CHMdefaultConverter::formatIndex() CHMdefaultConverter uses this function to format template index.html and packages.html
formatIndex
in file XMLDocBookConverter.inc, method XMLDocBookConverter::formatIndex() HTMLdefaultConverter uses this function to format template index.html and packages.html
in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::formatPkgIndex() HTMLdefaultConverter chooses to format both package indexes and the complete index here
in file HTMLframesConverter.inc, method HTMLframesConverter::formatPkgIndex() HTMLdefaultConverter chooses to format both package indexes and the complete index here
formatPkgIndex
in file XMLDocBookConverter.inc, method XMLDocBookConverter::formatPkgIndex() HTMLdefaultConverter chooses to format both package indexes and the complete index here
formatPkgIndex
in file CHMdefaultConverter.inc, method CHMdefaultConverter::formatPkgIndex() CHMdefaultConverter chooses to format both package indexes and the complete index here
in file ProceduralPages.inc, variable ProceduralPages::$globalconflicts Namespace conflicts within all documented packages of functions
$globals
in file ParserElements.inc, variable parserFunction::$globals global declarations parsed from function definition
$globalsbyfile
in file ProceduralPages.inc, variable ProceduralPages::$globalsbyfile array of parsed global variables organized by the full path of the file that contains the global variable definition.
$globalsbynamefile
in file ProceduralPages.inc, variable ProceduralPages::$globalsbynamefile array of file names organized by global variables that are in the file.
$global_assign
in file Smarty.class.php, variable Smarty::$global_assign These are the variables from the globals array that are assigned to all templates automatically. This isn't really necessary any more, you can use the $smarty var to access them directly.
$global_elements
in file Converter.inc, variable Converter::$global_elements alphabetized index of global variables by package
in file Converter.inc, method Converter::generateFormattedClassTree() returns an array containing the class inheritance tree from the root object to the class.
in file class.phpdocpdf.php, method phpdocpdf::getColor() This really should be in the parent class
getConflicts
in file ParserElements.inc, method parserGlobal::getConflicts() Returns all global variables in other packages that have the same name as this global variable
getConflicts
in file Classes.inc, method Classes::getConflicts() If a package contains two classes with the same name, this function finds that conflict
getConflicts
in file ParserElements.inc, method parserClass::getConflicts() Returns all classes in other packages that have the same name as this class
getConflicts
in file ParserElements.inc, method parserDefine::getConflicts() Returns all defines in other packages that have the same name as this define
getConflicts
in file ParserElements.inc, method parserFunction::getConflicts() Returns all functions in other packages that have the same name as this function
in file class.pdf.php, method Cpdf::getFirstPageId() function for the user to find out what the ID is of the first page that was created during startup - useful if they wish to add something to it later.
getFontDecender
in file class.pdf.php, method Cpdf::getFontDecender() return the font decender, this will normally return a negative number
getFontHeight
in file class.pdf.php, method Cpdf::getFontHeight() return the height in units of the current font in the given size
in file Converter.inc, method Converter::getFormattedImplements() returns an array containing the class inheritance tree from the root object to the class.
in file DocBlockTags.inc, method parserAccessTag::getString() No inline tags are possible, returns 'public', 'protected' or 'private'
getString
in file ParserData.inc, method parserStringWithInlineTags::getString() return the string unconverted (all inline tags are taken out - this should only be used in pre-parsing to see if any other text is in the string)
in file class.pdf.php, method Cpdf::getTextWidth() calculate how wide a given text string will be on a page, at a given size.
getTitle
in file ParserElements.inc, method parserTutorial::getTitle() Retrieve the title of the tutorial, or of any subsection
getTitle
in file PackagePageElements.inc, method parserXMLDocBookTag::getTitle() Retrieve Converter-specific formatting of the title of this element
getTOC
in file PackagePageElements.inc, method parserXMLDocBookTag::getTOC() Retrieve either the table of contents index, or the location that the TOC will go
getTutorial
in file ParserData.inc, method parserData::getTutorial() If this file has a tutorial associated with it, returns a link to the tutorial.
getTutorial
in file ParserElements.inc, method parserClass::getTutorial() Get the associated tutorial for this class, if any
in file Errors.inc, method ErrorTracker::handleEvent() This function subscribes to two events in the Parser in order to keep track of line number information and file name.
in file Converter.inc, method Converter::hasSourceCode() Determine whether an element's file has generated source code, used for linking to line numbers of source.
in file Converter.inc, method Converter::highlightDocBlockSource() Used to allow converters to format the source code of DocBlocks the way they'd like.
highlightSource
in file Converter.inc, method Converter::highlightSource() Used to allow converters to format the source code the way they'd like.
highlightTutorialSource
in file Converter.inc, method Converter::highlightTutorialSource() Used to allow converters to format the source code of Tutorial XML the way they'd like.
htmlArraySelect
in file utilities.php, function htmlArraySelect() Returns a select box based on an key,value array where selected is based on key
HTMLframesConverter
in file HTMLframesConverter.inc, class HTMLframesConverter HTML output converter.
in file ParserData.inc, variable parserPage::$id not implemented in this version, will be used to link xml output pages
$ignore
in file ParserElements.inc, variable parserClass::$ignore Used to determine whether a class should be ignored or not. Helps maintain integrity of parsing
$ignore
in file add_cvs.php, global variable $ignore Comma-separated list of files and directories to ignore
$ignore
in file Io.inc, variable Io::$ignore Format: array(array(regexp-ready string to search for whole path,
in file ProceduralPages.inc, variable ProceduralPages::$includesbyfile array of parsed includes organized by the full path of the file that contains the include.
in file TreeMenu.php, variable HTML_TreeMenu_DHTML::$isDynamic Dynamic status of the treemenu. If true (default) this has no effect. If false it will override all dynamic status vars and set the menu to be fully expanded an non-dynamic.
$isvalid
in file DocBlockTags.inc, variable parserAccessTag::$isvalid set to true if the returned tag has a value type of private, protected
in file XMLDocBookConverter.inc, variable XMLDocBookConverter::$local whether a @see is going to be in the $base_dir, or in a package/subpackage subdirectory of $base_dir
$local
in file XMLDocBookpeardoc2Converter.inc, variable XMLDocBookpeardoc2Converter::$local whether a @see is going to be in the $base_dir, or in a package/subpackage subdirectory of $base_dir
$looseObjects
in file class.pdf.php, variable Cpdf::$looseObjects an array which contains information about the objects which are not firmly attached to pages
line
in file class.pdf.php, method Cpdf::line() draw a line from one set of coordinates to another
in file class.pdf.php, variable Cpdf::$messages messages are stored here during processing, these can be selected afterwards to give some useful debug information
in file ParserDescCleanup.inc, class ObjectWordParser Like WordParser but designed to handle an array with strings and
openHere
in file class.pdf.php, method Cpdf::openHere() specify where the document should open when it first starts
openObject
in file class.pdf.php, method Cpdf::openObject() make a loose object, the output will go into this object, until it is closed, then will revert to the current one.
in file class.pdf.php, method Cpdf::output() return the pdf stream as a string returned from the function
Output
in file XMLDocBookpeardoc2Converter.inc, method XMLDocBookpeardoc2Converter::Output() Generate the constants.xml, packagename.xml, and globals.xml files
Output
in file CHMdefaultConverter.inc, method CHMdefaultConverter::Output() Create the phpdoc.hhp, contents.hhc files needed by MS HTML Help Compiler to create a CHM file
Output
in file XMLDocBookConverter.inc, method XMLDocBookConverter::Output() This function is not used by HTMLdefaultConverter, but is required by Converter
in file XMLDocBookpeardoc2Converter.inc, variable XMLDocBookpeardoc2Converter::$packagexml Contents of the packagename.xml file are stored in this template variable
$package_elements
in file Converter.inc, variable Converter::$package_elements alphabetical index of all elements sorted by package, subpackage, page, and class.
in file XMLDocBookConverter.inc, variable XMLDocBookConverter::$page_data template for the procedural page currently being processed
$page_data
in file Converter.inc, variable Converter::$page_data template for the procedural page currently being processed
$page_dir
in file HTMLSmartyConverter.inc, variable HTMLSmartyConverter::$page_dir output directory for the current procedural page being processed
$page_dir
in file XMLDocBookConverter.inc, variable XMLDocBookConverter::$page_dir output directory for the current procedural page being processed
$page_dir
in file XMLDocBookpeardoc2Converter.inc, variable XMLDocBookpeardoc2Converter::$page_dir output directory for the current procedural page being processed
$page_dir
in file HTMLframesConverter.inc, variable HTMLframesConverter::$page_dir output directory for the current procedural page being processed
$page_dir
in file CHMdefaultConverter.inc, variable CHMdefaultConverter::$page_dir output directory for the current procedural page being processed
$page_elements
in file Converter.inc, variable Converter::$page_elements alphabetized index of procedural pages by package
$params
in file ParserElements.inc, variable parserFunction::$params parameters parsed from function definition.
in file Parser.inc, method Parser::Parser() Set up invariant parsing variables
Parser
in file Parser.inc, class Parser PHP Parser for PHP 4.2.3-
parserAccessTag
in file DocBlockTags.inc, class parserAccessTag This class represents the @access tag
parserAccessTag
in file DocBlockTags.inc, method parserAccessTag::parserAccessTag() checks $value to make sure it is private, protected or public, otherwise it's not a valid @access tag
parserB
in file DescHTML.inc, class parserB Used for <b> in a description
parserBase
in file ParserData.inc, class parserBase Base class for all elements
parserBr
in file DescHTML.inc, class parserBr Used for <br> in a description
parserCData
in file PackagePageElements.inc, class parserCData Represents <![CDATA[ ]]> sections.
in file InlineTags.inc, class parserInheritdocInlineTag Represents the inheritdoc inline tag, used by classes/methods/vars to inherit documentation from the parent class if possible
in file DocBlockTags.inc, class parserStaticvarTag represents the "@staticvar" tag
parserStringWithInlineTags
in file ParserData.inc, class parserStringWithInlineTags Used to represent strings that contain inline tags, so that they can be properly parsed at link time
parserTag
in file DocBlockTags.inc, class parserTag used to represent standard tags like @access, etc.
in file Parser.inc, constant PARSER_EVENT_DESC used when parsing the desc part of a docblock
PARSER_EVENT_DOCBLOCK
in file Parser.inc, constant PARSER_EVENT_DOCBLOCK used when a DocBlock is encountered in parsing
PARSER_EVENT_DOCBLOCK_TEMPLATE
in file Parser.inc, constant PARSER_EVENT_DOCBLOCK_TEMPLATE used when encountering a /**#@+ comment marking a new docblock template
PARSER_EVENT_DOCKEYWORD
in file Parser.inc, constant PARSER_EVENT_DOCKEYWORD used when a @tag is encountered in DocBlock parsing
PARSER_EVENT_DOCKEYWORD_EMAIL
in file Parser.inc, constant PARSER_EVENT_DOCKEYWORD_EMAIL used when a <email@address> is encountered in parsing an @author tag
PARSER_EVENT_END_DOCBLOCK_TEMPLATE
in file Parser.inc, constant PARSER_EVENT_END_DOCBLOCK_TEMPLATE used when encountering a /**#@-* / comment (no space) marking the end of using a docblock template
in file Parser.inc, constant PARSER_EVENT_FUNC_GLOBAL used when parsing a "global $var1, $var2;" declaration in a function
PARSER_EVENT_GLOBAL_VALUE
in file Parser.inc, constant PARSER_EVENT_GLOBAL_VALUE used when parsing the default value in a global variable declaration
PARSER_EVENT_IMPLEMENTS
in file Parser.inc, constant PARSER_EVENT_IMPLEMENTS used when a class implements interfaces
PARSER_EVENT_INCLUDE
in file Parser.inc, constant PARSER_EVENT_INCLUDE used when an include/require/include_once/include_once statement is encountered in parsing
PARSER_EVENT_INCLUDE_PARAMS
in file Parser.inc, constant PARSER_EVENT_INCLUDE_PARAMS used when an opening parenthesis of an include/require/include_once/include_once statement is encountered in parsing
PARSER_EVENT_INCLUDE_PARAMS_PARENTHESIS
in file Parser.inc, constant PARSER_EVENT_INCLUDE_PARAMS_PARENTHESIS used when an inner ( ) is encountered while parsing an include/require/include_once/include_once statement
PARSER_EVENT_INLINE_DOCKEYWORD
in file Parser.inc, constant PARSER_EVENT_INLINE_DOCKEYWORD used when an inline {@tag} is encountered in parsing a DocBlock
PARSER_EVENT_LOGICBLOCK
in file Parser.inc, constant PARSER_EVENT_LOGICBLOCK { encountered in parsing a function or php code
PARSER_EVENT_METHOD
in file Parser.inc, constant PARSER_EVENT_METHOD used by the HighlightParser only, when a method starts
PARSER_EVENT_METHOD_LOGICBLOCK
in file Parser.inc, constant PARSER_EVENT_METHOD_LOGICBLOCK used by the HighlightParser only, when a method body is parsed
PARSER_EVENT_NOEVENTS
in file Parser.inc, constant PARSER_EVENT_NOEVENTS used for the beginning of parsing, before first < ? php encountered
PARSER_EVENT_OUTPHP
in file Parser.inc, constant PARSER_EVENT_OUTPHP used when a ? > (with no space) is encountered in parsing
PARSER_EVENT_PHPCODE
in file Parser.inc, constant PARSER_EVENT_PHPCODE used when php code processor instruction (< ? php) is encountered in parsing
PARSER_EVENT_QUOTE
in file Parser.inc, constant PARSER_EVENT_QUOTE used when double quotation mark (") encountered in parsing
PARSER_EVENT_QUOTE_VAR
in file Parser.inc, constant PARSER_EVENT_QUOTE_VAR used by the HighlightParser only, when {$var} is encountered in a string
PARSER_EVENT_SINGLEQUOTE
in file Parser.inc, constant PARSER_EVENT_SINGLEQUOTE used when a single quote (') is encountered in parsing
PARSER_EVENT_STATIC_VAR
in file Parser.inc, constant PARSER_EVENT_STATIC_VAR used when parsing a "static $var1, $var2;" declaration in a function
PARSER_EVENT_STATIC_VAR_VALUE
in file Parser.inc, constant PARSER_EVENT_STATIC_VAR_VALUE used when parsing the value in a "static $var1 = x" declaration in a function
PARSER_EVENT_TAGS
in file Parser.inc, constant PARSER_EVENT_TAGS used when parsing the @tag block of a docblock
PARSER_EVENT_VAR
in file Parser.inc, constant PARSER_EVENT_VAR used when a var statement is encountered in parsing a class definition
PARSER_EVENT_VAR_ARRAY
in file Parser.inc, constant PARSER_EVENT_VAR_ARRAY used when a variable value is an array
in file Errors.inc, constant PDERROR_DOCBLOCK_CONFLICT warning triggered by a page-level docblock preceding a source element
PDERROR_DOCBLOCK_GOES_CLASS
in file Errors.inc, constant PDERROR_DOCBLOCK_GOES_CLASS warning triggered when the first docblock in a file with a @package tag precedes a class. In this case, the class gets the docblock.
PDERROR_DUMB_USES
in file Errors.inc, constant PDERROR_DUMB_USES warning triggered by improper "@uses blah"
PDERROR_ELEMENT_IGNORED
in file Errors.inc, constant PDERROR_ELEMENT_IGNORED warning triggered when a duplicate element is encountered that will be
PDERROR_EMPTY_EXAMPLE_TITLE
in file Errors.inc, constant PDERROR_EMPTY_EXAMPLE_TITLE warning triggered by @example path/to/example with no title
PDERROR_EXAMPLE_NOT_FOUND
in file Errors.inc, constant PDERROR_EXAMPLE_NOT_FOUND warning triggered when an example's path from @example /path/to/example.php
in file phpDocumentorTParser.inc, class phpDocumentorTParser Tokenizer-based parser for PHP source code
phpDocumentorTWordParser
in file phpDocumentorTWordParser.inc, class phpDocumentorTWordParser Like WordParser, but expects an array of tokens from the tokenizer instead of a string.
in file Parser.inc, constant PHPDOCUMENTOR_EVENT_END_PAGE used to inform phpDocumentor_IntermediateParser that the current file has been completely parsed.
PHPDOCUMENTOR_EVENT_FUNCTION
in file Parser.inc, constant PHPDOCUMENTOR_EVENT_FUNCTION Function published to IntermediateParser with this event
PHPDOCUMENTOR_EVENT_GLOBAL
in file Parser.inc, constant PHPDOCUMENTOR_EVENT_GLOBAL used when a global variable definition is encountered in the source
PHPDOCUMENTOR_EVENT_INCLUDE
in file Parser.inc, constant PHPDOCUMENTOR_EVENT_INCLUDE Include (include/require/include_once/include_once) published to IntermediateParser with this event
in file Smarty.class.php, variable Smarty::$request_use_auto_globals Indicates wether $HTTP_*_VARS[] (request_use_auto_globals=false)
$request_vars_order
in file Smarty.class.php, variable Smarty::$request_vars_order The order in which request variables are registered, similar to variables_order in php.ini E = Environment, G = GET, P = POST, C = Cookies, S = Server
in file Smarty.class.php, variable Smarty::$right_delimiter The right delimiter used for the template tags.
rcNatCmp
in file HTMLframesConverter.inc, method HTMLframesConverter::rcNatCmp() does a nat case sort on the specified second level value of the array
rcNatCmp
in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::rcNatCmp() does a nat case sort on the specified second level value of the array
rcNatCmp
in file XMLDocBookConverter.inc, method XMLDocBookConverter::rcNatCmp() does a nat case sort on the specified second level value of the array
rcNatCmp
in file CHMdefaultConverter.inc, method CHMdefaultConverter::rcNatCmp() does a nat case sort on the specified second level value of the array
rcNatCmp
in file XMLDocBookpeardoc2Converter.inc, method XMLDocBookpeardoc2Converter::rcNatCmp() does a nat case sort on the specified second level value of the array
rcNatCmp1
in file HTMLframesConverter.inc, method HTMLframesConverter::rcNatCmp1() does a nat case sort on the specified second level value of the array.
rcNatCmp1
in file XMLDocBookConverter.inc, method XMLDocBookConverter::rcNatCmp1() does a nat case sort on the specified second level value of the array.
rcNatCmp1
in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::rcNatCmp1() does a nat case sort on the specified second level value of the array.
rcNatCmp1
in file CHMdefaultConverter.inc, method CHMdefaultConverter::rcNatCmp1() does a nat case sort on the specified second level value of the array.
in file class.pdf.php, method Cpdf::rectangle() draw a rectangle, note that it is the width and height of the rectangle which are the secondary paramaters, not
in file Io.inc, method Io::removeNonMatches() Removes files from the $dir array that do not match the search string in
reopenObject
in file class.pdf.php, method Cpdf::reopenObject() open an existing object for editing
replaceElement
in file ProceduralPages.inc, method ProceduralPages::replaceElement() Used to align an element with the package of its parent page prior to Conversion.
in file Smarty.class.php, variable Smarty::$secure_dir This is the list of template directories that are considered secure. This is used only if $security is enabled. One directory per array element. $template_dir is in this list implicitly.
$security
in file Smarty.class.php, variable Smarty::$security This enables template security. When enabled, many things are restricted
$security_settings
in file Smarty.class.php, variable Smarty::$security_settings These are the security settings for Smarty. They are used only when $security is enabled.
in file Converter.inc, variable Converter::$sort_absolutely_everything This is used if the content must be passed in the order it should be read, i.e. by package, procedural then classes
in file Converter.inc, variable Converter::$sort_page_contents_by_type This determines whether the $page_contents array should be sorted by element type as well as alphabetically by name
in file class.pdf.php, method Cpdf::setEncryption() set the encryption of the document can be used to turn it on and/or set the passwords which it will have.
in file class.pdf.php, method Cpdf::setFontFamily() define font families, this is used to initialize the font families for the default fonts and for the user to add new ones for their fonts. The default bahavious can be overridden should that be desired.
in file class.pdf.php, method Cpdf::setLineStyle() this sets the line drawing style.
setMemoryLimit
in file Setup.inc.php, method phpDocumentor_setup::setMemoryLimit() Allow a memory_limit setting in phpDocumentor.ini to override php.ini or default memory limit
in file ParserData.inc, method parserStringWithInlineTags::setSource() Pass source code to any {@source} tags contained within the string for later conversion.
in file class.pdf.php, method Cpdf::setStrokeColor() sets the colour for stroke operations
setTargetDir
in file HTMLframesConverter.inc, method HTMLframesConverter::setTargetDir() calls the converter setTargetDir, and then copies any template images and the stylesheet if they haven't been copied
in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::setTargetDir() calls the converter setTargetDir, and then copies any template images and the stylesheet if they haven't been copied
setTargetDir
in file XMLDocBookConverter.inc, method XMLDocBookConverter::setTargetDir() calls the converter setTargetDir, and then copies any template images and the stylesheet if they haven't been copied
setTargetDir
in file CHMdefaultConverter.inc, method CHMdefaultConverter::setTargetDir() calls the converter setTargetDir, and then copies any template images and the stylesheet if they haven't been copied
in file ProceduralPages.inc, method ProceduralPages::setupPagePackages() if there is one class package in a file, the parent path inherits the package if its package is default.
setupPages
in file ProceduralPages.inc, method ProceduralPages::setupPages() Adjusts packages of all pages and removes name conflicts within a package
setupStates
in file Parser.inc, method Parser::setupStates() setup the parser tokens, and the pushEvent/popEvent arrays
setupStates
in file ParserDescCleanup.inc, method parserDescParser::setupStates() setup the parser tokens, and the pushEvent/popEvent arrays
in file core.process_compiled_include.php, function smarty_core_process_compiled_include() Replace nocache-tags by results of the corresponding non-cacheable functions and return it
smarty_core_read_cache_file
in file core.read_cache_file.php, function smarty_core_read_cache_file() read a cache file, determine if it needs to be regenerated or not
smarty_core_rmdir
in file core.rmdir.php, function smarty_core_rmdir() delete a dir recursively (level=0 -> keep root) WARNING: no tests, it will try to remove what you tell it!
smarty_core_rm_auto
in file core.rm_auto.php, function smarty_core_rm_auto() delete an automagically created file by name and id
in file core.write_cache_file.php, function smarty_core_write_cache_file() Prepend the cache information to the cache file and write it
smarty_core_write_compiled_include
in file core.write_compiled_include.php, function smarty_core_write_compiled_include() Extract non-cacheable parts out of compiled template and write it
in file shared.make_timestamp.php, function smarty_make_timestamp() Function: smarty_make_timestamp Purpose: used by other smarty functions to make a timestamp from a string.
in file Parser.inc, constant STATE_ACCESS_MODIFIER currently parsing an access modifier
STATE_ARRAY
in file Parser.inc, constant STATE_ARRAY currently parsing an array
STATE_CLASS
in file Parser.inc, constant STATE_CLASS currently parsing a class definition
STATE_CLASS_CONSTANT
in file Parser.inc, constant STATE_CLASS_CONSTANT currently parsing a class constant
STATE_CLASS_MEMBER
in file Parser.inc, constant STATE_CLASS_MEMBER currently parsing a class member using the HighlightParser
STATE_COMMENT
in file Parser.inc, constant STATE_COMMENT currently parsing a short comment //
STATE_COMMENTBLOCK
in file Parser.inc, constant STATE_COMMENTBLOCK currently parsing a long comment /x x/ where x is an asterisk
STATE_DEFINE
in file Parser.inc, constant STATE_DEFINE currently parsing a define statement
STATE_DEFINE_PARAMS
in file Parser.inc, constant STATE_DEFINE_PARAMS currently parsing the stuff in ( ) of a define statement
STATE_DEFINE_PARAMS_PARENTHESIS
in file Parser.inc, constant STATE_DEFINE_PARAMS_PARENTHESIS currently parsing an inner parenthetical statement of a define( )
STATE_DESC
in file Parser.inc, constant STATE_DESC currently parsing the desc part of a docblock
STATE_DOCBLOCK
in file Parser.inc, constant STATE_DOCBLOCK currently parsing a DocBlock
STATE_DOCBLOCK_TEMPLATE
in file Parser.inc, constant STATE_DOCBLOCK_TEMPLATE currently parsing the value in a "static $var1 = x" declaration in a function
STATE_DOCKEYWORD
in file Parser.inc, constant STATE_DOCKEYWORD currently parsing a @tag in a DocBlock
STATE_DOCKEYWORD_EMAIL
in file Parser.inc, constant STATE_DOCKEYWORD_EMAIL currently parsing an email in brackets in an @author tag of a DocBlock
STATE_END_CLASS
in file Parser.inc, constant STATE_END_CLASS used to tell Render that a class has been completely parsed, and to flush buffers
STATE_END_DOCBLOCK_TEMPLATE
in file Parser.inc, constant STATE_END_DOCBLOCK_TEMPLATE currently parsing the value in a "static $var1 = x" declaration in a function
STATE_EOFQUOTE
in file Parser.inc, constant STATE_EOFQUOTE currently parsing a string defined using Perl <<<
STATE_ESCAPE
in file Parser.inc, constant STATE_ESCAPE used when a backslash is encountered in parsing a string or other escapable entity
STATE_FUNCTION
in file Parser.inc, constant STATE_FUNCTION currently parsing a Function or Method
STATE_FUNCTION_PARAMS
in file Parser.inc, constant STATE_FUNCTION_PARAMS currently parsing the stuff in ( ) of a function definition
STATE_FUNCTION_PARAM_VAR
in file Parser.inc, constant STATE_FUNCTION_PARAM_VAR currently parsing a $param in a function definition
STATE_FUNC_GLOBAL
in file Parser.inc, constant STATE_FUNC_GLOBAL currently parsing a "global $var1, $var2;" declaration in a function
STATE_GLOBAL
in file Parser.inc, constant STATE_GLOBAL currently parsing a global variable declaration
STATE_GLOBAL_VALUE
in file Parser.inc, constant STATE_GLOBAL_VALUE currently parsing the default value in a global variable declaration
STATE_IMPLEMENTS
in file Parser.inc, constant STATE_IMPLEMENTS currently parsing an implements clause
STATE_INCLUDE
in file Parser.inc, constant STATE_INCLUDE currently parsing an include/require/include_once/include_once
STATE_INCLUDE_PARAMS
in file Parser.inc, constant STATE_INCLUDE_PARAMS currently parsing the stuff in ( ) of a define statement
STATE_INCLUDE_PARAMS_PARENTHESIS
in file Parser.inc, constant STATE_INCLUDE_PARAMS_PARENTHESIS currently parsing an inner parenthetical statement of an include/includeonce/require/requireonce( )
STATE_INLINE_DOCKEYWORD
in file Parser.inc, constant STATE_INLINE_DOCKEYWORD currently parsing an inline tag like { @link} in a DocBlock
STATE_LOGICBLOCK
in file Parser.inc, constant STATE_LOGICBLOCK currently parsing a { } block
STATE_METHOD
in file Parser.inc, constant STATE_METHOD currently parsing a method using the HighlightParser
STATE_METHOD_LOGICBLOCK
in file Parser.inc, constant STATE_METHOD_LOGICBLOCK currently parsing the method body using the HighlightParser
STATE_NOEVENTS
in file Parser.inc, constant STATE_NOEVENTS out of < ? php tag
STATE_OUTPHP
in file Parser.inc, constant STATE_OUTPHP currently out of php code
STATE_PHPCODE
in file Parser.inc, constant STATE_PHPCODE currently parsing php code
STATE_QUOTE
in file Parser.inc, constant STATE_QUOTE currently parsing a quote
STATE_QUOTE_VAR
in file Parser.inc, constant STATE_QUOTE_VAR currently parsing a {$encapsed_var} using the HighlightParser
STATE_SINGLEQUOTE
in file Parser.inc, constant STATE_SINGLEQUOTE currently parsing a string enclosed in single quotes (')
STATE_STATIC_VAR
in file Parser.inc, constant STATE_STATIC_VAR currently parsing a "static $var1, $var2;" declaration in a function
STATE_STATIC_VAR_VALUE
in file Parser.inc, constant STATE_STATIC_VAR_VALUE currently parsing the value in a "static $var1 = x" declaration in a function
STATE_TAGS
in file Parser.inc, constant STATE_TAGS currently parsing the @tag block of a docblock
STATE_TUTORIAL_ATTRIBUTE
in file TutorialHighlightParser.inc, constant STATE_TUTORIAL_ATTRIBUTE currently parsing an open <tag>
STATE_TUTORIAL_CLOSETAG
in file TutorialHighlightParser.inc, constant STATE_TUTORIAL_CLOSETAG currently parsing a close </tag>
STATE_TUTORIAL_COMMENT
in file TutorialHighlightParser.inc, constant STATE_TUTORIAL_COMMENT currently parsing a <!-- comment -->
STATE_TUTORIAL_DOUBLEQUOTE
in file TutorialHighlightParser.inc, constant STATE_TUTORIAL_DOUBLEQUOTE currently parsing a <!-- comment -->
STATE_TUTORIAL_ENTITY
in file TutorialHighlightParser.inc, constant STATE_TUTORIAL_ENTITY currently parsing an &entity;
STATE_TUTORIAL_ITAG
in file TutorialHighlightParser.inc, constant STATE_TUTORIAL_ITAG currently parsing an {@inline tag}
STATE_TUTORIAL_NOEVENTS
in file TutorialHighlightParser.inc, constant STATE_TUTORIAL_NOEVENTS currently in starting state
STATE_TUTORIAL_OPENTAG
in file TutorialHighlightParser.inc, constant STATE_TUTORIAL_OPENTAG currently parsing an open <tag>
STATE_TUTORIAL_SINGLEQUOTE
in file TutorialHighlightParser.inc, constant STATE_TUTORIAL_SINGLEQUOTE currently parsing a <!-- comment -->
STATE_VAR
in file Parser.inc, constant STATE_VAR currently parsing a Class variable
STATE_VAR_ARRAY
in file Parser.inc, constant STATE_VAR_ARRAY currently parsing a variable value is an array
STATE_VAR_ARRAY_COMMENT
in file Parser.inc, constant STATE_VAR_ARRAY_COMMENT currently parsing a comment in a variable array value
in file Converter.inc, variable Converter::$template_options Options for each template, parsed from the options.ini file in the template base directory
in file ParserElements.inc, variable parserGlobal::$type Type is used by many functions to skip the hassle of if phpDocumentor_get_class($blah) == 'parserBlah'
$type
in file ParserElements.inc, variable parserInclude::$type Type is used by many functions to skip the hassle of if phpDocumentor_get_class($blah) == 'parserBlah'
in file ParserElements.inc, variable parserFunction::$type Type is used by many functions to skip the hassle of if phpDocumentor_get_class($blah) == 'parserBlah'
$type
in file ParserElements.inc, variable parserClass::$type Type is used by many functions to skip the hassle of if phpDocumentor_get_class($blah) == 'parserBlah'
$type
in file ParserElements.inc, variable parserConst::$type Type is used by many functions to skip the hassle of if phpDocumentor_get_class($blah) == 'parserBlah'
$type
in file ParserDocBlock.inc, variable parserDesc::$type Type is used by many functions to skip the hassle of if phpDocumentor_get_class($blah) == 'parserBlah'
$type
in file ParserData.inc, variable parserStringWithInlineTags::$type Type is used by many functions to skip the hassle of if phpDocumentor_get_class($blah) == 'parserBlah'...
$type
in file ParserData.inc, variable parserData::$type Type is used by many functions to skip the hassle of if
$type
in file ParserData.inc, variable parserPage::$type Type is used by many functions to skip the hassle of if
$type
in file ParserData.inc, variable parserBase::$type Type is used by many functions to skip the hassle of if
in file Errors.inc, variable RecordWarning::$type name of global variable that descriptors for this warning/error is kept
$type
in file Errors.inc, variable RecordError::$type name of global variable that descriptors for this warning/error is kept
$type
in file ParserElements.inc, variable parserVar::$type Type is used by many functions to skip the hassle of if phpDocumentor_get_class($blah) == 'parserBlah'
$type
in file ParserElements.inc, variable parserTutorial::$type Type is used by many functions to skip the hassle of if phpDocumentor_get_class($blah) == 'parserBlah'
$type
in file ParserElements.inc, variable parserPackagePage::$type Type is used by many functions to skip the hassle of if phpDocumentor_get_class($blah) == 'parserBlah'
$type
in file DocBlockTags.inc, variable parserTag::$type Type is used by many functions to skip the hassle of
$type
in file ParserElements.inc, variable parserMethod::$type Type is used by many functions to skip the hassle of if phpDocumentor_get_class($blah) == 'parserBlah'
in file ParserElements.inc, variable parserDefine::$type Type is used by many functions to skip the hassle of if phpDocumentor_get_class($blah) == 'parserBlah'
in file TreeMenu.php, method HTML_TreeMenu_DHTML::toHTML() Returns the HTML for the menu. This method can be used instead of printMenu() to use the menu system with a template system.
tokenEquals
in file phpDocumentorTWordParser.inc, method phpDocumentorTWordParser::tokenEquals() Utility function to determine whether two tokens from the tokenizer are equal
in file class.pdf.php, method Cpdf::transaction() a few functions which should allow the document to be treated transactionally.
TranslateEntity
in file Converter.inc, method Converter::TranslateEntity() Used to translate an XML DocBook entity like ” from a tutorial by reading the options.ini file for the template.
TranslateTag
in file PDFdefaultConverter.inc, method PDFdefaultConverter::TranslateTag() Used to translate an XML DocBook tag from a tutorial by reading the options.ini file for the template.
TranslateTag
in file Converter.inc, method Converter::TranslateTag() Used to translate an XML DocBook tag from a tutorial by reading the options.ini file for the template.
in file Smarty.class.php, variable Smarty::$use_sub_dirs This tells Smarty whether or not to use sub dirs in the cache/ and templates_c/ directories. sub directories better organized, but may not work well with PHP safe mode enabled.
in file Io.inc, variable Io::$valid_booleans A specific array of values that boolean-based arguments can understand, aided by the decideOnOrOff() helper method.
$value
in file ParserData.inc, variable parserBase::$value set to different things by its descendants
in file class.pdf.php, variable Cpdf::$wordSpaceAdjust used to track the last used value of the inter-word spacing, this is so that it is known when the spacing is changed.
in file CHMdefaultConverter.inc, method CHMdefaultConverter::writefile() Write a file to disk, and add it to the $hhp_files list of files to include in the generated CHM
in file Setup.inc.php, global variable $_phpDocumentor_setting $_phpDocumentor_setting is either the value from the web interface, or is set up by Io::parseArgv()