Docs For Class parserPropertyTag

Description

represents the "@property" tag

tutorial: @property
author: Greg Beaver <[email protected]>
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_*
since: 1.4.0a1
license: LGPL

Located in /phpDocumentor/DocBlockTags.inc (line 450)

parserBase
   |
   --parserStringWithInlineTags
      |
      --parserTag
         |
         --parserReturnTag
            |
            --parserPropertyTag

Direct descendents

Class	Description
parserPropertyReadTag	represents the "@property-read" tag
parserPropertyWriteTag	represents the "@property-write" tag
parserMethodTag	represents the "@method" tag

Variable Summary

string $keyword

string $returnType

Method Summary

parserPropertyTag parserPropertyTag (string $returnType, parserStringWithInlineTags $value)

Variables

string $keyword = 'property' (line 456)

always 'property'

Redefinition of:

parserReturnTag::$keyword: always 'return'

Redefined in descendants as:

parserPropertyReadTag::$keyword : always 'property-read'
parserPropertyWriteTag::$keyword : always 'property-write'
parserMethodTag::$keyword : always 'method'

string $returnType = 'mixed' (line 461)

the type a property has

Redefinition of:

parserReturnTag::$returnType: the type a function returns

Redefined in descendants as:

parserMethodTag::$returnType : the return type a method has

Inherited Variables

Inherited from parserReturnTag

parserReturnTag::$converted_returnType

Inherited from parserTag

parserTag::$type

Inherited from parserStringWithInlineTags

parserStringWithInlineTags::$value

Methods

Constructor parserPropertyTag (line 469)

set up the property tag

parserPropertyTag parserPropertyTag (string $returnType, parserStringWithInlineTags $value)

string $returnType: the tag value's datatype
parserStringWithInlineTags $value: the tag value

Inherited Methods

Inherited From parserReturnTag

parserReturnTag::parserReturnTag()
parserReturnTag::Convert()

Inherited From parserTag

parserTag::parserTag()
parserTag::Convert()
parserTag::getString()
parserTag::HandleEvent()

Inherited From parserStringWithInlineTags

parserStringWithInlineTags::add()
parserStringWithInlineTags::Convert()
parserStringWithInlineTags::getString()
parserStringWithInlineTags::hasInlineTag()
parserStringWithInlineTags::setSource()
parserStringWithInlineTags::trimmedStrlen()

Inherited From parserBase

parserBase::getType()
parserBase::getValue()
parserBase::setValue()