Docs For Class parserDocBlock

$desc = false

[line 86]

Type:

parserDesc

[ Top ]

$explicitpackage = false

[line 154]

fix for bug 591396

Type:

boolean

[ Top ]

$funcglobals = array()

[line 130]

array of global variable data.

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

Type:

array

[ Top ]

$hasaccess = false

[line 162]

whether this DocBlock has an @access tag

Type:

boolean

[ Top ]

$hasname = false

[line 166]

whether this DocBlock has a @name tag

Type:

boolean

[ Top ]

$linenumber = false

[line 104]

Line number in the source on which this docblock appears

Since: 1.2

Type:

false|integer

[ Top ]

$package = 'default'

[line 156]

Type:

string

[ Top ]

$packagedescrip = ''

[line 172]

description of package parsed from @package tag

Unused in this version

Type:

string

[ Top ]

$params = array()

[line 122]

array of param data.

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

Type:

array

[ Top ]

$processed_desc = false

[line 90]

Var: array of parserDescs

Type:

array

[ Top ]

$processed_sdesc = false

[line 94]

Var: array of parserDescs

Type:

array

[ Top ]

$return = false

[line 144]

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

Type:

mixed

[ Top ]

$sdesc = false

[line 98]

Type:

parserDesc

[ Top ]

$statics = array()

[line 139]

array of static variable data.

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

Type:

array

[ Top ]

$subpackage = ''

[line 158]

Type:

string

[ Top ]

$subpackagedescrip = ''

[line 178]

description of subpackage parsed from @package tag

Unused in this version

Type:

string

[ Top ]

$tags = array()

[line 109]

array of parserTags

Type:

array

[ Top ]

$unknown_tags = array()

[line 114]

array of unrecognized parserTags

Type:

array

[ Top ]

$var = false

[line 149]

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

Type:

mixed

[ Top ]

parserDocBlock (Constructor) [line 191]

parserDocBlock parserDocBlock(
)

sets package to default

Global: string $phpDocumentor_DefaultPackageName: default package name

[ Top ]

addAccess [line 678]

void addAccess(
string
$value)

add an @access tag to the tags array

Parameters:

string $value — should be either public or private

[ Top ]

addFileSource [line 699]

void addFileSource(
mixed
$path, mixed
$value)

[ Top ]

addFuncGlobal [line 619]

void addFuncGlobal(
string
$type, string
$value)

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

[ Top ]

addKeyword [line 405]

void addKeyword(
string
$keyword, parserStringWithInlineTags
$value)

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

[ Top ]

addLink [line 708]

void addLink(
string
$link)

creates a parserLinkTag and adds it to the $tags array

Parameters:

string $link —

[ Top ]

addName [line 587]

void addName(
string
$value)

Adds a @name tag to the tag list

Parameters:

string $value — new name of element

[ Top ]

addPackage [line 473]

void addPackage(
string
$keyword, mixed
$value)

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

[ Top ]

addParam [line 365]

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

Parameters:

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

[ Top ]

addReturn [line 731]

void addReturn(
string
$returnType, parserStringWithInlineTags
$value)

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`	—

[ Top ]

addSee [line 719]

void addSee(
string
$keyword, string
$value)

creates a parserLinkTag and adds it to the $tags array

Parameters:

string	`$value`	—
string	`$keyword`	—	either see or uses

[ Top ]

addStaticVar [line 606]

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

Parameters:

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

[ Top ]

addUnknownTag [line 433]

void addUnknownTag(
string
$keyword, string
$value)

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

Parameters:

string	`$keyword`	—	tag name
string	`$value`	—	tag value

[ Top ]

addUsedBy [line 760]

void addUsedBy(
mixed
$link)

[ Top ]

addVar [line 748]

void addVar(
string
$varType, parserStringWithInlineTags
$value)

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`	—

[ Top ]

canSource [line 228]

void canSource(
)

Tells the DocBlock it can have a @filesource tag

Only page-level DocBlocks may have a @filesource tag

[ Top ]

changeGlobal [line 628]

void changeGlobal(
integer
$index, string
$name)

Parameters:

integer	`$index`	—	index of parameter in the $funcglobals array
string	`$name`	—	name of the parameter to set in the $funcglobals array

[ Top ]

changeParam [line 377]

void changeParam(
integer
$index, string
$name)

Parameters:

integer	`$index`	—	index of parameter in the $params array
string	`$name`	—	name of the parameter to set in the $params array

