Converters
[ class tree: Converters ] [ index: Converters ] [ all elements ]

Class: CHMdefaultConverter

Source Location: /phpDocumentor/Converters/CHM/default/CHMdefaultConverter.inc

Class Overview

Converter
   |
   --CHMdefaultConverter

Generates files that MS HTML Help Worshop can use to create a MS Windows compiled help file (CHM)


Author(s):

Version:

  • $Revision: 317233 $

Variables

Methods


Inherited Variables

Inherited Methods

Class: Converter

Converter::Converter()
Initialize Converter data structures
Converter::AttrToString()
Convert the attribute of a Tutorial docbook tag's attribute list
Converter::Bolden()
Used to convert the contents of <b> in a docblock
Converter::Br()
Used to convert <br> in a docblock
Converter::checkState()
Compare parserStringWithInlineTags::Convert() cache state to $state
Converter::cleanup()
Finish up parsing/cleanup directories
Converter::Convert()
Convert all elements to output format
Converter::convertClass()
Default Class Handler
Converter::convertConst()
Converts class constants for template output.
Converter::convertDefine()
Converts defines for template output
Converter::ConvertErrorLog()
Convert the phpDocumentor parsing/conversion error log
Converter::convertFunction()
Converts function for template output
Converter::convertGlobal()
Converts global variables for template output
Converter::convertInclude()
Converts includes for template output
Converter::convertMethod()
Converts method for template output
Converter::convertPage()
Default Page Handler
Converter::ConvertTitle()
Convert the title of a Tutorial docbook tag section
Converter::ConvertTodoList()
Convert the list of all @todo tags
Converter::convertTutorial()
Default Tutorial Handler
Converter::convertVar()
Converts class variables for template output.
Converter::Convert_RIC()
Convert README/INSTALL/CHANGELOG file contents to output format
Converter::copyFile()
Copies a file from the template directory to the target directory
Converter::createParentDir()
Recursively creates all subdirectories that don't exist in the $dir path
Converter::EncloseList()
Used to convert the contents of <ol> or <ul> in a docblock
Converter::EncloseParagraph()
Used to enclose a paragraph in a docblock
Converter::endClass()
Called by walk() while converting, when the last class element has been parsed.
Converter::endPage()
Called by walk() while converting, when the last procedural page element has been parsed.
Converter::exampleProgramExample()
Used to convert the {@example} inline tag in a docblock.
Converter::flushHighlightCache()
Return the close text for the current token
Converter::formatIndex()
Called by walk() while converting.
Converter::formatLeftIndex()
Called by walk() while converting.
Converter::formatPkgIndex()
Called by walk() while converting.
Converter::formatTutorialTOC()
Creates a table of contents for a {@toc} inline tag in a tutorial
Converter::generateChildClassList()
returns a list of child classes
Converter::generateFormattedClassTree()
returns an array containing the class inheritance tree from the root object to the class.
Converter::getClassesOnPage()
gets a list of all classes declared on a procedural page represented by
Converter::getClassLink()
return false or a classLink to $expr
Converter::getConstLink()
return false or a constLink to $expr in $class
Converter::getConverterDir()
Get the absolute path to the converter's base directory
Converter::getCurrentPageLink()
Converter::getCurrentPageURL()
Return the path to the current
Converter::getDefineLink()
return false or a defineLink to $expr
Converter::getFileSourceName()
Translate the path info into a unique file name for the highlighted source code.
Converter::getFileSourcePath()
Return the fixed path to the source-code file folder.
Converter::getFormattedConflicts()
Converter::getFormattedDescMethods()
Get a list of methods in child classes that override this method
Converter::getFormattedDescVars()
Get a list of vars in child classes that override this var
Converter::getFormattedImplements()
returns an array containing the class inheritance tree from the root object to the class.
Converter::getFormattedInheritedConsts()
Return template-enabled list of inherited class constants
Converter::getFormattedInheritedMethods()
Return template-enabled list of inherited methods
Converter::getFormattedInheritedVars()
Return template-enabled list of inherited variables
Converter::getFormattedMethodImplements()
Get the method this method(s) implemented from an interface, if any
Converter::getFormattedOverrides()
Get the method this method overrides, if any
Converter::getFunctionLink()
return false or a functionLink to $expr
Converter::getGlobalLink()
return false or a globalLink to $expr
Converter::getGlobalValue()
Parse a global variable's default value for class initialization.
Converter::getHighlightState()
Converter::getId()
take abstractLink descendant and text $eltext and return a
Converter::getIncludeValue()
Parse an include's file to see if it is a file documented in this project
Converter::getLink()
The meat of the @see tag and inline {@link} tag
Converter::getMethodLink()
return false or a methodLink to $expr in $class
Converter::getPageLink()
return false or a pageLink to $expr
Converter::getSortedClassTreeFromClass()
Return a tree of all classes that extend this class
Converter::getSourceLink()
Converter::getState()
Return parserStringWithInlineTags::Convert() cache state
Converter::getTutorialId()
Return a converter-specific id to distinguish tutorials and their sections
Converter::getTutorialLink()
The meat of the @tutorial tag and inline {@tutorial} tag
Converter::getTutorialTree()
Get a tree structure representing the hierarchy of tutorials
Converter::getVarLink()
return false or a varLink to $expr in $class
Converter::hasSourceCode()
Determine whether an element's file has generated source code, used for linking to line numbers of source.
Converter::hasTutorial()
Converter::highlightDocBlockSource()
Used to allow converters to format the source code of DocBlocks the way they'd like.
Converter::highlightSource()
Used to allow converters to format the source code the way they'd like.
Converter::highlightTutorialSource()
Used to allow converters to format the source code of Tutorial XML the way they'd like.
Converter::Italicize()
Used to convert the contents of <i> in a docblock
Converter::Kbdize()
Used to convert the contents of <kbd> in a docblock
Converter::ListItem()
Used to convert the contents of <li> in a docblock
Converter::newSmarty()
Return a Smarty template object to operate with
Converter::Output()
do all necessary output
Converter::postProcess()
This version does nothing
Converter::prepareDocBlock()
convert the element's DocBlock for output
Converter::PreserveWhiteSpace()
Used to convert the contents of <pre> in a docblock
Converter::ProgramExample()
Used to convert the <code> tag in a docblock
Converter::returnLink()
take URL $link and text $text and return a link in the format needed for the Converter
Converter::returnSee()
take abstractLink descendant and text $eltext and return a link
Converter::Sampize()
Used to convert the contents of <samp> in a docblock
Converter::setSourcePaths()
Mark a file as having had source code highlighted
Converter::setTargetDir()
Sets the output directory for generated documentation
Converter::setTemplateBase()
Set the template directory with a different template base directory
Converter::setTemplateDir()
sets the template directory based on the $outputformat and $name
Converter::sortPageContentsByElementType()
sorts $page_contents by element type as well as alphabetically
Converter::sourceLine()
Return a line of highlighted source code with formatted line number
Converter::startHighlight()
Initialize highlight caching
Converter::TranslateEntity()
Used to translate an XML DocBook entity like &rdquo; from a tutorial by reading the options.ini file for the template.
Converter::TranslateTag()
Used to translate an XML DocBook tag from a tutorial by reading the options.ini file for the template.
Converter::TutorialExample()
Converter::type_adjust()
Called by parserReturnTag::Convert() to allow converters to change type names to desired formatting
Converter::unmangle()
Called by parserSourceInlineTag::stringConvert() to allow converters to format the source code the way they'd like.
Converter::vardump_tree()
Debugging function for dumping $tutorial_tree
Converter::Varize()
Used to convert the contents of <var> in a docblock
Converter::walk()
called by phpDocumentor_IntermediateParser::Convert() to traverse the array of pages and their elements, converting them to the output format
Converter::walk_everything()
walk over elements by package rather than page
Converter::writeExample()
Write out the formatted source code for an example php file
Converter::writeFile()
Writes a file to target dir
Converter::writeSource()
Write out the formatted source code for a php file
Converter::_rmdir()
Completely remove a directory and its contents
Converter::_setHighlightCache()
Converter::_tutorial_path()
Returns the path to this tutorial as a string

