Class: parserDocBlock

[line 219]

Type: string

Overrides:

[line 134]

Type: parserDesc

Overrides:

[line 158]

Line number in the source on which this docblock ends

Tags:

• since - 1.2

Type: false|integer

Overrides:

[line 217]

fix for bug 708559

Tags:

• usedby - parserDocBlock::setExplicitCategory()

Type: boolean

Overrides:

[line 212]

fix for bug 591396

Tags:

• usedby - parserDocBlock::setExplicitPackage()

Type: boolean

Overrides:

[line 184]

array of global variable data.

Format: array(index of global variable in @global tag list -OR- global variable name => array(datatype,parserStringWithInlineTags),...)

Type: array

Overrides:

[line 227]

whether this DocBlock has an @access tag

Type: boolean

Overrides:

[line 231]

whether this DocBlock has a @name tag

Type: boolean

Overrides:

[line 152]

Line number in the source on which this docblock begins

Tags:

• since - 1.2

Type: false|integer

Overrides:

[line 221]

Type: string

Overrides:

[line 237]

description of package parsed from @package tag

Unused in this version

Type: string

Overrides:

[line 176]

array of param data.

Format: array(index of param in function parameter list -OR- parameter name => parserStringWithInlineTags,...)

Type: array

Overrides:

[line 138]

Tags:

• var - array of parserDescs

Type: array

Overrides:

[line 142]

Tags:

• var - array of parserDescs

Type: array

Overrides:

[line 197]

array of parserPropertyTag, parserPropertyReadTag, parserPropertyWriteTag, parserMethodTag magic tags

Type: mixed

Overrides:

[line 202]

This is either a parserReturnTag or false if no return tag is present

Type: mixed

Overrides:

[line 146]

Type: parserDesc

Overrides:

[line 193]

array of static variable data.

Format: array(index of static variable in @global tag list -OR- static variable name => parserStaticvarTag,...)

Type: array

Overrides:

[line 223]

Type: string

Overrides:

[line 243]

description of subpackage parsed from @package tag

Unused in this version

Type: string

Overrides:

[line 163]

array of parserTags

Type: array

Overrides:

[line 168]

array of unrecognized parserTags

Type: array

Overrides:

[line 207]

This is either a parserVarTag or false if no var tag is present

Type: mixed

Overrides:

parserDocBlock parserDocBlock( )

[line 256]

sets package to default

Tags:

• global - string $phpDocumentor_DefaultPackageName: default package name

Parameters:

void addAccess( string $value)

[line 916]

add an @access tag to the tags array

Parameters:

• string $value - should be either public or private

void addExample( string $value, string $path)

[line 641]

adds an @example tag

Parameters:

• string $value - contents of the tag
• string $path - path to the file containing this tag

void addFileSource( string $path, array $source)

[line 943]

Adds a new @filesource tag to the DocBlock

Tags:

• tutorial - @filesource

Parameters:

• string $path - full path to the file
• array $source - tokenized source code, ordered by line number

void addFuncGlobal( string $type, string $value)

[line 857]

adds a function declaration of @global to the $funcglobals array

Parameters:

• string $type - global type
• string $value - description of how the global is used in the function

void addKeyword( string $keyword, parserStringWithInlineTags $value)

[line 609]

Tags:

• global - array $_phpDocumentor_setting: used to determine whether to add the @internal tag or not

Parameters:

• string $keyword - tag name
• parserStringWithInlineTags $value - the contents of the tag

void addLink( string $link)

[line 953]

creates a parserLinkTag and adds it to the $tags array

Parameters:

• string $link -

void addName( string $value)

[line 825]

Adds a @name tag to the tag list

Parameters:

• string $value - new name of element

void addPackage( string $keyword, mixed $value)

[line 728]

Parameters:

• string $keyword - tag name (either package or subpackage)
• mixed $value - either a string or a parserStringWithInlineTags. Strips all inline tags and use the text as the package

void addParam( string $paramVar, $paramType, parserStringWithInlineTags $value)

[line 520]

Parameters:

• string $paramVar - if empty, param is indexed in the order received and set using changeParam()
• parserStringWithInlineTags $value -
• $paramType -

void addProperty( $tagName, $propertyName, $propertyType, $value)

[line 1033]

Adds a @property(-read or -write) or @method magic tag to the DocBlock

Parameters:

• $tagName -
• $propertyName -
• $propertyType -
• $value -

void addReturn( string $returnType, parserStringWithInlineTags $value)

[line 976]

creates a parserReturnTag and adds it to the $tags array

Parameters:

• string $returnType - the one-word name of the return type (mixed should be used if more than one type)
• parserStringWithInlineTags $value -

void addSee( string $keyword, string $value)

[line 964]

creates a parserLinkTag and adds it to the $tags array

Parameters:

• string $value -
• string $keyword - either see or uses

void addStaticVar( string $staticvar, string $type, parserStringWithInlineTags $descrip)

[line 844]

Parameters:

• string $staticvar - if empty, staticvar is indexed in the order received and set using changeStatic()
• string $type - data type
• parserStringWithInlineTags $descrip -

void addTag( parserTag $tag)

[line 587]

Used to insert DocBlock Template tags into a docblock

Tags:

• global - array $_phpDocumentor_setting: used to determine whether to add ignored tags, or not

Parameters:

• parserTag $tag - tag

void addUnknownTag( string $keyword, string $value)

[line 651]

adds an unknown tag to the $unknown_tags array for use by custom converters

Parameters:

• string $keyword - tag name
• string $value - tag value

void addUses( string $seeel, parserStringWithInlineTags $description)

[line 1024]

Add a @uses tag to the DocBlock

Tags:

• tutorial - @uses

Parameters:

