phpDocumentor
[ class tree: phpDocumentor ] [ index: phpDocumentor ] [ all elements ]

Class: parserDocBlock

Source Location: /PhpDocumentor-1.5.0a1/phpDocumentor/ParserDocBlock.inc

Class Overview


Represents a docblock and its components, $desc, $sdesc, $tags, and also $params for functions


Author(s):

Version:

  • $Id$

Variables

Methods


Inherited Variables

Inherited Methods


Class Details

[line 129]
Represents a docblock and its components, $desc, $sdesc, $tags, and also $params for functions


[ Top ]


Class Variables

$category =

[line 219]


Type:   string


[ Top ]

$desc =  false

[line 134]


Type:   parserDesc


[ Top ]

$endlinenumber =  false

[line 158]

Line number in the source on which this docblock ends
  • Since: 1.2

Type:   false|integer


[ Top ]

$explicitcategory =  false

[line 217]

fix for bug 708559

Type:   boolean


[ Top ]

$explicitpackage =  false

[line 212]

fix for bug 591396

Type:   boolean


[ Top ]

$funcglobals = array()

[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


[ Top ]

$hasaccess =  false

[line 227]

whether this DocBlock has an @access tag

Type:   boolean


[ Top ]

$hasname =  false

[line 231]

whether this DocBlock has a @name tag

Type:   boolean


[ Top ]

$linenumber =  false

[line 152]

Line number in the source on which this docblock begins
  • Since: 1.2

Type:   false|integer


[ Top ]

$package =  'default'

[line 221]


Type:   string


[ Top ]

$packagedescrip =  ''

[line 237]

description of package parsed from @package tag

Unused in this version


Type:   string


[ Top ]

$params = array()

[line 176]

array of param data.

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


Type:   array


[ Top ]

$processed_desc =  false

[line 138]


Type:   array


[ Top ]

$processed_sdesc =  false

[line 142]


Type:   array


[ Top ]

$properties = array()

[line 197]

array of parserPropertyTag, parserPropertyReadTag, parserPropertyWriteTag, parserMethodTag magic tags

Type:   mixed


[ Top ]

$return =  false

[line 202]

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

Type:   mixed


[ Top ]

$sdesc =  false

[line 146]


Type:   parserDesc


[ Top ]

$statics = array()

[line 193]

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 223]


Type:   string


[ Top ]

$subpackagedescrip =  ''

[line 243]

description of subpackage parsed from @package tag

Unused in this version


Type:   string


[ Top ]

$tags = array()

[line 163]

array of parserTags

Type:   array


[ Top ]

$unknown_tags = array()

[line 168]

array of unrecognized parserTags

Type:   array


[ Top ]

$var =  false

[line 207]

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

Type:   mixed


[ Top ]



Method Detail

parserDocBlock (Constructor)   [line 256]

parserDocBlock parserDocBlock( )

sets package to default

[ Top ]

addAccess   [line 916]

void addAccess( string $value)

add an @access tag to the tags array

Parameters:

string   $value     should be either public or private

[ Top ]

addExample   [line 641]

void addExample( string $value, string $path)

adds an @example tag

Parameters:

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

[ Top ]

addFileSource   [line 943]

void addFileSource( string $path, array $source)

Adds a new @filesource tag to the DocBlock

Parameters:

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

[ Top ]

addFuncGlobal   [line 857]

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 609]

void addKeyword( string $keyword, parserStringWithInlineTags $value)


Parameters:

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

[ Top ]

addLink   [line 953]

void addLink( string $link)

creates a parserLinkTag and adds it to the $tags array

Parameters:

string   $link     

[ Top ]

addName   [line 825]

void addName( string $value)

Adds a @name tag to the tag list

Parameters:

string   $value     new name of element

[ Top ]

addPackage   [line 728]

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 520]

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


Parameters:

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

[ Top ]

addProperty   [line 1033]

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

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

Parameters:

   $tagName     
   $propertyName     
   $propertyType     
   $value     

