Class: parserAccessTag

Source Location: /PhpDocumentor-1.4.0RC1/phpDocumentor/DocBlockTags.inc

Class Overview

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

This class represents the @access tag

Author(s):

Greg Beaver <cellog at php.net>

Version:

$Id: DocBlockTags.inc,v 1.10 2007/04/19 20:20:57 ashnazg Exp $

Variables

Methods

Inherited Variables

Class: parserTag

parserTag::$type

Class: parserStringWithInlineTags

parserStringWithInlineTags::$value

Inherited Methods

Class: parserTag

parserTag::parserTag(): Set up the tag
parserTag::Convert()
parserTag::getString()
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
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()
parserBase::getValue()
parserBase::setValue()

Class Details

[line 201]
This class represents the @access tag

Tutorial: @access
Author: Greg Beaver <cellog@php.net>
Version: $Id: DocBlockTags.inc,v 1.10 2007/04/19 20:20:57 ashnazg Exp $

[ Top ]

Class Variables

$isvalid = false

[line 214]

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

or public, false otherwise

Type:

boolean

[ Top ]

$keyword = 'access'

[line 207]

tag name

Type:	string
Overrides:	Array

[ Top ]

Method Detail

parserAccessTag (Constructor) [line 222]

parserAccessTag parserAccessTag(
parserStringWithInlineTags
$value)

checks $value to make sure it is private, protected or public, otherwise

it's not a valid @access tag

See: parserAccessTag::$isvalid

Parameters:

parserStringWithInlineTags $value —

[ Top ]

Convert [line 254]

string Convert(
Converter
&$converter)

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

Overrides parserTag::Convert() (parent method not documented)

Parameters:

Converter &$converter —

[ Top ]

getString [line 263]

string getString(
)

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

Return: returns the text minus any inline tags

Overrides parserTag::getString() (parent method not documented)

[ Top ]