[ Top ]

changeStatic [line 638]

void changeStatic(
integer
$index, string
$name)

Parameters:

integer	`$index`	—	index of parameter in the $statics array
string	`$name`	—	name of the parameter to set in the $statics array

[ Top ]

getDesc [line 343]

string getDesc(
Converter
&$converter)

Parameters:

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

[ Top ]

getExplicitPackage [line 464]

void getExplicitPackage(
)

[ Top ]

getKeyword [line 769]

mixed getKeyword(
string
$keyword)

Return: false if no keyword, unconverted value if one keyword, array of unconverted values if more than one keyword

Parameters:

string $keyword —

[ Top ]

getLineNumber [line 202]

void getLineNumber(
)

[ Top ]

getSDesc [line 321]

string getSDesc(
Converter
&$converter)

Parameters:

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

[ Top ]

getType [line 822]

string getType(
)

Return: always 'docblock'

[ Top ]

hasInheritDoc [line 286]

void hasInheritDoc(
)

[ Top ]

listParams [line 784]

array listParams(
)

Return: Format: array('var' => tag name, 'data' => unconverted tag value)

[ Top ]

listTags [line 802]

void listTags(
Converter
0)

Parameters:

Converter 0 —

[ Top ]

overridePackage [line 447]

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

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	`$package`	—
string	`$subpackage`	—
string	`$elname`	—	element name
string	`$type`	—	element type (include, define, var, method, global, function)

[ Top ]

postProcess [line 212]

void postProcess(
)

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

abstract structures

Uses: parserDescParser::parse()

[ Top ]

replaceInheritDoc [line 292]

void replaceInheritDoc(
mixed
$desc)

[ Top ]

setDesc [line 275]

void setDesc(
parserDesc|parserDocBlock
$desc)

Parameters:

parserDesc|parserDocBlock $desc — sets $desc

[ Top ]

setExplicitPackage [line 459]

void setExplicitPackage(
)

[ Top ]

setLineNumber [line 197]

void setLineNumber(
mixed
$number)

[ Top ]

setShortDesc [line 252]

void setShortDesc(
parserDesc|parserDocBlock
$desc)

Parameters:

parserDesc|parserDocBlock $desc — sets $sdesc

[ Top ]

setSource [line 263]

void setSource(
mixed
$source)

[ Top ]

updateGlobals [line 648]

void updateGlobals(
array
$funcs)

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

Parameters:

array $funcs —

[ Top ]

updateParams [line 387]

void updateParams(
array
$params)

replaces nameless parameters in the $params array with their names

Parameters:

array $params — Format: array(parameter index => parameter name,...)

[ Top ]

updateStatics [line 663]

void updateStatics(
array
$funcs)

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

Parameters:

array $funcs —

[ Top ]

Class: parserDocBlock

Class Overview

Author(s):

Version:

Variables

Methods

Inherited Variables

Inherited Methods

Class Details

Class Variables

$desc = false

$explicitpackage = false

$funcglobals = array()

$hasaccess = false

$hasname = false

$linenumber = false

$package = 'default'

$packagedescrip = ''

$params = array()

$processed_desc = false

$processed_sdesc = false

$return = false

$sdesc = false

$statics = array()

$subpackage = ''

$subpackagedescrip = ''

$tags = array()

$unknown_tags = array()

$var = false

Method Detail

parserDocBlock (Constructor) [line 191]

addAccess [line 678]

Parameters:

addFileSource [line 699]

addFuncGlobal [line 619]

Parameters:

addKeyword [line 405]

Parameters:

addLink [line 708]

Parameters:

addName [line 587]

Parameters:

addPackage [line 473]

Parameters:

addParam [line 365]

Parameters:

addReturn [line 731]

Parameters:

addSee [line 719]

Parameters:

addStaticVar [line 606]

Parameters:

addUnknownTag [line 433]

Parameters:

addUsedBy [line 760]

addVar [line 748]

Parameters:

canSource [line 228]

changeGlobal [line 628]

Parameters:

changeParam [line 377]

Parameters:

changeStatic [line 638]

Parameters:

getDesc [line 343]

Parameters:

getExplicitPackage [line 464]

getKeyword [line 769]

Parameters:

getLineNumber [line 202]

getSDesc [line 321]

Parameters:

getType [line 822]

hasInheritDoc [line 286]

listParams [line 784]

listTags [line 802]

Parameters:

overridePackage [line 447]

Parameters:

postProcess [line 212]