Class: parserPropertyTag

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

Class Overview

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

represents "@property" 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

parserPropertyTag

Child classes:

parserPropertyReadTag: represents "@property-read" tag

parserPropertyWriteTag: represents "@property-write" tag

parserMethodTag: represents "@method" tag

Inherited Variables

Inherited Methods

Class: parserReturnTag

parserReturnTag::parserReturnTag()
parserReturnTag::Convert(): sets up $converted_returnType

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 366]
represents "@property" tag

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

[ Top ]

Class Variables

$keyword = 'property'

[line 372]

always 'property'

Type:	string
Overrides:	Array

[ Top ]

$returnType = 'mixed'

[line 377]

the type a property has

Type:	string
Overrides:	Array

[ Top ]

Method Detail

parserPropertyTag (Constructor) [line 383]

parserPropertyTag parserPropertyTag(
string
$returnType, parserStringWithInlineTags
$value)

Parameters:

string	`$returnType`	—
parserStringWithInlineTags	`$value`	—

[ Top ]