Class: parserAccessTag

Source Location: /phpDocumentor/DocBlockTags.inc

Class parserAccessTag

Class Overview

This class represents the @access tag

Located in /phpDocumentor/DocBlockTags.inc [line 253]

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

Author(s):

Greg Beaver <[email protected]>

Information Tags:

Tutorial:	@access
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

Properties

Methods

[ Top ]

Inherited Properties, Constants, and Methods

Inherited Properties

Inherited Methods

Inherited Constants

Inherited From parserTag

parserTag::$type

Inherited From parserStringWithInlineTags

parserStringWithInlineTags::$value

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

parserBase::getType()

gets the type

parserBase::getValue()

gets the value

parserBase::setValue()

sets the given value

[ Top ]

Property Summary

boolean	$isvalid	set to true if the returned tag has a value type of private, protected
string	$keyword	tag name

[ Top ]

Method Summary

parserAccessTag	parserAccessTag()	checks $value to make sure it is private, protected or public, otherwise it's not a valid @access tag
string	Convert()	process this tag through the given output converter
string	getString()	No inline tags are possible, returns 'public', 'protected' or 'private'

[ Top ]

Properties

boolean $isvalid = false [line 266]

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

or public, false otherwise

[ Top ]

string $keyword = 'access' [line 259]

tag name

Redefinition of:

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

[ Top ]

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

Parameters:

parserStringWithInlineTags

$value:

the tag value

API Tags:

See:

parserAccessTag::$isvalid

[ Top ]

Convert [line 308]

string Convert(
Converter
&$converter 
)

process this tag through the given output converter

Parameters:

Converter

&$converter:

the output converter

API Tags:

Return:	converted value of the tag
See:	parserStringWithInlineTags::Convert()

Information Tags:

Todo:

CS cleanup - rename to convert for camelCase rule

Redefinition of:

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

[ Top ]

getString [line 318]

string getString(
)

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

API Tags:

Return:

returns the text minus any inline tags

Redefinition of:

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

[ Top ]

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

	phpDocumentor DocBlockTags

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