Pelzini

This is the code documentation for the Pelzini project

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.

Extending this class

<?php
/**
* New class description goes here
* 
* @author Your Name, 2020-12-03
**/
class NewClassName extends CodeParserItem {
    
    /**
    * Debugging use only
    **/
    protected function dump () {
        // Method code goes here
    }
    
    /**
    * Processes general DocBlock tags that should apply to everything
    **/
    protected function processGenericDocblockTags ($docblock_tags) {
        // Method code goes here
    }
    
    /**
    * Sets the Docblock tags for this item
    **/
    public function setDocblockTags (array $tags) {
        // Method code goes here
    }
    
    /**
    * Gets the Docblock tags of this item
    **/
    public function getDocblockTags () {
        // Method code goes here
    }
    
    /**
    * Cascades parent Docblock tags into a child item
    * Only cascades the tags specified in the config
    **/
    public function cascadeTags (ParserItem $child) {
        // Method code goes here
    }
    
    /**
    * This parses a comment for a specific item
    **/
    public function applyComment ($comment) {
        // Method code goes here
    }
    
    /**
    * Processes the tags for a specific item
    **/
    public function processTags () {
        // Method code goes here
    }
    
    /**
    * This constructor must be called by extending classes
    **/
    protected function __construct () {
        // Method code goes here
    }
    
    /**
    * Processes the docblock tags for a specific item
    **/
    protected function processSpecificDocblockTags ($docblock_tags) {
        // Method code goes here
    }
    
    /**
    * 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
    **/
    public function treeWalk ($function_name, ParserItem $parent_item) {
        // Method code goes here
    }
    
}
?>