Element index for package PhpDoc
Package indexes
[ a ]
[ b ]
[ c ]
[ d ]
[ e ]
[ f ]
[ g ]
[ h ]
[ i ]
[ j ]
[ l ]
[ m ]
[ n ]
[ o ]
[ p ]
[ r ]
[ s ]
[ t ]
[ u ]
[ v ]
[ w ]
[ x ]
[ _ ]
Letter '_'
- __construct
- in file log.php, method arbitPhpDocLogViewModel::__construct()
Construct project view model from common values
- __construct
- in file html.php, method arbitPhpDocHtmlViewModel::__construct()
Construct project view model from common values
Letter 'a'
- $actions
- in file cli_tool.php, variable arbitModulePhpDocAdminCliTool::$actions
Available actions.
- arbitModulePhpDocAdminCliTool
- in file cli_tool.php, class arbitModulePhpDocAdminCliTool
CLI tool class, which handles various adimistrative tasks.
- arbitModulePhpDocController
- in file controller.php, class arbitModulePhpDocController
Base php_doc controller.
- arbitModulePhpDocDefintion
- in file definition.php, class arbitModulePhpDocDefintion
Arbit PhpDoc module definition
- arbitModulePhpDocException
- in file exceptions.php, class arbitModulePhpDocException
Basic arbit notification module exception
- arbitModulePhpDocRegenerateCommand
- in file regenerate.php, class arbitModulePhpDocRegenerateCommand
Arbit phpdoc module update command
- arbitModulePhpDocXHtmlHandler
- in file xhtml.php, class arbitModulePhpDocXHtmlHandler
XHtml view handler generating XHtml from the provided view model.
- arbitPhpDocHtmlViewModel
- in file html.php, class arbitPhpDocHtmlViewModel
Base model struct for the PhpDoc overview
- arbitPhpDocLogViewModel
- in file log.php, class arbitPhpDocLogViewModel
Base model struct for the PhpDoc overview
Letter 'b'
- $base_dir
- in file HTMLArbitConverter.inc, variable HTMLArbitConverter::$base_dir
target directory passed on the command-line.
Letter 'c'
- $caches
- in file definition.php, variable arbitModulePhpDocDefintion::$caches
Array with caches registered on initialization
Each cache must have a unique name, normally prefixed with the module identifier. time to live for the cache.
- $commands
- in file definition.php, variable arbitModulePhpDocDefintion::$commands
List of command definitions of the module
Array containing command names and their assiciated classes in the module definition.
- createController
- in file cli_tool.php, method arbitModulePhpDocAdminCliTool::createController()
Get controller
- cli_tool.php
- procedural page cli_tool.php
- controller.php
- procedural page controller.php
- $class_dir
- in file HTMLArbitConverter.inc, variable HTMLArbitConverter::$class_dir
output directory for the current class being processed
- $current
- in file HTMLArbitConverter.inc, variable HTMLArbitConverter::$current
contains all of the template procedural page element loop data needed for the current template
- $currentclass
- in file HTMLArbitConverter.inc, variable HTMLArbitConverter::$currentclass
contains all of the template class element loop data needed for the current template
- convertClass
- in file HTMLArbitConverter.inc, method HTMLArbitConverter::convertClass()
Converts class for template output
- convertConst
- in file HTMLArbitConverter.inc, method HTMLArbitConverter::convertConst()
Converts class variables for template output
- convertDefine
- in file HTMLArbitConverter.inc, method HTMLArbitConverter::convertDefine()
Converts defines for template output
- ConvertErrorLog
- in file HTMLArbitConverter.inc, method HTMLArbitConverter::ConvertErrorLog()
Create errors.
This method takes all parsing errors and warnings and spits them out ordered by file and line number.
- convertFunction
- in file HTMLArbitConverter.inc, method HTMLArbitConverter::convertFunction()
Converts function for template output
- convertGlobal
- in file HTMLArbitConverter.inc, method HTMLArbitConverter::convertGlobal()
Converts global variables for template output
- convertInclude
- in file HTMLArbitConverter.inc, method HTMLArbitConverter::convertInclude()
Converts include elements for template output
- convertMethod
- in file HTMLArbitConverter.inc, method HTMLArbitConverter::convertMethod()
Converts class methods for template output
- convertPackagepage
- in file HTMLArbitConverter.inc, method HTMLArbitConverter::convertPackagepage()
Converts package page and sets its package as used in $package_pages
- convertPage
- in file HTMLArbitConverter.inc, method HTMLArbitConverter::convertPage()
converts procedural pages for template output
- ConvertTodoList
- in file HTMLArbitConverter.inc, method HTMLArbitConverter::ConvertTodoList()
- convertTutorial
- in file HTMLArbitConverter.inc, method HTMLArbitConverter::convertTutorial()
- convertVar
- in file HTMLArbitConverter.inc, method HTMLArbitConverter::convertVar()
Converts class variables for template output
- Convert_RIC
- in file HTMLArbitConverter.inc, method HTMLArbitConverter::Convert_RIC()
Convert README/INSTALL/CHANGELOG file contents to output format
- copyMediaRecursively
- in file HTMLArbitConverter.inc, method HTMLArbitConverter::copyMediaRecursively()
- configureTemplate
- in file xhtml.php, method arbitModulePhpDocXHtmlHandler::configureTemplate()
Configure tempalte library
Letter 'd'
- $description
- in file cli_tool.php, variable arbitModulePhpDocAdminCliTool::$description
Short description of the purpose of the current CLI tool
- definition.php
- procedural page definition.php
Letter 'e'
- emitCiSignals
- in file controller.php, method arbitModulePhpDocController::emitCiSignals()
Emit continious integration update
- exceptions.php
- procedural page exceptions.php
- endClass
- in file HTMLArbitConverter.inc, method HTMLArbitConverter::endClass()
Writes out the template file of $class_data and unsets the template to save memory
- endPage
- in file HTMLArbitConverter.inc, method HTMLArbitConverter::endPage()
Writes out the template file of $page_data and unsets the template to save memory
Letter 'f'
- formatIndex
- in file HTMLArbitConverter.inc, method HTMLArbitConverter::formatIndex()
HTMLdefaultConverter uses this function to format template index.
This function generates the package list from $all_packages, eliminating any packages that don't have any entries in their package index (no files at all, due to @ignore or other factors).
- formatLeftIndex
- in file HTMLArbitConverter.inc, method HTMLArbitConverter::formatLeftIndex()
Generate indexes for li_package.
This function generates the li_package. iterating through each of the $page_elements, $class_elements and $function_elements arrays to retrieve the pre-sorted abstractLink descendants needed for index generation. text is done by returnSee().
- formatPkgIndex
- in file HTMLArbitConverter.inc, method HTMLArbitConverter::formatPkgIndex()
HTMLdefaultConverter chooses to format both package indexes and the complete index here
- formatTutorialTOC
- in file HTMLArbitConverter.inc, method HTMLArbitConverter::formatTutorialTOC()
Use the template tutorial_toc.
Letter 'g'
- generate
- in file controller.php, method arbitModulePhpDocController::generate()
Generate action
- getDocPath
- in file controller.php, method arbitModulePhpDocController::getDocPath()
Get path to generated documentation
- getMenu
- in file controller.php, method arbitModulePhpDocController::getMenu()
Return the menu for the php_doc controller
- generateElementIndex
- in file HTMLArbitConverter.inc, method HTMLArbitConverter::generateElementIndex()
Generate alphabetical index of all elements
- generateFormattedClassTree
- in file HTMLArbitConverter.inc, method HTMLArbitConverter::generateFormattedClassTree()
returns an array containing the class inheritance tree from the root object to the class
- generateFormattedClassTrees
- in file HTMLArbitConverter.inc, method HTMLArbitConverter::generateFormattedClassTrees()
returns a template-enabled array of class trees
- generateFormattedInterfaceTrees
- in file HTMLArbitConverter.inc, method HTMLArbitConverter::generateFormattedInterfaceTrees()
returns a template-enabled array of interface inheritance trees
- generatePkgElementIndex
- in file HTMLArbitConverter.inc, method HTMLArbitConverter::generatePkgElementIndex()
Generate alphabetical index of all elements by package and subpackage
- generatePkgElementIndexes
- in file HTMLArbitConverter.inc, method HTMLArbitConverter::generatePkgElementIndexes()
- getCData
- in file HTMLArbitConverter.inc, method HTMLArbitConverter::getCData()
- getClassContents
- in file HTMLArbitConverter.inc, method HTMLArbitConverter::getClassContents()
- getClassLeft
- in file HTMLArbitConverter.inc, method HTMLArbitConverter::getClassLeft()
- getClassLink
- in file HTMLArbitConverter.inc, method HTMLArbitConverter::getClassLink()
- getConstLink
- in file HTMLArbitConverter.inc, method HTMLArbitConverter::getConstLink()
- getCurrentPageLink
- in file HTMLArbitConverter.inc, method HTMLArbitConverter::getCurrentPageLink()
- getDefineLink
- in file HTMLArbitConverter.inc, method HTMLArbitConverter::getDefineLink()
- getExampleLink
- in file HTMLArbitConverter.inc, method HTMLArbitConverter::getExampleLink()
- getFunctionLink
- in file HTMLArbitConverter.inc, method HTMLArbitConverter::getFunctionLink()
- getGlobalLink
- in file HTMLArbitConverter.inc, method HTMLArbitConverter::getGlobalLink()
- getId
- in file HTMLArbitConverter.inc, method HTMLArbitConverter::getId()
- getIndexInformation
- in file HTMLArbitConverter.inc, method HTMLArbitConverter::getIndexInformation()
Generate indexing information for given element
- getMethodLink
- in file HTMLArbitConverter.inc, method HTMLArbitConverter::getMethodLink()
- getPageContents
- in file HTMLArbitConverter.inc, method HTMLArbitConverter::getPageContents()
- getPageLeft
- in file HTMLArbitConverter.inc, method HTMLArbitConverter::getPageLeft()
- getPageLink
- in file HTMLArbitConverter.inc, method HTMLArbitConverter::getPageLink()
- getPageName
- in file HTMLArbitConverter.inc, method HTMLArbitConverter::getPageName()
- getRootTree
- in file HTMLArbitConverter.inc, method HTMLArbitConverter::getRootTree()
return formatted class tree for the Class Trees page
- getSourceAnchor
- in file HTMLArbitConverter.inc, method HTMLArbitConverter::getSourceAnchor()
Retrieve a Converter-specific anchor to a segment of a source code file parsed via a tags.
- getSourceLink
- in file HTMLArbitConverter.inc, method HTMLArbitConverter::getSourceLink()
- getTutorialId
- in file HTMLArbitConverter.inc, method HTMLArbitConverter::getTutorialId()
- getTutorialList
- in file HTMLArbitConverter.inc, method HTMLArbitConverter::getTutorialList()
- getTutorialTree
- in file HTMLArbitConverter.inc, method HTMLArbitConverter::getTutorialTree()
- getVarLink
- in file HTMLArbitConverter.inc, method HTMLArbitConverter::getVarLink()
Letter 'h'
- HTMLArbitConverter
- in file HTMLArbitConverter.inc, method HTMLArbitConverter::HTMLArbitConverter()
- HTMLArbitConverter
- in file HTMLArbitConverter.inc, class HTMLArbitConverter
HTML output converter.
- HTMLArbitConverter.inc
- procedural page HTMLArbitConverter.inc
- html.php
- procedural page html.php
Letter 'i'
- index
- in file controller.php, method arbitModulePhpDocController::index()
Index action
The index action just dispatches to the default view of the php_doc module - the custom php_doc configuration.
Letter 'j'
- $juststarted
- in file HTMLArbitConverter.inc, variable HTMLArbitConverter::$juststarted
controls formatting of parser informative output
Letter 'l'
- log
- in file controller.php, method arbitModulePhpDocController::log()
Log action
- $leftindex
- in file HTMLArbitConverter.inc, variable HTMLArbitConverter::$leftindex
indexes of elements by package that need to be generated
- log.php
- procedural page log.php
Letter 'm'
- makeLeft
- in file HTMLArbitConverter.inc, method HTMLArbitConverter::makeLeft()
- $moduleTemplates
- in file xhtml.php, variable arbitModulePhpDocXHtmlHandler::$moduleTemplates
Method template association for default calls.
Letter 'n'
- $name
- in file cli_tool.php, variable arbitModulePhpDocAdminCliTool::$name
Name of CLI tool
- $name
- in file HTMLArbitConverter.inc, variable HTMLArbitConverter::$name
Letter 'o'
- $outputformat
- in file HTMLArbitConverter.inc, variable HTMLArbitConverter::$outputformat
- Output
- in file HTMLArbitConverter.inc, method HTMLArbitConverter::Output()
This function is not used by HTMLdefaultConverter, but is required by Converter
Letter 'p'
- $properties
- in file definition.php, variable arbitModulePhpDocDefintion::$properties
Array containing the module structures properties.
- parsePhpDocLog
- in file controller.php, method arbitModulePhpDocController::parsePhpDocLog()
Parse log from PHP documentor
Parse the log and return an array of errors and warnings associated with the respective file and line where the problem occured.
- $package_pages
- in file HTMLArbitConverter.inc, variable HTMLArbitConverter::$package_pages
array of converted package page names.
- $page_dir
- in file HTMLArbitConverter.inc, variable HTMLArbitConverter::$page_dir
output directory for the current procedural page being processed
- $processSpecialRoots
- in file HTMLArbitConverter.inc, variable HTMLArbitConverter::$processSpecialRoots
This converter knows about the new root tree processing
- postProcess
- in file HTMLArbitConverter.inc, method HTMLArbitConverter::postProcess()
Uses htmlspecialchars() on the input
- ProgramExample
- in file HTMLArbitConverter.inc, method HTMLArbitConverter::ProgramExample()
Used to convert the <code> tag in a docblock
- $properties
- in file log.php, variable arbitPhpDocLogViewModel::$properties
Array containing the actual view data.
- $properties
- in file html.php, variable arbitPhpDocHtmlViewModel::$properties
Array containing the actual view data.
Letter 'r'
- regenerate.php
- procedural page regenerate.php
- reportErrors
- in file controller.php, method arbitModulePhpDocController::reportErrors()
Report errors back to source module
- run
- in file regenerate.php, method arbitModulePhpDocRegenerateCommand::run()
Run command
Execute the actual bits.
- $ric_set
- in file HTMLArbitConverter.inc, variable HTMLArbitConverter::$ric_set
- rcNatCmp
- in file HTMLArbitConverter.inc, method HTMLArbitConverter::rcNatCmp()
does a nat case sort on the specified second level value of the array
- rcNatCmp1
- in file HTMLArbitConverter.inc, method HTMLArbitConverter::rcNatCmp1()
does a nat case sort on the specified second level value of the array.
- returnLink
- in file HTMLArbitConverter.inc, method HTMLArbitConverter::returnLink()
- returnSee
- in file HTMLArbitConverter.inc, method HTMLArbitConverter::returnSee()
This function takes an abstractLink descendant and returns an html link
Letter 's'
- sourceUpdated
- in file controller.php, method arbitModulePhpDocController::sourceUpdated()
Handle source update signal
- $sort_page_contents_by_type
- in file HTMLArbitConverter.inc, variable HTMLArbitConverter::$sort_page_contents_by_type
Smarty Converter wants elements sorted by type as well as alphabetically
- setTargetDir
- in file HTMLArbitConverter.inc, method HTMLArbitConverter::setTargetDir()
calls the converter setTargetDir, and then copies any template images and the stylesheet if they haven't been copied
- setTemplateDir
- in file HTMLArbitConverter.inc, method HTMLArbitConverter::setTemplateDir()
- SmartyInit
- in file HTMLArbitConverter.inc, method HTMLArbitConverter::SmartyInit()
- sourceLine
- in file HTMLArbitConverter.inc, method HTMLArbitConverter::sourceLine()
Return a line of highlighted source code with formatted line number
Letter 't'
- TutorialExample
- in file HTMLArbitConverter.inc, method HTMLArbitConverter::TutorialExample()
Letter 'u'
- unmangle
- in file HTMLArbitConverter.inc, method HTMLArbitConverter::unmangle()
Letter 'v'
- $viewModels
- in file definition.php, variable arbitModulePhpDocDefintion::$viewModels
List of view models used by the module
List of used view handlers associated with a list of view models used by the module, each associated with a callback to the concrete handler implementation to visit the view model.
- view
- in file controller.php, method arbitModulePhpDocController::view()
Overview action
Letter 'w'
- $wrote
- in file HTMLArbitConverter.inc, variable HTMLArbitConverter::$wrote
- writeExample
- in file HTMLArbitConverter.inc, method HTMLArbitConverter::writeExample()
- writeNewPPage
- in file HTMLArbitConverter.inc, method HTMLArbitConverter::writeNewPPage()
- writeRIC
- in file HTMLArbitConverter.inc, method HTMLArbitConverter::writeRIC()
- writeSource
- in file HTMLArbitConverter.inc, method HTMLArbitConverter::writeSource()
Letter 'x'
- xhtml.php
- procedural page xhtml.php
|