Class Details

[line 56]
Generates files that MS HTML Help Worshop can use to create a MS Windows compiled help file (CHM)

The free MS HTML Help compiler takes the project file (phpdoc.hhp) and reads the table of contents file specified in the project (which is always contents.hhc in phpDocumentor). When the converter reaches stable state, it will also output an index file index.hhk. The free download for MS HTML Help Workshop is available below




Tags:

author:  Greg Beaver <cellog@php.net>
version:  $Revision: 317233 $
link:  MS HTML Help Workshop download
since:  1.0rc1


[ Top ]


Class Variables

$base_dir =

[line 85]

target directory passed on the command-line.

$targetDir is malleable, always adding package/ and package/subpackage/ subdirectories onto it.



Type:   string


[ Top ]

$class_dir =

[line 91]

output directory for the current class being processed


Type:   string


[ Top ]

$current =

[line 116]

contains all of the template procedural page element loop data needed for the current template


Type:   array


[ Top ]

$currentclass =

[line 122]

contains all of the template class element loop data needed for the current template


Type:   array


[ Top ]

$juststarted =  false

[line 110]

controls formatting of parser informative output

Converter prints: "Converting /path/to/file.php... Procedural Page Elements... Classes..." Since CHMdefaultConverter 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



Type:   boolean


