Pelzini

This is the code documentation for the Pelzini project

Page options:

Inherited members

class ParserConstant

Represents a constant

Authors

Variables

NameVisibilityDescription
$authors 
$deprecated 
$description 
$docblock_tags 
$example 
$info_tags 
$linenum 
$name 
$see 
$since 
$tables 
$value 

Functions

NameVisibilityDescription
__constructpublic 
applyCommentpublicThis parses a comment for a specific item
cascadeTagspublicCascades parent Docblock tags into a child item
dumppublicDebugging use only
getDocblockTagspublicGets the Docblock tags of this item
processGenericDocblockTagsprotectedProcesses general DocBlock tags that should apply to everything
processSpecificDocblockTagsprotectedApplies the contents of a doc-block to this element
processTagspublicProcesses the tags for a specific item
setDocblockTagspublicSets the Docblock tags for this item
treeWalkpublicExecutes a function for this ParserItem, and all of its children ParserItems

public __construct

void $ParserConstant->__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 $ParserConstant->dump ( );

Debugging use only

public getDocblockTags (from CodeParserItem)

unknown $CodeParserItem->getDocblockTags ( );

Gets the Docblock tags of this item

protected processGenericDocblockTags (from CodeParserItem)

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

Processes general DocBlock tags that should apply to everything

protected processSpecificDocblockTags

void $ParserConstant->processSpecificDocblockTags ( $text $docblock_tags );

Applies the contents of a doc-block to this element

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