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

parserBase
   |
   --parserStringWithInlineTags
      |
      --parserXMLDocBookTag

Author(s):

Gregory Beaver <[email protected]>

Information Tags:

Tutorial:	phpDocumentor Tutorials
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

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

Inherited From parserBase

parserBase::getType()

gets the type

parserBase::getValue()

gets the value

parserBase::setValue()

sets the given value

[ Top ]

Property Summary

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

[ Top ]

Method Summary

parserXMLDocBookTag	parserXMLDocBookTag()	sets up the tag
mixed	add()	Add contents to this tag.
void	addAttribute()	Add an xml tag attribute name="value" pair
void	addCData()	add a word to CData
string	Convert()	calls the output conversion
void	endCData()	Adds $_cdata to $value
string	getId()	Return converter-specific formatting of ID.
bool\|string	getSubsection()	Retrieve the contents of a subsection
string	getTitle()	Retrieve Converter-specific formatting of the title of this element
int	getTOC()	Retrieve either the table of contents index, or the location that the TOC will go
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()	sets the TOC value
void	startCData()	Begin a new CData section

[ Top ]

Properties

array $attributes = array() [line 130]

Attributes from the XML tag

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

[ Top ]

string $name [line 135]

Name of the tag

[ Top ]

Methods

Constructor parserXMLDocBookTag [line 165]

parserXMLDocBookTag parserXMLDocBookTag(
string
$name 
)

sets up the tag

Parameters:

string

$name:

tag name

Information Tags:

Todo:

CS cleanup - rename to parserXmlDocBookTag for camelCase rule

[ Top ]

add [line 443]

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

[ Top ]

addCData [line 256]

void addCData(
string
$word 
)

add a word to CData

Parameters:

string

$word:

word to add

[ Top ]

Convert [line 180]

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

calls the output conversion

Parameters:

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

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

void endCData(
)

Adds $_cdata to $value

[ Top ]

getId [line 323]

string getId(
Converter
&$c 
)

Return converter-specific formatting of ID.

Passes $c to parserIdInlineTag::Convert()

Parameters:

Converter

&$c:

the output converter

[ Top ]

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

[ Top ]

getTitle [line 347]

string getTitle(
Converter
&$c 
)

Retrieve Converter-specific formatting of the title of this element

Parameters:

Converter

&$c:

the output converter

[ Top ]

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

API Tags:

See:

parserXMLDocBookTag::setTOC()

[ Top ]

hasTitle [line 335]

boolean hasTitle(
)

Determine whether the docbook element has a title

[ Top ]

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

[ Top ]

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

Parameters:

parserXMLDocBookTag

$title:

the title element

[ Top ]

setTOC [line 244]

void setTOC(
integer
$state, parserTocInlineTag
$val 
)

sets the TOC value

Parameters:

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

[ Top ]

startCData [line 201]

void startCData(
)

Begin a new CData section

API Tags:

See:

parserXMLDocBookTag::addCData()

[ Top ]

Documentation generated on Tue, 06 Dec 2011 07:20:36 -0600 by phpDocumentor 1.4.4

	phpDocumentor Tutorial

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