Docs For Class parserXMLDocBookTag

parserXMLDocBookTag (Constructor) [line 119]

parserXMLDocBookTag parserXMLDocBookTag(
string
$name)

Parameters:

string $name — tag name

[ Top ]

add [line 356]

void add(
parserEntity|parserCData|parserXMLDocBookTag|string
$el)

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

All four kinds of data are added here

Overrides parserStringWithInlineTags::add() (equivalent to the . operator ($a = $b . $c))

Parameters:

parserEntity|parserCData|parserXMLDocBookTag|string $el — nested tag, entity, or text

[ Top ]

addAttribute [line 202]

void addAttribute(
string
$name, string|parserIdInlineTag
$value)

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 [line 190]

void addCData(
string
$word)

add a word to CData

Parameters:

string $word —

[ Top ]

Convert [line 130]

void Convert(
Converter
&$c, [boolean
$postprocess = true])

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`	—
boolean	`$postprocess`	—

[ Top ]

endCData [line 157]

void endCData(
)

Adds $_cdata to $value

[ Top ]

getId [line 247]

string getId(
Converter
&$c)

Return converter-specific formatting of ID.

Passes $c to parserIdInlineTag::Convert()

Parameters:

Converter &$c —

[ Top ]

getSubsection [line 317]

void getSubsection(
Converter
&$c, string
$subsection)

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`	—
string	`$subsection`	—	converter-specific subsection

[ Top ]

getTitle [line 266]

string getTitle(
Converter
&$c)

Retrieve Converter-specific formatting of the title of this element

Parameters:

Converter &$c —

[ Top ]

getTOC [line 171]

void getTOC(
[false|integer
$state = false])

Retrieve either the table of contents index, or the location that

the TOC will go

See: parserXMLDocBookTag::setTOC()

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 [line 256]

boolean hasTitle(
)

Determine whether the docbook element has a title

[ Top ]

setId [line 235]

void setId(
parserIdInlineTag
$id)

If the id attribute is present, this method will set its id

Parameters:

parserIdInlineTag $id —

[ Top ]

setTitle [line 226]

void setTitle(
parserXMLDocBookTag
$title)

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 [line 181]

void setTOC(
integer
$state, parserTocInlineTag
$val)

Parameters:

integer	`$state`	—	index of the TOC in $this->value
parserTocInlineTag	`$val`	—

[ Top ]

startCData [line 149]

void startCData(
)

Begin a new CData section

See: parserXMLDocBookTag::addCData()

[ Top ]

Class: parserXMLDocBookTag

Class Overview

Author(s):

Version:

Variables

Methods

Inherited Variables

Class: parserStringWithInlineTags

Inherited Methods

Class: parserStringWithInlineTags

Class: parserBase

Class Details

Class Variables

$attributes = array()

$name =

Method Detail

parserXMLDocBookTag (Constructor) [line 119]

Parameters:

add [line 356]

Parameters:

addAttribute [line 202]

Parameters:

addCData [line 190]

Parameters:

Convert [line 130]

Parameters:

endCData [line 157]

getId [line 247]

Parameters:

getSubsection [line 317]

Parameters:

getTitle [line 266]

Parameters:

getTOC [line 171]

Parameters:

hasTitle [line 256]

setId [line 235]

Parameters:

setTitle [line 226]

Parameters:

setTOC [line 181]

Parameters:

startCData [line 149]