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

Class: parserAccessTag

Source Location: /phpDocumentor/DocBlockTags.inc

Class Overview

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

This class represents the @access tag


Author(s):

Version:

  • Release: @VER@

Copyright:

  • 2002-2008 Gregory Beaver

Variables

Methods


Inherited Variables

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

[line 253]
This class represents the @access tag



Tags:

tutorial:  @access
author:  Greg Beaver <cellog@php.net>
version:  Release: @VER@
copyright:  2002-2008 Gregory Beaver
link:  http://pear.php.net/PhpDocumentor
link:  http://www.phpdoc.org
todo:  CS cleanup - change package to PhpDocumentor
todo:  CS cleanup - change classname to PhpDocumentor_*
license:  LGPL


[ 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


[ Top ]

$keyword =  'access'

[line 259]

tag name


Type:   string
Overrides:   Array


[ Top ]



Class Methods


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



Tags:



Parameters:

parserStringWithInlineTags   $value   the tag value

[ Top ]

method Convert [line 308]

string Convert( Converter &$converter)

process this tag through the given output converter



Tags:

return:  converted value of the tag
see:  parserStringWithInlineTags::Convert()
todo:  CS cleanup - rename to convert for camelCase rule


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 ]

method getString [line 318]

string getString( )

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)

[ Top ]


Documentation generated on Tue, 06 Dec 2011 07:11:56 -0600 by phpDocumentor 1.4.4