Class: parserNameTag

Source Location: /phpDocumentor/DocBlockTags.inc

Class Overview [line 203]

This class represents the @name tag

Author(s):

Version:

  • Release: @VER@

Copyright:

  • 2002-2008 Gregory Beaver

Variables

Constants

Methods


Inherited Variables

Inherited Constants

Inherited Methods

Class: parserTag

parserTag::parserTag()
Set up the tag
parserTag::Convert()
Perform the output conversion on this parserTag using the output converter that is passed in
parserTag::getString()
Returns the text minus any inline tags
parserTag::HandleEvent()
Called by the parserDescParser when processing a description.

Class: parserStringWithInlineTags

parserStringWithInlineTags::add()
equivalent to the . operator ($a = $b . $c)
parserStringWithInlineTags::Convert()
Use to convert the string to a real string with all inline tags parsed and linked
parserStringWithInlineTags::getString()
return the string unconverted (all inline tags are taken out - this should only be used in pre-parsing to see if any other text is in the string)
parserStringWithInlineTags::hasInlineTag()
Determine whether the string contains any inline tags
parserStringWithInlineTags::setSource()
Pass source code to any {@source} tags contained within the string for later conversion.
parserStringWithInlineTags::trimmedStrlen()
equivalent to trim(strlen($string))

Class: parserBase

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


Class Details

This class represents the @name tag

Tags:

[ Top ]


Class Variables

$keyword =  'name'

[line 209]

tag name

Type: string

Overrides: Array

[ Top ]


Class Methods

parserNameTag

parserNameTag parserNameTag( string $name, string $value)

[line 217]

set up the name tag

Parameters:

  • string $name - tag name (not used)
  • string $value - tag value

[ Top ]

Convert

string Convert( Converter &$c)

[line 231]

process this tag through the given output converter

Tags:

Overrides parserTag::Convert() (Perform the output conversion on this parserTag using the output converter that is passed in)

Parameters:

[ Top ]


Class Constants


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