[ Top ]

addReturn   [line 976]

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 964]

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 844]

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 ]

addTag   [line 587]

void addTag( parserTag $tag)

Used to insert DocBlock Template tags into a docblock

Parameters:

parserTag   $tag     tag

[ Top ]

addUnknownTag   [line 651]

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 ]

addUses   [line 1024]

void addUses( string $seeel, parserStringWithInlineTags $description)

Add a @uses tag to the DocBlock

Parameters:

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

[ Top ]

addVar   [line 993]

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 320]

void canSource( )

Tells the DocBlock it can have a @filesource tag

Only page-level DocBlocks may have a @filesource tag


[ Top ]

cantSource   [line 330]

void cantSource( )

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

Only page-level DocBlocks may have a @filesource tag


[ Top ]

changeGlobal   [line 866]

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 537]

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


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

[ Top ]

changeStatic   [line 876]

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 498]

string getDesc( Converter &$converter)


Parameters:

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

[ Top ]

getEndLineNumber   [line 294]

integer getEndLineNumber( )

Retrieve ending line number

[ Top ]

getExplicitCategory   [line 719]

boolean getExplicitCategory( )

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

[ Top ]

getExplicitPackage   [line 698]

boolean getExplicitPackage( )

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

[ Top ]

getKeyword   [line 1076]

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 276]

integer getLineNumber( )

Retrieve starting line number

[ Top ]

getSDesc   [line 476]

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 1141]

string getType( )

  • Return: always 'docblock'

[ Top ]

hasInheritDoc   [line 453]

boolean hasInheritDoc( )

Wrapper for parserDesc::hasInheritDoc()

[ Top ]

listParams   [line 1091]

array listParams( )

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

[ Top ]

listProperties   [line 1109]

array listProperties( )

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

[ Top ]

listTags   [line 1125]

void listTags( Converter 0)


Parameters:

Converter   0     

[ Top ]

overridePackage   [line 666]

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

[ Top ]

postProcess   [line 304]

void postProcess( )

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

abstract structures


[ Top ]

replaceInheritDoc   [line 465]

void replaceInheritDoc( parserDesc $desc)

Wrapper for parserDesc::replaceInheritDoc()

Also replaces {@inheritdoc} in the $processed_desc


Parameters:

parserDesc   $desc     

[ Top ]

resetParams   [line 528]

void resetParams( )


[ Top ]

setDesc   [line 438]

void setDesc( parserDesc|parserDocBlock $desc)


Parameters:

parserDesc|parserDocBlock   $desc     sets $desc

[ Top ]

setEndLineNumber   [line 285]

void setEndLineNumber( integer $number)

Sets the ending line number for the DocBlock

Parameters:

integer   $number     

[ Top ]

setExplicitCategory   [line 710]

void setExplicitCategory( )

Used if this docblock has a @category tag.

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


[ Top ]

setExplicitPackage   [line 689]

void setExplicitPackage( )

Used if this docblock has a @package tag.

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


[ Top ]

setLineNumber   [line 267]

void setLineNumber( integer $number)

Sets the starting line number for the DocBlock

Parameters:

integer   $number     

[ Top ]

setShortDesc   [line 396]

void setShortDesc( parserDesc|parserDocBlock|parserTag $desc)

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

[ Top ]

setSource   [line 426]

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

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

[ Top ]

updateGlobals   [line 886]

void updateGlobals( array $funcs)

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

Parameters:

array   $funcs     

[ Top ]

updateModifiers   [line 355]

void updateModifiers( array $modifiers)


Parameters:

array   $modifiers     

[ Top ]

updateParams   [line 552]

void updateParams( array $params)

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]),...)

[ Top ]

updateStatics   [line 901]

void updateStatics( array $funcs)

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

Parameters:

array   $funcs     

[ Top ]


Documentation generated on Sun, 02 Sep 2012 00:02:35 +0000 by phpDocumentor 1.4.3. PEAR Logo Copyright © PHP Group 2004.