Docs For Class parserXMLDocBookTag

Description

parserBase
   |
   --parserStringWithInlineTags
      |
      --parserXMLDocBookTag

Located in File: /phpDocumentor/PackagePageElements.inc

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>

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

Class Variables

Summary:

array $attributes

string $name

$attributes = array() (line 130)

Data type : array

Attributes from the XML tag

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

$name (line 135)

Data type : string

Name of the tag

Class Constants

Summary:

Method Detail

Summary:

parserXMLDocBookTag parserXMLDocBookTag (string $name)

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

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

void addCData (string $word)

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

void endCData ()

string getId (Converter &$c)

bool|string getSubsection (Converter &$c, string $subsection)

string getTitle (Converter &$c)

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

boolean hasTitle ()

void setId (parserIdInlineTag $id)

void setTitle (parserXMLDocBookTag $title)

void setTOC (integer $state, parserTocInlineTag $val)

void startCData ()

Constructor parserXMLDocBookTag (line 165)

parserXMLDocBookTag parserXMLDocBookTag( string $name)

sets up the tag

Parameters

string $name: tag name

Info

todo - CS cleanup - rename to parserXmlDocBookTag for camelCase rule

Method add (line 443)

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

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

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

Parameters

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

Info

Method addAttribute (line 271)

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

Info

Method addCData (line 256)

void addCData( string $word)

add a word to CData

Parameters

string $word: word to add

Info

Method Convert (line 180)

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

Overrides : parserStringWithInlineTags::Convert() Use to convert the string to a real string with all inline tags parsed and linked

calls the output conversion

Parameters

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

Info

uses - Converter::TranslateTag() - Calls this to enclose the contents of the DocBook tag based on the values in template options.ini file

Method endCData (line 211)

void endCData( )

Adds $_cdata to $value

Info

Method getId (line 323)

string getId( Converter &$c)

Return converter-specific formatting of ID.

Passes $c to parserIdInlineTag::Convert()

Parameters

Converter &$c: the output converter

Info

Method getSubsection (line 401)

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

Parameters

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

Info

Method getTitle (line 347)

string getTitle( Converter &$c)

Retrieve Converter-specific formatting of the title of this element

Parameters

Converter &$c: the output converter

Info

Method getTOC (line 228)

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

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

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

Info

see - parserXMLDocBookTag::setTOC()

Method hasTitle (line 335)

boolean hasTitle( )

Determine whether the docbook element has a title

Info

Method setId (line 309)

void setId( parserIdInlineTag $id)

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

Parameters

parserIdInlineTag $id: the id value

Info

Method setTitle (line 297)

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