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

Class: parserXMLDocBookTag

Source Location: /PhpDocumentor-1.5.0a1/phpDocumentor/

Class Overview


a standard XML DocBook Tag



  • Release: 1.5.0a1


  • 2002-2008 Gregory Beaver



Inherited Variables

Inherited Methods

Class: parserStringWithInlineTags

equivalent to the . operator ($a = $b . $c)
Use to convert the string to a real string with all inline tags parsed and linked
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)
Determine whether the string contains any inline tags
Pass source code to any {@source} tags contained within the string for later conversion.
equivalent to trim(strlen($string))

Class: parserBase

gets the type
gets the value
sets the given value

Class Details

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

[ Top ]

Class Variables

$attributes = array()

[line 130]

Attributes from the XML tag

Format: array(attrname => attrvalue, attrname => attrvalue,...)

Type:   array

[ Top ]

$name =

[line 135]

Name of the tag

Type:   string

[ Top ]

Method Detail

parserXMLDocBookTag (Constructor)   [line 165]

parserXMLDocBookTag parserXMLDocBookTag( string $name)

sets up the tag
  • Todo: CS cleanup - rename to parserXmlDocBookTag for camelCase rule


string   $name     tag name

[ Top ]

add   [line 469]

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

Add contents to this tag.

There are four kinds of data in a DocBook tutorial:

  1. tags - normal tags like <refentry>
  2. entities - normal entities like &rdquo;
  3. <![CDATA[ - character data that should not be interpreted, like <programlisting> contents
  4. text - normal non-markup text
All four kinds of data are added here

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


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

[ Top ]

addAttribute   [line 297]

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


string   $name     attribute name
string|parserIdInlineTag   $value     value of attribute

[ Top ]

addCData   [line 282]

void addCData( string $word)

add a word to CData


string   $word     word to add

[ Top ]

Convert   [line 180]

string Convert( Converter &$c, [bool $postprocess = true])

calls the output conversion
  • 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)


Converter   &$c     the output converter
bool   $postprocess     if postprocessing is needed

[ Top ]

endCData   [line 237]

void endCData( )

Adds $_cdata to $value

[ Top ]

getId   [line 349]

string getId( Converter &$c)

Return converter-specific formatting of ID.

Passes $c to parserIdInlineTag::Convert()


Converter   &$c     the output converter

[ Top ]

getSubsection   [line 427]

bool|string 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


Converter   &$c     the output converter
string   $subsection     converter-specific subsection

[ Top ]

getTitle   [line 373]

string getTitle( Converter &$c)

Retrieve Converter-specific formatting of the title of this element


Converter   &$c     the output converter

[ Top ]

getTOC   [line 254]

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

Retrieve either the table of contents index, or the location that the TOC will go


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 361]

boolean hasTitle( )

Determine whether the docbook element has a title

[ Top ]

setId   [line 335]

void setId( parserIdInlineTag $id)

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


parserIdInlineTag   $id     the id value

[ Top ]

setTitle   [line 323]

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


parserXMLDocBookTag   $title     the title element

[ Top ]

setTOC   [line 270]

void setTOC( integer $state, parserTocInlineTag $val)

sets the TOC value


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

[ Top ]

startCData   [line 227]

void startCData( )

Begin a new CData section

[ Top ]

Documentation generated on Sun, 02 Sep 2012 00:02:10 +0000 by phpDocumentor 1.4.3. PEAR Logo Copyright © PHP Group 2004.