[ Top ]

$KLinks = array()

[line 129]

Table of Contents entry for index.hhk



Tags:

usedby:  CHMdefaultConverter::addKLink() - tracks the index

Type:   array


[ Top ]

$leftindex = array('classes' => true, 'pages' => true, 'functions' => true, 'defines' => false, 'globals' => false)

[line 72]

indexes of elements by package that need to be generated


Type:   array
Overrides:   Array


[ Top ]

$name =  'default'

[line 67]


Type:   string


[ Top ]

$outputformat =  'CHM'

[line 65]


Type:   string
Overrides:   Array


[ Top ]

$package_pages = array()

[line 98]

array of converted package page names.

Used to link to the package page in the left index




Tags:

var:  Format: array(package => 1)

Type:   array


[ Top ]

$page_dir =

[line 78]

output directory for the current procedural page being processed


Type:   string


[ Top ]

$ric_set = array()

[line 124]


Type:   mixed


[ Top ]

$sort_page_contents_by_type =  true

[line 63]

CHMdefaultConverter wants elements sorted by type as well as alphabetically



Tags:


Type:   boolean
Overrides:   Array


[ Top ]

$wrote =  false

[line 123]


Type:   mixed


[ Top ]



Class Methods


constructor CHMdefaultConverter [line 135]

CHMdefaultConverter CHMdefaultConverter( &$allp, &$packp, &$classes, &$procpages, $po, $pp, $qm, $targetDir, $templateDir, $title)

sets $base_dir to $targetDir



Tags:



Parameters:

   &$allp  
   &$packp  
   &$classes  
   &$procpages  
   $po  
   $pp  
   $qm  
   $targetDir  
   $templateDir  
   $title  

[ Top ]

method addHHP [line 1701]

void addHHP( $file)



Tags:

uses:  $hhp_files - creates the array by adding parameter $file


Parameters:

   $file  

[ Top ]

method addKLink [line 1795]

void addKLink( string $name, string $file, [string $bookmark = ''], [string $group = ''])

Add an item to the index.hhk file



Tags:

author:  Andrew Eddie <eddieajau@users.sourceforge.net>
uses:  CHMdefaultConverter::$KLinks - tracks the index


Parameters:

string   $name   index entry name
string   $file   filename containing index
string   $bookmark   html anchor of location in file, if any
string   $group   group this entry with a string

[ Top ]

method addSourceTOC [line 1762]

void addSourceTOC( $name, $file, $package, $subpackage, [ $source = false])



Parameters:

   $name  
   $file  
   $package  
   $subpackage  
   $source  

[ Top ]

method addTOC [line 1773]

void addTOC( $name, $file, $package, $subpackage, [ $class = false], [ $tutorial = false])



Parameters:

   $name  
   $file  
   $package  
   $subpackage  
   $class  
   $tutorial  

[ Top ]

method convertClass [line 828]


method convertConst [line 860]

void convertConst( parserDefine &$element)

Converts class constants for template output



Tags:



Overrides Converter::convertConst() (Converts class constants for template output.)

Parameters:

parserDefine   &$element  

[ Top ]

method convertDefine [line 909]

void convertDefine( parserDefine &$element)

Converts defines for template output



Tags:



Overrides Converter::convertDefine() (Converts defines for template output)

