Class: PDFdefaultConverter
Source Location: /phpDocumentor/Converters/PDF/default/PDFdefaultConverter.inc
Class PDFdefaultConverter
Inherited Properties, Constants, and Methods
Property Summary
| array |
$_sourcecode |
Source files for appendix C are stored here |
Method Summary
| void |
Convert_RIC() |
Convert README/INSTALL/CHANGELOG file contents to output format |
| string |
getRootTree() |
return formatted class tree for the Class Trees page |
| void |
returnSee() |
Returns a bookmark using Cezpdf 009 |
| string |
TranslateTag() |
Used to translate an XML DocBook tag from a tutorial by reading the options.ini file for the template. |
Properties
default PDF Converter wants elements sorted by type as well as alphabetically
API Tags:
Redefinition of:
- 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
Source files for appendix C are stored here
Format: array(array(package => packagename, code => array(highlightedsource code 1, ...)))
Methods
PDFdefaultConverter PDFdefaultConverter(
&$allp,
&$packp,
&$classes,
&$procpages,
$po,
$pp,
$qm,
$targetDir,
$templateDir,
$title
)
|
|
Parameters:
|
|
&$allp: |
|
|
|
&$packp: |
|
|
|
&$classes: |
|
|
|
&$procpages: |
|
|
|
$po: |
|
|
|
$pp: |
|
|
|
$qm: |
|
|
|
$targetDir: |
|
|
|
$templateDir: |
|
|
|
$title: |
|
API Tags:
void convertConst(
&$element
)
|
|
Parameters:
Redefinition of:
- Converter::convertConst()
- Converts class constants for template output.
void convertDocBlock(
&$element
)
|
|
Parameters:
void convertGlobal(
&$element
)
|
|
Parameters:
Redefinition of:
- Converter::convertGlobal()
- Converts global variables for template output
void convertPackagepage(
&$element
)
|
|
Parameters:
API Tags:
void convertParams(
&$element
)
|
|
Parameters:
void convertVar(
&$element
)
|
|
Parameters:
Redefinition of:
- Converter::convertVar()
- Converts class variables for template output.
void Convert_RIC(
README|INSTALL|CHANGELOG
$name, string
$contents
)
|
|
Convert README/INSTALL/CHANGELOG file contents to output format
Parameters:
|
README|INSTALL|CHANGELOG |
$name: |
|
|
string |
$contents: |
contents of the file |
Redefinition of:
- Converter::Convert_RIC()
- Convert README/INSTALL/CHANGELOG file contents to output format
void generateFormattedClassTrees(
string
$package
)
|
|
returns a template-enabled array of class trees
Parameters:
|
string |
$package: |
package to generate a class tree for |
API Tags:
mixed getClassLink(
string
$expr, string
$package, [string
$file = false], [
$text = false]
)
|
|
Parameters:
|
string |
$expr: |
name of class |
|
string |
$package: |
package name |
|
string |
$file: |
full path to look in (used in index generation) |
|
|
$text: |
|
API Tags:
Redefinition of:
- Converter::getClassLink()
- return false or a classLink to $expr
mixed getConstLink(
string
$expr, string
$class, string
$package, [string
$file = false], [boolean
$text = false], boolean
5
)
|
|
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 |
API Tags:
Redefinition of:
- Converter::getConstLink()
- return false or a constLink to $expr in $class
mixed getDefineLink(
string
$expr, string
$package, [string
$file = false], [boolean
$text = false]
)
|
|
Parameters:
|
string |
$expr: |
name of define |
|
string |
$package: |
package name |
|
string |
$file: |
full path to look in (used in index generation) |
|
boolean |
$text: |
deprecated |
API Tags:
Redefinition of:
- Converter::getDefineLink()
- return false or a defineLink to $expr
void getExampleLink(
$path,
$title
)
|
|
Parameters:
void getFileSourceName(
$path, [
$anchor = '']
)
|
|
Parameters:
Redefinition of:
- Converter::getFileSourceName()
- Translate the path info into a unique file name for the highlighted source code.
mixed getFunctionLink(
string
$expr, string
$package, [string
$file = false], [boolean
$text = false]
)
|
|
Parameters:
|
string |
$expr: |
name of function |
|
string |
$package: |
package name |
|
string |
$file: |
full path to look in (used in index generation) |
|
boolean |
$text: |
deprecated |
API Tags:
Redefinition of:
- Converter::getFunctionLink()
- return false or a functionLink to $expr
mixed getGlobalLink(
string
$expr, string
$package, [string
$file = false], [boolean
$text = false]
)
|
|
Parameters:
|
string |
$expr: |
name of global variable |
|
string |
$package: |
package name |
|
string |
$file: |
full path to look in (used in index generation) |
|
boolean |
$text: |
deprecated |
API Tags:
Redefinition of:
- Converter::getGlobalLink()
- return false or a globalLink to $expr
void getGlobalValue(
$value
)
|
|
Parameters:
Redefinition of:
- Converter::getGlobalValue()
- Parse a global variable's default value for class initialization.
mixed getMethodLink(
string
$expr, string
$class, string
$package, [string
$file = false], [boolean
$text = false]
)
|
|
Parameters:
|
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 |
API Tags:
Redefinition of:
- Converter::getMethodLink()
- return false or a methodLink to $expr in $class
mixed getPageLink(
string
$expr, string
$package, [string
$path = false], [boolean
$text = false]
)
|
|
Parameters:
|
string |
$expr: |
name of procedural page |
|
string |
$package: |
package name |
|
string |
$path: |
full path to look in (used in index generation) |
|
boolean |
$text: |
deprecated |
API Tags:
Redefinition of:
- Converter::getPageLink()
- return false or a pageLink to $expr
void getPageName(
&$element
)
|
|
Parameters:
string getRootTree(
array
$tree,
$package
)
|
|
return formatted class tree for the Class Trees page
Parameters:
API Tags:
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.
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 |
API Tags:
| Return: | link to an anchor, or the anchor |
API Tags:
Redefinition of:
- Converter::getState()
- Return parserStringWithInlineTags::Convert() cache state
void getTutorialId(
$package,
$subpackage,
$tutorial,
$id
)
|
|
Parameters:
|
|
$package: |
|
|
|
$subpackage: |
|
|
|
$tutorial: |
|
|
|
$id: |
|
Redefinition of:
- Converter::getTutorialId()
- Return a converter-specific id to distinguish tutorials and their sections
mixed getVarLink(
string
$expr, string
$class, string
$package, [string
$file = false], [boolean
$text = false], boolean
5
)
|
|
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 |
API Tags:
Redefinition of:
- Converter::getVarLink()
- return false or a varLink to $expr in $class
void mystrnatcasecmp(
$a,
$b
)
|
|
Parameters:
void Output(
[
$title = 'Generated Documentation']
)
|
|
calls Cezpdf::ezOutput() and writes documentation.pdf to targetDir
Parameters:
Redefinition of:
- Converter::Output()
- do all necessary output
string returnLink(
string
$link, string
$text
)
|
|
Parameters:
|
string |
$link: |
|
|
string |
$text: |
|
API Tags:
| Return: | <c:alink:$link>$text</c:alink> |
Redefinition of:
- Converter::returnLink()
- take URL $link and text $text and return a link in the format needed for the Converter
void returnSee(
abstractLink
&$element, [string
$eltext = false]
)
|
|
Returns a bookmark using Cezpdf 009
Parameters:
|
abstractLink |
&$element: |
a descendant of abstractlink should be passed, and never text |
|
string |
$eltext: |
text to display in the link |
Redefinition of:
- Converter::returnSee()
- take abstractLink descendant and text $eltext and return a link
void setTemplateDir(
$dir
)
|
|
Parameters:
Redefinition of:
- Converter::setTemplateDir()
- sets the template directory based on the $outputformat and $name
string TranslateTag(
string
$name, string
$attr, string
$cdata, string
$unconvertedcdata
)
|
|
Used to translate an XML DocBook tag from a tutorial by reading the options.ini file for the template.
Parameters:
|
string |
$name: |
tag name |
|
string |
$attr: |
any attributes Format: array(name => value) |
|
string |
$cdata: |
the tag contents, if any |
|
string |
$unconvertedcdata: |
the tag contents, if any, unpost-processed |
Redefinition of:
- Converter::TranslateTag()
- Used to translate an XML DocBook tag from a tutorial by reading the options.ini file for the template.
void writeExample(
$title,
$path,
$source
)
|
|
Parameters:
Redefinition of:
- Converter::writeExample()
- Write out the formatted source code for an example php file
void writeSource(
$path,
$value
)
|
|
Parameters:
Redefinition of:
- Converter::writeSource()
- Write out the formatted source code for a php file
|
|
