Class parserAccessTag

Description

This class represents the @access tag

Located in /phpDocumentor/DocBlockTags.inc (line 253)

parserBase
   |
   --parserStringWithInlineTags
      |
      --parserTag
         |
         --parserAccessTag
Variable Summary
boolean $isvalid
string $keyword
Method Summary
parserAccessTag parserAccessTag (parserStringWithInlineTags $value)
string Convert (Converter &$converter)
string getString ()
Variables
boolean $isvalid = false (line 266)

set to true if the returned tag has a value type of private, protected

or public, false otherwise

string $keyword = 'access' (line 259)

tag name


Redefinition of:
parserTag::$keyword
tag name (see, access, etc.)

Inherited Variables

Inherited from parserTag

parserTag::$type

Inherited from parserStringWithInlineTags

parserStringWithInlineTags::$value
Methods
Constructor parserAccessTag (line 276)

checks $value to make sure it is private, protected or public, otherwise it's not a valid @access tag

parserAccessTag parserAccessTag (parserStringWithInlineTags $value)
Convert (line 308)

process this tag through the given output converter

string Convert (Converter &$converter)
  • Converter &$converter: the output converter

Redefinition of:
parserTag::Convert()
Perform the output conversion on this parserTag using the output converter that is passed in
getString (line 318)

No inline tags are possible, returns 'public', 'protected' or 'private'

  • return: returns the text minus any inline tags
string getString ()

Redefinition of:
parserTag::getString()
Returns the text minus any inline tags

Inherited Methods

Inherited From parserTag

parserTag::parserTag()
parserTag::Convert()
parserTag::getString()
parserTag::HandleEvent()

Inherited From parserStringWithInlineTags

parserStringWithInlineTags::add()
parserStringWithInlineTags::Convert()
parserStringWithInlineTags::getString()
parserStringWithInlineTags::hasInlineTag()
parserStringWithInlineTags::setSource()
parserStringWithInlineTags::trimmedStrlen()

Inherited From parserBase

parserBase::getType()
parserBase::getValue()
parserBase::setValue()

Documentation generated on Mon, 05 Dec 2011 20:58:05 -0600 by phpDocumentor 1.4.4