Class: parserIdInlineTag

Source Location: /phpDocumentor/InlineTags.inc

Class parserIdInlineTag

Class Overview

Represents the inline {@id} tag for tutorials

Located in /phpDocumentor/InlineTags.inc [line 835]

parserBase
   |
   --parserInlineTag
      |
      --parserIdInlineTag

Author(s):

Gregory Beaver <[email protected]>

API Tags:

See:

parserStringWithInlineTags

Information Tags:

Tutorial:	inline {@id}
Version:	Release: @VER@
Copyright:	2002-2008 Gregory Beaver
Link:	http://www.phpdoc.org
Link:	http://pear.php.net/PhpDocumentor
Todo:	CS cleanup - change classname to PhpDocumentor_*
Todo:	CS cleanup - change package to PhpDocumentor
License:	LGPL

Properties

Methods

[ Top ]

Inherited Properties, Constants, and Methods

Inherited Properties

Inherited Methods

Inherited Constants

Inherited From parserInlineTag

parserInlineTag::$type

Inherited From parserBase

parserBase::$value

Inherited From parserInlineTag

parserInlineTag::parserInlineTag()

sets up the tag

parserInlineTag::getString()

always gets an empty string

parserInlineTag::Strlen()

get length of the tag

Inherited From parserBase

parserBase::getType()

gets the type

parserBase::getValue()

gets the value

parserBase::setValue()

sets the given value

[ Top ]

Property Summary

string	$category	category of the {@id}
string	$id	section/subsection name
string	$inlinetype	always 'id'
string	$package	package of the {@id}
string	$subpackage	subpackage of the {@id}
string	$tutorial	full name of the tutorial

[ Top ]

Method Summary

parserIdInlineTag	parserIdInlineTag()	constructor
string	Convert()	converter

[ Top ]

Properties

string $category = 'default' [line 851]

category of the {@id}

[ Top ]

string $id [line 866]

section/subsection name

[ Top ]

string $inlinetype = 'id' [line 841]

always 'id'

Redefinition of:

parserInlineTag::$inlinetype: the name of the inline tag (like link)

[ Top ]

string $package = 'default' [line 846]

package of the {@id}

[ Top ]

string $subpackage = '' [line 856]

subpackage of the {@id}

[ Top ]

string $tutorial [line 861]

full name of the tutorial

[ Top ]

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 ]

Convert [line 895]

string Convert(
Converter
&$c 
)

converter

Parameters:

Converter

&$c:

output converter

API Tags:

Uses:

Converter::getTutorialId() - retrieve converter-specific ID

Information Tags:

Todo:

CS cleanup - rename to convert for camelCase rule

[ Top ]

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

	phpDocumentor InlineTags

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