• string $seeel - @see-style text, used for Converter::getLink()
• parserStringWithInlineTags $description - description of how the used element is used

void addVar( string $varType, parserStringWithInlineTags $value)

[line 993]

creates a parserVarTag and adds it to the $tags array

Parameters:

• string $varType - the one-word name of the variable type (mixed should be used if more than one type)
• parserStringWithInlineTags $value -

void canSource( )

[line 320]

Tells the DocBlock it can have a @filesource tag

Only page-level DocBlocks may have a @filesource tag

Parameters:

void cantSource( )

[line 330]

Tells the DocBlock it can't have a @filesource tag

Only page-level DocBlocks may have a @filesource tag

Parameters:

void changeGlobal( integer $index, string $name)

[line 866]

Parameters:

• integer $index - index of parameter in the $funcglobals array
• string $name - name of the parameter to set in the $funcglobals array

void changeParam( integer $index, string $name, string|null $type)

[line 537]

Parameters:

• integer $index - index of parameter in the $params array
• string $name - name of the parameter to set in the $params array
• string|null $type - type of the parameter

void changeStatic( integer $index, string $name)

[line 876]

Parameters:

• integer $index - index of parameter in the $statics array
• string $name - name of the parameter to set in the $statics array

string getDesc( Converter &$converter)

[line 498]

Parameters:

• Converter &$converter - takes $desc and converts it to a string and returns it if present, otherwise returns ''

integer getEndLineNumber( )

[line 294]

Retrieve ending line number

Parameters:

boolean getExplicitCategory( )

[line 719]

If the DocBlock has a @category tag, then this returns true

Parameters:

boolean getExplicitPackage( )

[line 698]

If the DocBlock has a @package tag, then this returns true

Parameters:

mixed getKeyword( string $keyword)

[line 1076]

Tags:

• return - false if no keyword, unconverted value if one keyword, array of unconverted values if more than one keyword

Parameters:

• string $keyword -

integer getLineNumber( )

[line 276]

Retrieve starting line number

Parameters:

string getSDesc( Converter &$converter)

[line 476]

Parameters:

• Converter &$converter - takes $sdesc and converts it to a string and returns it if present, otherwise returns ''

string getType( )

[line 1141]

Tags:

• return - always 'docblock'

Parameters:

boolean hasInheritDoc( )

[line 453]

Wrapper for parserDesc::hasInheritDoc()

Parameters:

array listParams( )

[line 1091]

Tags:

• return - Format: array('var' => tag name, 'data' => unconverted tag value)

Parameters:

array listProperties( )

[line 1109]

Tags:

• return - Format: array('var' => tag name, 'data' => unconverted tag value)

Parameters:

void listTags( Converter 0)

[line 1125]

Parameters:

• Converter 0 -

void overridePackage( string $category, string $package, string $subpackage, string $elname, string $type)

[line 666]

set the element's package to the passed values. Used in phpDocumentor_IntermediateParser to align package of

elements inside a class or procedural page to the package of the class/procedural page

Parameters:

• string $category -
• string $package -
• string $subpackage -
• string $elname - element name
• string $type - element type (include, define, var, method, global, function, const)

void postProcess( )

[line 304]

Parse out any html tags from doc comments, and make them into

abstract structures

Tags:

• uses - parserDescParser::parse()

Parameters:

void replaceInheritDoc( parserDesc $desc)

[line 465]

Wrapper for parserDesc::replaceInheritDoc()

Also replaces {@inheritdoc} in the $processed_desc

Parameters:

• parserDesc $desc -

void resetParams( )

[line 528]

Parameters:

void setDesc( parserDesc|parserDocBlock $desc)

[line 438]

Parameters:

• parserDesc|parserDocBlock $desc - sets $desc

void setEndLineNumber( integer $number)

[line 285]

Sets the ending line number for the DocBlock

Parameters:

• integer $number -

void setExplicitCategory( )

[line 710]

Used if this docblock has a @category tag.

phpDocumentor will guess category for DocBlocks that don't have a @category tag

Tags:

• uses - parserDocBlock::$explicitcategory

Parameters:

void setExplicitPackage( )

[line 689]

Used if this docblock has a @package tag.

phpDocumentor will guess package for DocBlocks that don't have a @package tag

Tags:

• uses - parserDocBlock::$explicitpackage

Parameters:

void setLineNumber( integer $number)

[line 267]

Sets the starting line number for the DocBlock

Parameters:

• integer $number -

void setShortDesc( parserDesc|parserDocBlock|parserTag $desc)

[line 396]

Set the short description of the DocBlock

Setting the short description is possible by passing in one of three possible parameters:

• another DocBlock's short description
• another DocBlock, the short description will be extracted
• a Zend Studio-compatible @desc tag

Parameters:

• parserDesc|parserDocBlock|parserTag $desc - sets $sdesc

void setSource( string|array $source, [false|string $class = false])

[line 426]

Passes to parserStringWithInlineTags::setSource()

After passing, it calls postProcess() to set up the new source

Parameters:

• string|array $source - tokenized highlight-ready source code
• false|string $class - name of class if this is a method source

void updateGlobals( array $funcs)

[line 886]

replaces nameless global variables in the $funcglobals array with their names

Parameters:

• array $funcs -

void updateModifiers( array $modifiers)

[line 355]

Parameters:

• array $modifiers -

void updateParams( array $params)

[line 552]

replaces nameless parameters in the $params array with their names

add @param tags for params in the function with no entry

Parameters:

• array $params - Format: array(parameter key => array(0 => parameter name[,1 => default value][,2 => type hint]),...)

void updateStatics( array $funcs)

[line 901]

replaces nameless static variables in the $statics array with their names

Parameters:

• array $funcs -