Class: parserIdInlineTag

Source Location: /phpDocumentor/InlineTags.inc

Class Overview [line 835]

parserBase
   |
   --parserInlineTag
      |
      --parserIdInlineTag

Represents the inline {@id} tag for tutorials

Author(s):

Version:

  • Release: @VER@

Copyright:

  • 2002-2008 Gregory Beaver

Variables

Constants

Methods


Inherited Variables

Inherited Constants

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

Represents the inline {@id} tag for tutorials

Tags:

[ Top ]


Class Variables

$category =  'default'

[line 851]

category of the {@id}

Type: string

Overrides:

[ Top ]

$id

[line 866]

section/subsection name

Type: string

Overrides:

[ Top ]

$inlinetype =  'id'

[line 841]

always 'id'

Type: string

Overrides: Array

[ Top ]

$package =  'default'

[line 846]

package of the {@id}

Type: string

Overrides:

[ Top ]

$subpackage =  ''

[line 856]

subpackage of the {@id}

Type: string

Overrides:

[ Top ]

$tutorial

[line 861]

full name of the tutorial

Type: string

Overrides:

[ Top ]


Class Methods

parserIdInlineTag

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

[line 877]

constructor

Parameters:

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

[ Top ]

Convert

string Convert( Converter &$c)

[line 895]

converter

Tags:

Parameters:

[ Top ]


Class Constants


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