Class: parserPropertyTag

Source Location: /phpDocumentor/DocBlockTags.inc

Class Overview

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

represents the "@property" tag

Author(s):

Greg Beaver <[email protected]>

Version:

Release: @VER@

Copyright:

2002-2008 Gregory Beaver

Variables

Methods

parserPropertyTag

Child classes:

parserPropertyReadTag: represents the "@property-read" tag

parserPropertyWriteTag: represents the "@property-write" tag

parserMethodTag: represents the "@method" tag

Inherited Variables

Inherited Methods

Class: parserReturnTag

parserReturnTag::parserReturnTag(): set up the tag
parserReturnTag::Convert(): process this tag through the given output converter (sets up the $converted_returnType)

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

Tags:

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

[ Top ]

Class Variables

$keyword = 'property'

[line 456]

always 'property'

Type:	string
Overrides:	Array

[ Top ]

$returnType = 'mixed'

[line 461]

the type a property has

Type:	string
Overrides:	Array

[ Top ]

Class Methods

constructor parserPropertyTag [line 469]

parserPropertyTag parserPropertyTag(
string
$returnType, parserStringWithInlineTags
$value)

set up the property tag

Parameters:

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

[ Top ]

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