Parameters:

parserDefine   &$element  

[ Top ]

method ConvertErrorLog [line 698]

void ConvertErrorLog( )

Create errors.html template file output

This method takes all parsing errors and warnings and spits them out ordered by file and line number.




Tags:

global:  ErrorTracker $phpDocumentor_errors: We'll be using it's output facility


Overrides Converter::ConvertErrorLog() (Convert the phpDocumentor parsing/conversion error log)

[ Top ]

method convertFunction [line 884]

void convertFunction( parserFunction &$element)

Converts function for template output



Tags:



Overrides Converter::convertFunction() (Converts function for template output)

Parameters:

parserFunction   &$element  

[ Top ]

method convertGlobal [line 920]

void convertGlobal( parserGlobal &$element)

Converts global variables for template output



Overrides Converter::convertGlobal() (Converts global variables for template output)

Parameters:

parserGlobal   &$element  

[ Top ]

method convertInclude [line 897]

void convertInclude( parserInclude &$element)

Converts include elements for template output



Tags:



Overrides Converter::convertInclude() (Converts includes for template output)

Parameters:

parserInclude   &$element  

[ Top ]

method convertMethod [line 872]

void convertMethod( parserDefine &$element)

Converts class methods for template output



Tags:



Overrides Converter::convertMethod() (Converts method for template output)

Parameters:

parserDefine   &$element  

[ Top ]

method convertPackagepage [line 773]

void convertPackagepage( parserPackagePage &$element)

Converts package page and sets its package as used in $package_pages



Parameters:

parserPackagePage   &$element  

[ Top ]

method convertPage [line 932]

void convertPage( parserData &$element)

converts procedural pages for template output



Tags:



Overrides Converter::convertPage() (Default Page Handler)

Parameters:

parserData   &$element  

[ Top ]

method ConvertTodoList [line 644]

void ConvertTodoList( )



Overrides Converter::ConvertTodoList() (Convert the list of all @todo tags)

[ Top ]

method convertTutorial [line 794]

void convertTutorial( parserTutorial &$element)



Overrides Converter::convertTutorial() (Default Tutorial Handler)

Parameters:

parserTutorial   &$element  

[ Top ]

method convertVar [line 848]

void convertVar( parserDefine &$element)

Converts class variables for template output



Tags:



Overrides Converter::convertVar() (Converts class variables for template output.)

Parameters:

parserDefine   &$element  

[ Top ]

method Convert_RIC [line 680]

void Convert_RIC( README|INSTALL|CHANGELOG $name, string $contents)

Convert README/INSTALL/CHANGELOG file contents to output format



Overrides Converter::Convert_RIC() (Convert README/INSTALL/CHANGELOG file contents to output format)

Parameters:

README|INSTALL|CHANGELOG   $name  
string   $contents   contents of the file

[ Top ]

method copyMediaRecursively [line 1361]

void copyMediaRecursively( $media, $targetdir, [ $subdir = ''])



Parameters:

   $media  
   $targetdir  
   $subdir  

[ Top ]

method endClass [line 340]

void endClass( )

Writes out the template file of $class_data and unsets the template to save memory



Tags:

see:  Converter::endClass()
see:  registerCurrentClass()


Overrides Converter::endClass() (Called by walk() while converting, when the last class element has been parsed.)

[ Top ]

method endPage [line 363]

void endPage( )

Writes out the template file of $page_data and unsets the template to save memory



Tags:

see:  Converter::endPage()
see:  registerCurrent()


Overrides Converter::endPage() (Called by walk() while converting, when the last procedural page element has been parsed.)

[ Top ]

method formatIndex [line 427]

void formatIndex( )

CHMdefaultConverter 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.




Tags:

global:  string $phpDocumentor_DefaultPackageName: Used to set the starting package to display


Overrides Converter::formatIndex() (Called by walk() while converting.)

[ Top ]

method formatLeftIndex [line 523]

void formatLeftIndex( )

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(). The $local parameter is set to false to ensure that paths are correct.

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




Tags:



Overrides Converter::formatLeftIndex() (Called by walk() while converting.)

[ Top ]

method formatPkgIndex [line 395]

void formatPkgIndex( )

CHMdefaultConverter 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




Tags:



Overrides Converter::formatPkgIndex() (Called by walk() while converting.)

