Class parserIdInlineTag

(line 835)

Description

parserBase
   |
   --parserInlineTag
      |
      --parserIdInlineTag

Located in File: /phpDocumentor/InlineTags.inc

Represents the inline {@id} tag for tutorials


Class Variables

Summary:
string $category
string $id
string $inlinetype
string $package
string $subpackage
string $tutorial

$category = 'default' (line 851)

Data type : string

category of the {@id}

$id (line 866)

Data type : string

section/subsection name

$inlinetype = 'id' (line 841)

Data type : string

Overrides: Array

always 'id'

$package = 'default' (line 846)

Data type : string

package of the {@id}

$subpackage = '' (line 856)

Data type : string

subpackage of the {@id}

$tutorial (line 861)

Data type : string

full name of the tutorial

Class Constants

Summary:

Method Detail

Summary:
parserIdInlineTag parserIdInlineTag (string $category, string $package, string $subpackage, string $tutorial, [string $id = false])
string Convert (Converter &$c)

Constructor parserIdInlineTag (line 877)

parserIdInlineTag parserIdInlineTag( string $category, string $package, string $subpackage, string $tutorial, [string $id = false])

constructor

Parameters

  • string $category: category name
  • string $package: package name
  • string $subpackage: subpackage name
  • string $tutorial: tutorial name
  • string $id: section/subsection name

Info

Method Convert (line 895)

string Convert( Converter &$c)

converter

Parameters

Info

Inherited Variables

Inherited Class Variable Summary

Inherited From Class parserInlineTag

parserInlineTag::$type - Element type

Inherited From Class parserBase

parserBase::$value - set to different things by its descendants

Inherited Methods

Inherited Method Summary

Inherited From Class parserInlineTag

parserInlineTag::parserInlineTag() - sets up the tag

parserInlineTag::getString() - always gets an empty string

parserInlineTag::Strlen() - get length of the tag


Inherited From Class parserBase

parserBase::getType() - gets the type

parserBase::getValue() - gets the value

parserBase::setValue() - sets the given value



Documentation generated on Mon, 05 Dec 2011 21:28:04 -0600 by phpDocumentor 1.4.4