Inherited Methods
Class: parserStringWithInlineTags
- parserStringWithInlineTags::add()
- equivalent to the . operator ($a = $b . $c)
- parserStringWithInlineTags::Convert()
- Use to convert the string to a real string with all inline tags parsed and linked
- 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)
- parserStringWithInlineTags::hasInlineTag()
- Determine whether the string contains any inline tags
- parserStringWithInlineTags::setSource()
- Pass source code to any {@source} tags contained within the string for later conversion.
- parserStringWithInlineTags::trimmedStrlen()
- equivalent to trim(strlen($string))
Class: parserBase
- parserBase::getType()
- gets the type
- parserBase::getValue()
- gets the value
- parserBase::setValue()
- sets the given value
Class Details
a standard XML DocBook Tag
This class is designed to represent all DocBook tags. It is intelligent enough to understand the <title> tag, and also the <refname> tag for as title for <refentry>
Tags:
- tutorial - phpDocumentor Tutorials
- author - Gregory Beaver <[email protected]>
- version - Release: @VER@
- copyright - 2002-2008 Gregory Beaver
- link - http://pear.php.net/PhpDocumentor
- link - http://www.phpdoc.org
- todo - CS cleanup - change package to PhpDocumentor
- todo - CS cleanup - change classname to PhpDocumentor_*
- todo - CS cleanup - rename to parserXmlDocBookTag for camelCase rule
- since - 1.2
- license - LGPL
[ Top ]
Class Variables
$attributes = array()
[line 130]
Attributes from the XML tag
Format: array(attrname => attrvalue, attrname => attrvalue,...)
Type: array
Overrides:
[ Top ]
$name
[line 135]
Name of the tag
Type: string
Overrides:
[ Top ]
Class Methods
parserXMLDocBookTag
parserXMLDocBookTag parserXMLDocBookTag(
string
$name)
[line 165]
sets up the tag
Tags:
- todo - CS cleanup - rename to parserXmlDocBookTag for camelCase rule
Parameters:
- string $name - tag name
[ Top ]
add
mixed add(
parserEntity|parserCData|parserXMLDocBookTag|string
$el)
[line 443]
Add contents to this tag.
There are four kinds of data in a DocBook tutorial:
- tags - normal tags like <refentry>
- entities - normal entities like ”
- <![CDATA[ - character data that should not be interpreted, like <programlisting> contents
- text - normal non-markup text
Overrides parserStringWithInlineTags::add() (equivalent to the . operator ($a = $b . $c))
Parameters:
- parserEntity|parserCData|parserXMLDocBookTag|string $el - nested tag, entity, or text
[ Top ]
addAttribute
void addAttribute(
string
$name, string|parserIdInlineTag
$value)
[line 271]
Add an xml tag attribute name="value" pair
if the attribute is id, value must be a parserIdInlineTag
Parameters:
- string $name - attribute name
- string|parserIdInlineTag $value - value of attribute
[ Top ]
addCData
void addCData(
string
$word)
[line 256]
add a word to CData
Parameters:
- string $word - word to add
[ Top ]
Convert
string Convert(
Converter
&$c, [bool
$postprocess = true])
[line 180]
calls the output conversion
Tags:
- uses - Converter::TranslateTag() - Calls this to enclose the contents of the DocBook tag based on the values in template options.ini file
Overrides parserStringWithInlineTags::Convert() (Use to convert the string to a real string with all inline tags parsed and linked)
Parameters:
- Converter &$c - the output converter
- bool $postprocess - if postprocessing is needed
[ Top ]
endCData
void endCData(
)
[line 211]
Adds $_cdata to $value
Parameters:
[ Top ]
getId
string getId(
Converter
&$c)
[line 323]
Return converter-specific formatting of ID.
Passes $c to parserIdInlineTag::Convert()
Parameters:
- Converter &$c - the output converter
[ Top ]
getSubsection
bool|string getSubsection(
Converter
&$c, string
$subsection)
[line 401]
Retrieve the contents of a subsection
This method uses the $_id members of nested docbook tags to retrieve the section defined by $subsection
Parameters:
- Converter &$c - the output converter
- string $subsection - converter-specific subsection
[ Top ]
getTitle
string getTitle(
Converter
&$c)
[line 347]
Retrieve Converter-specific formatting of the title of this element
Parameters:
- Converter &$c - the output converter
[ Top ]
getTOC
int getTOC(
[false|integer
$state = false])
[line 228]
Retrieve either the table of contents index, or the location that the TOC will go
Tags:
Parameters:
- false|integer $state - either an index of the {@toc} tag in $this->value or false, if the next index value of $this->value is needed
[ Top ]
hasTitle
boolean hasTitle(
)
[line 335]
Determine whether the docbook element has a title
Parameters:
[ Top ]
setId
void setId(
parserIdInlineTag
$id)
[line 309]
If the id attribute is present, this method will set its id
Parameters:
- parserIdInlineTag $id - the id value
[ Top ]
setTitle
void setTitle(
parserXMLDocBookTag
$title)
[line 297]
Set the title of a DocBook tag section.
For most DocBook tags, the title is represented with a <title></title> tag pair. The <refentry> top-level tag is a little different. Instead of using <title></title>, phpDocumentor uses the contents of the <refname> tag in the <refnamediv> tag
Parameters:
- parserXMLDocBookTag $title - the title element
[ Top ]
setTOC
void setTOC(
integer
$state, parserTocInlineTag
$val)
[line 244]
sets the TOC value
Parameters:
- integer $state - index of the TOC in $this->value
- parserTocInlineTag $val - tag value
[ Top ]
startCData
void startCData(
)
[line 201]
Begin a new CData section
Tags:
Parameters:
[ Top ]