ParserFunction class - Documentation for Pelzini

Info Page:

Page options:

class ParserFunction

Represents a function

File: /processor/parser_function.php
Namespace: processor
Extends: CodeParserItem
Available since:

Authors

Josh Heidenreich

Variables

Name	Visibility	Description
`$abstract`
`$args`
`$authors`
`$deprecated`
`$description`
`$docblock_tags`
`$example`
`$final`
`$has_return_stmt`
`$info_tags`
`$linenum`
`$name`
`$returns`
`$see`
`$since`
`$static`
`$tables`
`$throws`
`$visibility`

Functions

Name	Visibility	Description
__construct	public
applyComment	public	This parses a comment for a specific item
cascadeTags	public	Cascades parent Docblock tags into a child item
dump	public	Debugging use only
getDocblockTags	public	Gets the Docblock tags of this item
post_load	public	Does post-pasing processing of this ParserFunction.
processGenericDocblockTags	protected	Processes general DocBlock tags that should apply to everything
processSpecificDocblockTags	protected	Processes Javadoc tags that are specific to this PaserItem
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

public __construct

void $ParserFunction->__construct ( );

This function does not have a description

public applyComment (from CodeParserItem)

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

This parses a comment for a specific item

public cascadeTags (from CodeParserItem)

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

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

public dump

void $ParserFunction->dump ( );

Debugging use only

public getDocblockTags (from CodeParserItem)

unknown $CodeParserItem->getDocblockTags ( );

Gets the Docblock tags of this item

public post_load

void $ParserFunction->post_load ( );

Does post-pasing processing of this ParserFunction.
Specifically, loads types for the function arguments

protected processGenericDocblockTags (from CodeParserItem)

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

Processes general DocBlock tags that should apply to everything

protected processSpecificDocblockTags

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

Processes Javadoc tags that are specific to this PaserItem

public processTags (from CodeParserItem)

void $CodeParserItem->processTags ( );

Processes the tags for a specific item

public setDocblockTags (from CodeParserItem)

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

Sets the Docblock tags for this item

public treeWalk (from CodeParserItem)

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