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

Class: parserXMLDocBookTag

Source Location: /phpDocumentor/PackagePageElements.inc

Class Overview

parserBase
   |
   --parserStringWithInlineTags
      |
      --parserXMLDocBookTag

a standard XML DocBook Tag


Author(s):

Version:

  • Release: @VER@

Copyright:

  • 2002-2008 Gregory Beaver

Variables

Methods


Inherited Variables

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

Class: parserBase

parserBase::getType()
gets the type
parserBase::getValue()
gets the value
parserBase::setValue()
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>




Tags:

tutorial:  phpDocumentor Tutorials
author:  Gregory Beaver <cellog@php.net>
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


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



Class Methods


constructor parserXMLDocBookTag [line 165]

parserXMLDocBookTag parserXMLDocBookTag( string $name)

sets up the tag



Tags:

todo:  CS cleanup - rename to parserXmlDocBookTag for camelCase rule


Parameters:

string   $name   tag name

[ Top ]

method 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:

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

Parameters:

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

[ Top ]

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

[ Top ]

method addCData [line 256]

void addCData( string $word)

add a word to CData



Parameters:

string   $word   word to add

[ Top ]

method Convert [line 180]

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

calls the output conversion



Tags:

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)

Parameters:

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

[ Top ]

method endCData [line 211]

void endCData( )

Adds $_cdata to $value



[ Top ]

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

[ Top ]

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

[ Top ]

method getTitle [line 347]

string getTitle( Converter &$c)

Retrieve Converter-specific formatting of the title of this element



Parameters:

Converter   &$c   the output converter

[ Top ]

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



Tags:



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

[ Top ]

method hasTitle [line 335]

boolean hasTitle( )

Determine whether the docbook element has a title



[ Top ]

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

[ Top ]

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




Parameters:

parserXMLDocBookTag   $title   the title element

[ Top ]

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

method startCData [line 201]

void startCData( )

Begin a new CData section



Tags:



[ Top ]


Documentation generated on Tue, 06 Dec 2011 07:14:23 -0600 by phpDocumentor 1.4.4