[ Top ]

method formatTutorialTOC [line 311]

string formatTutorialTOC( array $toc)

Use the template tutorial_toc.tpl to generate a table of contents for HTML



Tags:

return:  table of contents formatted for use in the current output format


Overrides Converter::formatTutorialTOC() (Creates a table of contents for a {@toc} inline tag in a tutorial)

Parameters:

array   $toc   format: array(array('tagname' => section, 'link' => returnsee link, 'id' => anchor name, 'title' => from title tag),...)

[ Top ]

method generateElementIndex [line 1322]

void generateElementIndex( )

Generate alphabetical index of all elements



Tags:



[ Top ]

method generateFormattedClassTree [line 959]

array generateFormattedClassTree( parserClass $class)

returns an array containing the class inheritance tree from the root object to the class



Tags:

return:  Format: array(root,child,child,child,...,$class)
uses:  parserClass::getParentClassTree()


Overrides Converter::generateFormattedClassTree() (returns an array containing the class inheritance tree from the root object to the class.)

Parameters:

parserClass   $class   class variable

[ Top ]

method generateFormattedClassTrees [line 1023]

void generateFormattedClassTrees( string $package)

returns a template-enabled array of class trees



Tags:

see:  $roots, HTMLConverter::getRootTree()


Parameters:

string   $package   package to generate a class tree for

[ Top ]

method generateFormattedInterfaceTrees [line 1077]

void generateFormattedInterfaceTrees( string $package)

returns a template-enabled array of interface inheritance trees



Tags:

see:  $roots, HTMLConverter::getRootTree()


Parameters:

string   $package   package to generate a class tree for

[ Top ]

method generateKLinks [line 1816]

string generateKLinks( )

Get the table of contents for index.hhk



Tags:

return:  contents of tocentry.tpl generated from $KLinks
author:  Andrew Eddie <eddieajau@users.sourceforge.net>


[ Top ]

method generatePkgElementIndex [line 1426]

void generatePkgElementIndex( string $package)

Generate alphabetical index of all elements by package and subpackage



Tags:



Parameters:

string   $package   name of a package

[ Top ]

method generatePkgElementIndexes [line 1477]

void generatePkgElementIndexes( )



Tags:



[ Top ]

method generateTOC [line 1710]

void generateTOC( )



Tags:

usedby:  CHMdefaultConverter::Output() - assigns to the toc template variable


[ Top ]

method getCData [line 759]

void getCData( $value)



Parameters:

   $value  

[ Top ]

method getClassLink [line 1517]

mixed getClassLink( string $expr, string $package, [string $file = false], [boolean $text = false], [boolean $with_a = true])



Tags:

return:  false if not found, or an html a link to the class's documentation
see:  Converter::getClassLink()


Overrides Converter::getClassLink() (return false or a classLink to $expr)

Parameters:

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

[ Top ]

method getConstLink [line 1632]

mixed getConstLink( string $expr, string $class, string $package, [string $file = false], [boolean $text = false], boolean 5)



Tags:

return:  false if not found, or an html a link to the var's documentation
see:  Converter::getVarLink()


Overrides Converter::getConstLink() (return false or a constLink to $expr in $class)

Parameters:

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

[ Top ]

method getCurrentPageLink [line 289]

void getCurrentPageLink( )



Overrides Converter::getCurrentPageLink() (parent method not documented)

[ Top ]

method getDefineLink [line 1549]

mixed getDefineLink( string $expr, string $package, [string $file = false], [boolean $text = false], boolean 4)



Tags:

return:  false if not found, or an html a link to the define's documentation
see:  Converter::getDefineLink()


Overrides Converter::getDefineLink() (return false or a defineLink to $expr)

Parameters:

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

[ Top ]

method getExampleLink [line 199]

void getExampleLink( $path, $title)



Parameters:

   $path  
   $title  

[ Top ]

method getFunctionLink [line 1533]

mixed getFunctionLink( string $expr, string $package, [string $file = false], [boolean $text = false], boolean 4)



Tags:

return:  false if not found, or an html a link to the function's documentation
see:  Converter::getFunctionLink()


Overrides Converter::getFunctionLink() (return false or a functionLink to $expr)

Parameters:

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

[ Top ]

method getGlobalLink [line 1565]

