HTMLSmartyConverter
HTML output converter.
This Converter takes output from the Parser and converts it to HTML-ready output for use with Smarty.
Located in /phpDocumentor/Converters/HTML/Smarty/HTMLSmartyConverter.inc (line 54)
Converter | --HTMLSmartyConverter
HTMLSmartyConverter
HTMLSmartyConverter
( &$allp, &$packp, &$classes, &$procpages, $po, $pp, $qm, $targetDir, $templateDir, $title)
mixed
getClassLink
(string $expr, string $package, [string $file = false], [boolean $text = false], [boolean $with_a = true])
mixed
getConstLink
(string $expr, string $class, string $package, [string $file = false], [boolean $text = false], boolean 5)
mixed
getDefineLink
(string $expr, string $package, [string $file = false], [boolean $text = false], boolean 4)
mixed
getFunctionLink
(string $expr, string $package, [string $file = false], [boolean $text = false], boolean 4)
mixed
getGlobalLink
(string $expr, string $package, [string $file = false], [boolean $text = false], boolean 4)
mixed
getMethodLink
(string $expr, string $class, string $package, [string $file = false], [boolean $text = false], boolean 5)
mixed
getPageLink
(string $expr, string $package, [string $path = false], [boolean $text = false], boolean 4)
string
getSourceAnchor
(string $sourcefile, string $anchor, [string $text = ''], [boolean $link = false])
mixed
getVarLink
(string $expr, string $class, string $package, [string $file = false], [boolean $text = false], boolean 5)
string
ProgramExample
(string $example, [boolean $tutorial = false], [ $inlinesourceparse = null], [ $class = null], [ $linenum = null], [ $filesourcepath = null])
void
returnSee
(abstractLink &$element, [string $eltext = false], [boolean $with_a = true], boolean 3)
string
$base_dir
(line 89)
target directory passed on the command-line.
$targetDir is malleable, always adding package/ and package/subpackage/ subdirectories onto it.
string
$class_dir
(line 95)
output directory for the current class being processed
array
$current
(line 120)
contains all of the template procedural page element loop data needed for the current template
array
$currentclass
(line 126)
contains all of the template class element loop data needed for the current template
boolean
$juststarted
= false (line 114)
controls formatting of parser informative output
Converter prints: "Converting /path/to/file.php... Procedural Page Elements... Classes..." Since HTMLdefaultConverter outputs files while converting, it needs to send a \n to start a new line. However, if there is more than one class, output is messy, with multiple \n's just between class file output. This variable prevents that and is purely cosmetic
array
$leftindex
= array('classes' => true, 'pages' => true, 'functions' => true, 'defines' => false, 'globals' => false) (line 76)
indexes of elements by package that need to be generated
- Converter::$leftindex
- Controls which of the one-element-only indexes are generated.
string
$name
= 'Smarty' (line 71)
string
$outputformat
= 'HTML' (line 69)
- Converter::$outputformat
- output format of this converter
array
$package_pages
= array() (line 102)
array of converted package page names.
Used to link to the package page in the left index
string
$page_dir
(line 82)
output directory for the current procedural page being processed
boolean
$processSpecialRoots
= true (line 61)
This converter knows about the new root tree processing
In order to fix PEAR Bug #6389
- Converter::$processSpecialRoots
- This converter knows about the new root tree processing
mixed
$ric_set
= array() (line 128)
boolean
$sort_page_contents_by_type
= true (line 67)
Smarty Converter wants elements sorted by type as well as alphabetically
- 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
mixed
$wrote
= false (line 127)
Inherited Variables
Inherited from Converter
- &$allp
- &$packp
- &$classes
- &$procpages
- $po
- $pp
- $qm
- $targetDir
- $templateDir
- $title
Converts class for template output
- parserClass &$element
- Converter::convertClass()
- Default Class Handler
Converts class variables for template output
- parserDefine &$element
- Converter::convertConst()
- Converts class constants for template output.
Converts defines for template output
- parserDefine &$element
- Converter::convertDefine()
- Converts defines for template output
Create errors.html template file output
This method takes all parsing errors and warnings and spits them out ordered by file and line number.
- Converter::ConvertErrorLog()
- Convert the phpDocumentor parsing/conversion error log
Converts function for template output
- parserFunction &$element
- Converter::convertFunction()
- Converts function for template output
Converts global variables for template output
- parserGlobal &$element
- Converter::convertGlobal()
- Converts global variables for template output
Converts include elements for template output
- parserInclude &$element
- Converter::convertInclude()
- Converts includes for template output
Converts class methods for template output
- parserDefine &$element
- Converter::convertMethod()
- Converts method for template output
Converts package page and sets its package as used in $package_pages
- parserPackagePage &$element
converts procedural pages for template output
- parserData &$element
- Converter::convertPage()
- Default Page Handler
- Converter::ConvertTodoList()
- Convert the list of all @todo tags
Converts class variables for template output
- parserDefine &$element
- Converter::convertVar()
- Converts class variables for template output.
Convert README/INSTALL/CHANGELOG file contents to output format
- README|INSTALL|CHANGELOG $name
- string $contents: contents of the file
- Converter::Convert_RIC()
- Convert README/INSTALL/CHANGELOG file contents to output format
- $media
- $targetdir
- $subdir
Writes out the template file of $class_data and unsets the template to save memory
- Converter::endClass()
- Called by walk() while converting, when the last class element has been parsed.
Writes out the template file of $page_data and unsets the template to save memory
- Converter::endPage()
- Called by walk() while converting, when the last procedural page element has been parsed.
HTMLdefaultConverter uses this function to format template index.html and packages.html
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). Then it uses the default package name as the first package index to display. It sets the right pane to be either a blank file with instructions on making package-level docs, or the package-level docs for the default package.
- Converter::formatIndex()
- Called by walk() while converting.
Generate indexes for li_package.html and classtree output files
This function generates the li_package.html files from the template file left.html. It does this by iterating through each of the $page_elements, $class_elements and $function_elements arrays to retrieve the pre-sorted abstractLink descendants needed for index generation. Conversion of these links to text is done by returnSee().
Then it uses generateFormattedClassTrees() to create class trees from the template file classtrees.html. Output filename is classtrees_packagename.html. This function also unsets $elements and $pkg_elements to free up the considerable memory these two class vars use
- Converter::formatLeftIndex()
- Called by walk() while converting.
HTMLdefaultConverter chooses to format both package indexes and the complete index here
This function formats output for the elementindex.html and pkgelementindex.html template files. It then writes them to the target directory
- Converter::formatPkgIndex()
- Called by walk() while converting.
Use the template tutorial_toc.tpl to generate a table of contents for HTML
- array $toc: format: array(array('tagname' => section, 'link' => returnsee link, 'id' => anchor name, 'title' => from title tag),...)
- Converter::formatTutorialTOC()
- Creates a table of contents for a {@toc} inline tag in a tutorial
Generate alphabetical index of all elements
returns an array containing the class inheritance tree from the root object to the class
- parserClass $class: class variable
- Converter::generateFormattedClassTree()
- returns an array containing the class inheritance tree from the root object to the class.
returns a template-enabled array of class trees
- string $package: package to generate a class tree for
returns a template-enabled array of interface inheritance trees
- string $package: package to generate a class tree for
Generate alphabetical index of all elements by package and subpackage
- string $package: name of a package
- string $expr: name of class
- string $package: package name
- string $file: full path to look in (used in index generation)
- boolean $text: deprecated
- boolean $with_a: return just the URL, or enclose it in an html a tag
- Converter::getClassLink()
- return false or a classLink to $expr
- boolean 5: return just the URL, or enclose it in an html a tag
- string $expr: name of class constant
- string $class: class containing class constant
- string $package: package name
- string $file: full path to look in (used in index generation)
- boolean $text: deprecated
- Converter::getConstLink()
- return false or a constLink to $expr in $class
- boolean 4: return just the URL, or enclose it in an html a tag
- string $expr: name of define
- string $package: package name
- string $file: full path to look in (used in index generation)
- boolean $text: deprecated
- Converter::getDefineLink()
- return false or a defineLink to $expr
- boolean 4: return just the URL, or enclose it in an html a tag
- string $expr: name of function
- string $package: package name
- string $file: full path to look in (used in index generation)
- boolean $text: deprecated
- Converter::getFunctionLink()
- return false or a functionLink to $expr
- boolean 4: return just the URL, or enclose it in an html a tag
- string $expr: name of global variable
- string $package: package name
- string $file: full path to look in (used in index generation)
- boolean $text: deprecated
- Converter::getGlobalLink()
- return false or a globalLink to $expr
- $element
- $fullpath
- Converter::getId()
- take abstractLink descendant and text $eltext and return a
Generate indexing information for given element
- parserElement $elt: descendant of parserElement
- boolean 5: return just the URL, or enclose it in an html a tag
- string $expr: name of method
- string $class: class containing method
- string $package: package name
- string $file: full path to look in (used in index generation)
- boolean $text: deprecated
- Converter::getMethodLink()
- return false or a methodLink to $expr in $class
- boolean 4: return just the URL, or enclose it in an html a tag
- string $expr: name of procedural page
- string $package: package name
- string $path: full path to look in (used in index generation)
- boolean $text: deprecated
- Converter::getPageLink()
- return false or a pageLink to $expr
return formatted class tree for the Class Trees page
- array $tree: output from getSortedClassTreeFromClass()
- string $package: package
- boolean $nounknownparent: if true, an object's parent will not be checked
- $noparent
Retrieve a Converter-specific anchor to a segment of a source code file parsed via a @filesource tag.
- string $sourcefile: full path to source file
- string $anchor: name of anchor
- string $text: link text, if this is a link
- boolean $link: returns either a link or a destination based on this parameter
- $path
- $package
- $subpackage
- $tutorial
- $id
- Converter::getTutorialId()
- Return a converter-specific id to distinguish tutorials and their sections
- $tutorial
- $k
- Converter::getTutorialTree()
- Get a tree structure representing the hierarchy of tutorials
- boolean 5: return just the URL, or enclose it in an html a tag
- string $expr: name of var
- string $class: class containing var
- string $package: package name
- string $file: full path to look in (used in index generation)
- boolean $text: deprecated
- Converter::getVarLink()
- return false or a varLink to $expr in $class
This function is not used by HTMLdefaultConverter, but is required by Converter
- Converter::Output()
- do all necessary output
Uses htmlspecialchars() on the input
- $text
- Converter::postProcess()
- This version does nothing
Used to convert the <code> tag in a docblock
- string $example
- boolean $tutorial
- $inlinesourceparse
- $class
- $linenum
- $filesourcepath
- Converter::ProgramExample()
- Used to convert the <code> tag in a docblock
does a nat case sort on the specified second level value of the array
- mixed $a
- mixed $b
does a nat case sort on the specified second level value of the array.
this one puts constructors first
- mixed $a
- mixed $b
- string $link
- string $text
- Converter::returnLink()
- take URL $link and text $text and return a link in the format needed for the Converter
This function takes an abstractLink descendant and returns an html link
- boolean 3: determines whether the returned text is enclosed in an <a> tag
- abstractLink &$element: a descendant of abstractlink should be passed, and never text
- string $eltext: text to display in the link
- boolean $with_a: this parameter is not used, and is deprecated
- Converter::returnSee()
- take abstractLink descendant and text $eltext and return a link
calls the converter setTargetDir, and then copies any template images and the stylesheet if they haven't been copied
- $dir
- Converter::setTargetDir()
- Sets the output directory for generated documentation
Return a line of highlighted source code with formatted line number
If the $path is a full path, then an anchor to the line number will be added as well
- integer $linenumber: line number
- string $line: highlighted source code line
- false|string $path: full path to @filesource file this line is a part of, if this is a single line from a complete file.
- Converter::sourceLine()
- Return a line of highlighted source code with formatted line number
- string $example
- $sourcecode
- Converter::unmangle()
- Called by parserSourceInlineTag::stringConvert() to allow converters to format the source code the way they'd like.
- $title
- $path
- $source
- Converter::writeExample()
- Write out the formatted source code for an example php file
- $path
- $value
- Converter::writeSource()
- Write out the formatted source code for a php file
Inherited Methods
Inherited From Converter
Converter::checkState()
Documentation generated on Mon, 05 Dec 2011 21:39:06 -0600 by phpDocumentor 1.4.4