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

Class: parserIdInlineTag

Source Location: /phpDocumentor/InlineTags.inc

Class Overview

parserBase
   |
   --parserInlineTag
      |
      --parserIdInlineTag

Represents the inline [email protected]} tag for tutorials


Author(s):

Version:

  • Release: @VER@

Copyright:

  • 2002-2008 Gregory Beaver

Variables

Methods


Inherited Variables

Inherited Methods

Class: parserInlineTag

parserInlineTag::parserInlineTag()
sets up the tag
parserInlineTag::getString()
always gets an empty string
parserInlineTag::Strlen()
get length of the tag

Class: parserBase

parserBase::getType()
gets the type
parserBase::getValue()
gets the value
parserBase::setValue()
sets the given value

Class Details

[line 835]
Represents the inline [email protected]} tag for tutorials



Tags:



[ Top ]


Class Variables

$category =  'default'

[line 851]

category of the [email protected]}


Type:   string


[ Top ]

$id =

[line 866]

section/subsection name


Type:   string


[ Top ]

$inlinetype =  'id'

[line 841]

always 'id'


Type:   string
Overrides:   Array


[ Top ]

$package =  'default'

[line 846]

package of the [email protected]}


Type:   string


[ Top ]

$subpackage =  ''

[line 856]

subpackage of the [email protected]}


Type:   string


[ Top ]

$tutorial =

[line 861]

full name of the tutorial


Type:   string


[ Top ]



Class Methods


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

[ Top ]

method Convert [line 895]

string Convert( Converter &$c)

converter



Tags:

todo:  CS cleanup - rename to convert for camelCase rule
uses:  Converter::getTutorialId() - retrieve converter-specific ID


Parameters:

Converter   &$c   output converter

[ Top ]


Documentation generated on Tue, 06 Dec 2011 07:13:50 -0600 by phpDocumentor 1.4.4