Class parserAccessTag

(line 253)

Description

parserBase
   |
   --parserStringWithInlineTags
      |
      --parserTag
         |
         --parserAccessTag

Located in File: /phpDocumentor/DocBlockTags.inc

This class represents the @access tag


Class Variables

Summary:
boolean $isvalid
string $keyword

$isvalid = false (line 266)

Data type : boolean

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

or public, false otherwise

$keyword = 'access' (line 259)

Data type : string

Overrides: Array

tag name

Class Constants

Summary:

Method Detail

Summary:
parserAccessTag parserAccessTag (parserStringWithInlineTags $value)
string Convert (Converter &$converter)
string getString ()

Constructor parserAccessTag (line 276)

parserAccessTag parserAccessTag( parserStringWithInlineTags $value)

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

Parameters

Info

Method Convert (line 308)

string Convert( Converter &$converter)

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

process this tag through the given output converter

Parameters

  • Converter &$converter: the output converter

Info

Method getString (line 318)

string getString( )

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

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

Info

  • return - returns the text minus any inline tags

Inherited Variables

Inherited Class Variable Summary

Inherited From Class parserTag

parserTag::$type - Type is used by many functions to skip the hassle of

Inherited From Class parserStringWithInlineTags

parserStringWithInlineTags::$value - array of strings and parserInlineTags

Inherited Methods

Inherited Method Summary

Inherited From 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.


Inherited From 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))


Inherited From Class parserBase

parserBase::getType() - gets the type

parserBase::getValue() - gets the value

parserBase::setValue() - sets the given value



Documentation generated on Mon, 05 Dec 2011 21:26:15 -0600 by phpDocumentor 1.4.4