CodeParserItem class - Documentation for Pelzini

Info Page:

Page options:

class CodeParserItem

Stores information about parser items that are actual source code.
Typically these parser items have authors and versions, so all of that information
is stored in this class.

File: /processor/code_parser_item.php
Namespace: processor
Extends: ParserItem
This class is abstract
Available since:

Authors

Josh Heidenreich

Variables

Name	Visibility	Description
`$authors`
`$deprecated`
`$docblock_tags`
`$example`
`$info_tags`
`$linenum`
`$see`
`$since`
`$tables`

Functions

Name	Visibility	Description
__construct	protected	This constructor must be called by extending classes
applyComment	public	This parses a comment for a specific item
cascadeTags	public	Cascades parent Docblock tags into a child item
dump	protected	Debugging use only
getDocblockTags	public	Gets the Docblock tags of this item
processGenericDocblockTags	protected	Processes general DocBlock tags that should apply to everything
processSpecificDocblockTags	protected	Processes the docblock tags for a specific item
processTags	public	Processes the tags for a specific item
setDocblockTags	public	Sets the Docblock tags for this item
treeWalk	public	Executes a function for this ParserItem, and all of its children ParserItems

protected __construct

void $CodeParserItem->__construct ( );

This constructor must be called by extending classes

public applyComment

void $CodeParserItem->applyComment ( mixed $comment );

This parses a comment for a specific item

public cascadeTags

void $CodeParserItem->cascadeTags ( ParserItem $child );

Cascades parent Docblock tags into a child item
Only cascades the tags specified in the config

protected dump

void $CodeParserItem->dump ( );

Debugging use only

public getDocblockTags

unknown $CodeParserItem->getDocblockTags ( );

Gets the Docblock tags of this item

protected processGenericDocblockTags

void $CodeParserItem->processGenericDocblockTags ( mixed $docblock_tags );

Processes general DocBlock tags that should apply to everything

protected processSpecificDocblockTags

void $CodeParserItem->processSpecificDocblockTags ( mixed $docblock_tags );

Processes the docblock tags for a specific item

public processTags

void $CodeParserItem->processTags ( );

Processes the tags for a specific item

public setDocblockTags

void $CodeParserItem->setDocblockTags ( array $tags );

Sets the Docblock tags for this item

public treeWalk

void $CodeParserItem->treeWalk ( mixed $function_name [, ParserItem $parent_item ] );

Executes a function for this ParserItem, and all of its children ParserItems

The function will be called with a two arguments, the ParserItem that it should operate on, and the parent
of the parser item

Pelzini

Search documentation