mixed getGlobalLink( string $expr, string $package, [string $file = false], [boolean $text = false], boolean 4)



Tags:

return:  false if not found, or an html a link to the global variable's documentation
see:  Converter::getGlobalLink()


Overrides Converter::getGlobalLink() (return false or a globalLink to $expr)

Parameters:

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

[ Top ]

method getId [line 591]

void getId( $element, [ $fullpath = true])



Overrides Converter::getId() (take abstractLink descendant and text $eltext and return a)

Parameters:

   $element  
   $fullpath  

[ Top ]

method getIndexInformation [line 1205]

array getIndexInformation( parserElement $elt)

Generate indexing information for given element



Tags:



Parameters:

parserElement   $elt   descendant of parserElement

[ Top ]

method getMethodLink [line 1598]

mixed getMethodLink( string $expr, string $class, string $package, [string $file = false], [boolean $text = false], boolean 5)



Tags:

return:  false if not found, or an html a link to the method's documentation
see:  Converter::getMethodLink()


Overrides Converter::getMethodLink() (return false or a methodLink to $expr in $class)

Parameters:

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

[ Top ]

method getPageLink [line 1581]

mixed getPageLink( string $expr, string $package, [string $path = false], [boolean $text = false], boolean 4)



Tags:

return:  false if not found, or an html a link to the procedural page's documentation
see:  Converter::getPageLink()


Overrides Converter::getPageLink() (return false or a pageLink to $expr)

Parameters:

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

[ Top ]

method getPageName [line 945]

void getPageName( &$element)



Parameters:

   &$element  

[ Top ]

method getRootTree [line 1134]

string getRootTree( array $tree, string $package, [ $noparent = false], boolean $nounknownparent)

return formatted class tree for the Class Trees page



Tags:

see:  Classes::$definitechild, CHMdefaultConverter::generateFormattedClassTrees()


Parameters:

array   $tree   output from getSortedClassTreeFromClass()
string   $package   package
boolean   $nounknownparent   if true, an object's parent will not be checked
   $noparent  

[ Top ]

method getSourceAnchor [line 220]

string getSourceAnchor( string $sourcefile, string $anchor, [string $text = ''], [boolean $link = false])

Retrieve a Converter-specific anchor to a segment of a source code file parsed via a @filesource tag.



Tags:

return:  link to an anchor, or the anchor


Parameters:

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

[ Top ]

method getSourceLink [line 204]

void getSourceLink( $path)



Overrides Converter::getSourceLink() (parent method not documented)

Parameters:

   $path  

[ Top ]

method getTutorialId [line 764]

void getTutorialId( $package, $subpackage, $tutorial, $id)



Overrides Converter::getTutorialId() (Return a converter-specific id to distinguish tutorials and their sections)

Parameters:

   $package  
   $subpackage  
   $tutorial  
   $id  

[ Top ]

method getVarLink [line 1615]

mixed getVarLink( string $expr, string $class, string $package, [string $file = false], [boolean $text = false], boolean 5)



Tags:

return:  false if not found, or an html a link to the var's documentation
see:  Converter::getVarLink()


Overrides Converter::getVarLink() (return false or a varLink to $expr in $class)

Parameters:

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

[ Top ]

method Output [line 1860]

void Output( )

Create the phpdoc.hhp, contents.hhc files needed by MS HTML Help Compiler to create a CHM file

The output function generates the table of contents (contents.hhc) and file list (phpdoc.hhp) files used to create a .CHM by the free MS HTML Help compiler. {@, a list of all separate .html files is created in CHM format, and written to phpdoc.hhp. This list was generated by writefile.

Next, a call to the table of contents:

  1.         phpDocumentor_out("NOTE: to create the documentation.chm file, you must now run Microsoft Help Workshop on phpdoc.hhp\n");
  2.         phpDocumentor_out("To get the free Microsoft Help Workshop, browse to: http://go.microsoft.com/fwlink/?LinkId=14188\n");

finishes things off}}




Tags:

link:  http://www.microsoft.com/downloads/release.asp?releaseid=33071
todo:  use to directly call html help compiler hhc.exe
uses:  CHMdefaultConverter::generateTOC() - assigns to the toc template variable


Overrides Converter::Output() (do all necessary output)

[ Top ]

