Class parserIdInlineTag

Description

Represents the inline {@id} tag for tutorials

Located in /phpDocumentor/InlineTags.inc (line 835)

parserBase
   |
   --parserInlineTag
      |
      --parserIdInlineTag
Variable Summary
string $category
string $id
string $inlinetype
string $package
string $subpackage
string $tutorial
Method Summary
parserIdInlineTag parserIdInlineTag (string $category, string $package, string $subpackage, string $tutorial, [string $id = false])
string Convert (Converter &$c)
Variables
string $category = 'default' (line 851)

category of the {@id}

string $id (line 866)

section/subsection name

string $inlinetype = 'id' (line 841)

always 'id'


Redefinition of:
parserInlineTag::$inlinetype
the name of the inline tag (like link)
string $package = 'default' (line 846)

package of the {@id}

string $subpackage = '' (line 856)

subpackage of the {@id}

string $tutorial (line 861)

full name of the tutorial

Inherited Variables

Inherited from parserInlineTag

parserInlineTag::$type

Inherited from parserBase

parserBase::$value
Methods
Constructor parserIdInlineTag (line 877)

constructor

parserIdInlineTag parserIdInlineTag (string $category, string $package, string $subpackage, string $tutorial, [string $id = false])
  • string $category: category name
  • string $package: package name
  • string $subpackage: subpackage name
  • string $tutorial: tutorial name
  • string $id: section/subsection name
Convert (line 895)

converter

string Convert (Converter &$c)

Inherited Methods

Inherited From parserInlineTag

parserInlineTag::parserInlineTag()
parserInlineTag::getString()
parserInlineTag::Strlen()

Inherited From parserBase

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

Documentation generated on Mon, 05 Dec 2011 21:16:54 -0600 by phpDocumentor 1.4.4