Class: parserAccessTag

Source Location: /phpDocumentor/DocBlockTags.inc

Class Overview [line 253]

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

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 [email protected]} 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 @access tag

Tags:

[ Top ]


Class Variables

$isvalid =  false

[line 266]

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

or public, false otherwise

Type: boolean

Overrides:

[ Top ]

$keyword =  'access'

[line 259]

tag name

Type: string

Overrides: Array

[ Top ]


Class Methods

parserAccessTag

parserAccessTag parserAccessTag( parserStringWithInlineTags $value)

[line 276]

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

Tags:

Parameters:

[ Top ]

Convert

string Convert( Converter &$converter)

[line 308]

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:

  • Converter &$converter - the output converter

[ Top ]

getString

string getString( )

[line 318]

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

Tags:

  • return - returns the text minus any inline tags

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

Parameters:

[ Top ]


Class Constants


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