Class: parserXMLDocBookTag

Source Location: /PhpDocumentor-1.2.0beta2/phpDocumentor/PackagePageElements.inc

Class Overview

parserBase
   |
   --parserStringWithInlineTags
      |
      --parserXMLDocBookTag

a standard XML DocBook Tag

Author(s):

Greg Beaver <mailto:cellog at users.sourceforge.net>

Version:

$Id: ParserData.inc,v 1.72 2003/01/17 07:01:29 CelloG Exp $

Variables

Methods

Inherited Variables

Class: parserStringWithInlineTags

parserStringWithInlineTags::$cache
parserStringWithInlineTags::$type
parserStringWithInlineTags::$value

Class: parserBase

parserBase::$linenum

Inherited Methods

Class: 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
parserStringWithInlineTags::setSource()
parserStringWithInlineTags::trimmedStrlen(): equivalent to trim(strlen($string))

Class: parserBase

parserBase::getType()
parserBase::getValue()
parserBase::setLineNum()
parserBase::setValue()

Class Details

[line 31]
a standard XML DocBook Tag

This class is designed to represent uncomplicated DocBook tags like abbrev and blockquote that have no subtags beyond title

Version: $Id: ParserData.inc,v 1.72 2003/01/17 07:01:29 CelloG Exp $
Author: Greg Beaver <mailto:cellog@users.sourceforge.net>
Since: 1.2

[ Top ]

Class Variables

$attributes = array()

[line 39]

Attributes from the XML tag

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

Type:

array

[ Top ]

$name =

[line 44]

Name of the tag

Type:

string

[ Top ]

Method Detail

parserXMLDocBookTag (Constructor) [line 52]

parserXMLDocBookTag parserXMLDocBookTag(
mixed
$name)

[ Top ]

add [line 190]

void add(
mixed
$el)

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

[ Top ]

addAttribute [line 101]

void addAttribute(
mixed
$name, mixed
$value)

[ Top ]

addCData [line 96]

void addCData(
mixed
$word)

[ Top ]

Convert [line 60]

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

Uses: Converter::TranslateTag()

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

[ Top ]

endCData [line 79]

void endCData(
)

[ Top ]

getId [line 117]

void getId(
mixed
&$c)

[ Top ]

getSubsection [line 168]

void getSubsection(
mixed
&$c, mixed
$subsection)

[ Top ]

getTitle [line 130]

void getTitle(
Converter
&$c)

Parameters:

Converter &$c —

[ Top ]

getTOC [line 85]

void getTOC(
[mixed
$state = false])

[ Top ]

hasTitle [line 122]

void hasTitle(
)

[ Top ]

setId [line 112]

void setId(
mixed
$id)

[ Top ]

setTitle [line 107]

void setTitle(
mixed
$title)

[ Top ]

setTOC [line 91]

void setTOC(
mixed
$state, mixed
$val)

[ Top ]

startCData [line 74]

void startCData(
)

[ Top ]