Class: parserXMLDocBookTag

Source Location: /phpDocumentor/PackagePageElements.inc

Class parserXMLDocBookTag

Class Overview

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>

Located in /phpDocumentor/PackagePageElements.inc [line 89]

parserBase
   |
   --parserStringWithInlineTags
      |
      --parserXMLDocBookTag

Author(s):

Greg Beaver <[email protected]>

Information Tags:

Version:	$Id: ParserData.inc,v 1.6 2006/10/23 04:02:46 cellog Exp $
Since:	1.2

Properties

Methods

[ Top ]

Inherited Properties, Constants, and Methods

Inherited Properties

Inherited Methods

Inherited Constants

Inherited From parserStringWithInlineTags

parserStringWithInlineTags::$type

parserStringWithInlineTags::$value

Inherited From 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

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))

Inherited From parserBase

parserBase::getType()

parserBase::getValue()

parserBase::setValue()

[ Top ]

Property Summary

array	$attributes	Attributes from the XML tag
string	$name	Name of the tag

[ Top ]

Method Summary

parserXMLDocBookTag	parserXMLDocBookTag()
void	add()	Add contents to this tag.
void	addAttribute()	Add an xml tag attribute name="value" pair
void	addCData()	add a word to CData
void	Convert()
void	endCData()	Adds $_cdata to $value
string	getId()	Return converter-specific formatting of ID.
void	getSubsection()	Retrieve the contents of a subsection
string	getTitle()	Retrieve Converter-specific formatting of the title of this element
void	getTOC()	Retrieve either the table of contents index, or the location that
boolean	hasTitle()	Determine whether the docbook element has a title
void	setId()	If the id attribute is present, this method will set its id
void	setTitle()	Set the title of a DocBook tag section.
void	setTOC()
void	startCData()	Begin a new CData section

[ Top ]

Properties

array $attributes = array() [line 97]

Attributes from the XML tag

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

[ Top ]

string $name [line 102]

Name of the tag

[ Top ]

Methods

Constructor parserXMLDocBookTag [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

Parameters:

parserEntity|parserCData|parserXMLDocBookTag|string

$el:

nested tag, entity, or text

Redefinition of:

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

[ 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] 
)

Parameters:

Converter	&$c:
boolean	$postprocess:

API Tags:

Uses:

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

Redefinition of:

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

[ 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

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

API Tags:

See:

parserXMLDocBookTag::setTOC()

[ 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

API Tags:

See:

parserXMLDocBookTag::addCData()

[ Top ]

Documentation generated on Tue, 24 Oct 2006 09:24:10 -0500 by phpDocumentor 1.3.1

	phpDocumentor Tutorial

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