method postProcess [line 297]

void postProcess( $text)

Uses htmlspecialchars() on the input



Overrides Converter::postProcess() (This version does nothing)

Parameters:

   $text  

[ Top ]

method ProgramExample [line 266]

string ProgramExample( string $example, [boolean $tutorial = false], [ $inlinesourceparse = null], [ $class = null], [ $linenum = null], [ $filesourcepath = null])

Used to convert the <code> tag in a docblock



Overrides Converter::ProgramExample() (Used to convert the <code> tag in a docblock)

Parameters:

string   $example  
boolean   $tutorial  
   $inlinesourceparse  
   $class  
   $linenum  
   $filesourcepath  

[ Top ]

method rcNatCmp [line 1646]

int rcNatCmp( mixed $a, mixed $b)

does a nat case sort on the specified second level value of the array



Parameters:

mixed   $a  
mixed   $b  

[ Top ]

method rcNatCmp1 [line 1662]

int rcNatCmp1( mixed $a, mixed $b)

does a nat case sort on the specified second level value of the array.

this one puts constructors first




Parameters:

mixed   $a  
mixed   $b  

[ Top ]

method returnLink [line 383]

string returnLink( string $link, string $text)



Tags:

return:  &lt;a href="'.$link.'">'.$text.'</a&gt;


Overrides Converter::returnLink() (take URL $link and text $text and return a link in the format needed for the Converter)

Parameters:

string   $link  
string   $text  

[ Top ]

method returnSee [line 561]

void returnSee( abstractLink &$element, [string $eltext = false], [boolean $with_a = true], boolean 3)

This function takes an abstractLink descendant and returns an html link



Overrides Converter::returnSee() (take abstractLink descendant and text $eltext and return a link)

Parameters:

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

[ Top ]

method setTargetDir [line 1406]

void setTargetDir( $dir)

calls the converter setTargetDir, and then copies any template images and the stylesheet if they haven't been copied



Tags:



Overrides Converter::setTargetDir() (Sets the output directory for generated documentation)

Parameters:

   $dir  

[ Top ]

method setTemplateDir [line 1355]

void setTemplateDir( $dir)



Overrides Converter::setTemplateDir() (sets the template directory based on the $outputformat and $name)

Parameters:

   $dir  

[ Top ]

method SmartyInit [line 318]

void &SmartyInit( &$templ)



Parameters:

   &$templ  

[ Top ]

method sourceLine [line 242]

string sourceLine( integer $linenumber, string $line, [false|string $path = false])

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




Tags:

return:  formatted source code line with line number


Overrides Converter::sourceLine() (Return a line of highlighted source code with formatted line number)

Parameters:

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.

[ Top ]

method TutorialExample [line 275]

void TutorialExample( string $example)



Overrides Converter::TutorialExample() (parent method not documented)

Parameters:

string   $example  

[ Top ]

method unmangle [line 144]

void unmangle( $sourcecode)



Tags:

deprecated:  in favor of PHP 4.3.0+ tokenizer-based source highlighting


Overrides Converter::unmangle() (Called by parserSourceInlineTag::stringConvert() to allow converters to format the source code the way they'd like.)

Parameters:

   $sourcecode  

[ Top ]

method writeExample [line 179]

void writeExample( $title, $path, $source)



Overrides Converter::writeExample() (Write out the formatted source code for an example php file)

Parameters:

   $title  
   $path  
   $source  

[ Top ]

method writefile [line 1692]

void writefile( $file, $contents)

Write a file to disk, and add it to the $hhp_files list of files to include in the generated CHM

  1. function writefile($file,$contents)
  2.     {
  3.         $this->addHHP($this->targetDir PATH_DELIMITER $file);
  4.         Converter::writefile($file,$contents);
  5.     }




Parameters:

   $file  
   $contents  

[ Top ]

method writeNewPPage [line 491]

void writeNewPPage( $key)



Parameters:

   $key  

[ Top ]

method writeSource [line 160]

void writeSource( string $path, string $value)



Overrides Converter::writeSource() (Write out the formatted source code for a php file)

Parameters:

string   $path   full path to the source file
string   $value   fully highlighted source code

[ Top ]


Documentation generated on Tue, 06 Dec 2011 07:10:22 -0600 by phpDocumentor 1.4.4