Pelzini

source of /processor/parser_file.php

Contains the ParserFile class

<?php
/*
Copyright 2008 Josh Heidenreich
 
This file is part of Pelzini.
 
Pelzini is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
 
Pelzini is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.
 
You should have received a copy of the GNU General Public License
along with Pelzini.  If not, see <http://www.gnu.org/licenses/>.
*/
 
/**
 * Contains the {@link ParserFile} class
 *
 * @package Parser model
 * @author Josh Heidenreich
 * @since 0.1
 **/
 
/**
 * Represents a file
 **/
class ParserFile extends CodeParserItem {
    public $name;
    public $description;
    public $namespace;
    public $functions;
    public $classes;
    public $constants;
    public $enumerations;
    public $source;
 
    public function __construct()
    {
        parent::__construct();
 
        $this->functions = array();
        $this->classes = array();
        $this->constants = array();
        $this->enumerations = array();
        $this->namespace = null;
    }
 
 
    /**
     * Applies the contents of a doc-block to this element
     *
     * @param $text The content of the DocBlock
     **/
    public function processSpecificDocblockTags($docblock_tags)
    {
        $this->description = htmlify_text(@$docblock_tags['@summary']);
    }
 
 
    /**
     * Cascades Docblock tags into the children that do not have any tags, and then
     * runs processTags() for all of the children items.
     **/
    public function treeWalk($function_name, ParserItem $parent_item = null)
    {
        call_user_func($function_name, $this, $parent_item);
 
        foreach ($this->classes as $item) {
            $item->treeWalk($function_name, $this);
        }
 
        foreach ($this->functions as $item) {
            $item->treeWalk($function_name, $this);
        }
 
        foreach ($this->constants as $item) {
            $item->treeWalk($function_name, $this);
        }
 
        foreach ($this->enumerations as $item) {
            $item->treeWalk($function_name, $this);
        }
    }
 
 
    /**
     * Debugging use only
     **/
    public function dump()
    {
        echo '<div style="border: 1px black solid;">';
        echo $this->name;
        echo "<pre>{$this->description}</pre>";
        foreach ($this->functions as $a) $a->dump();
        foreach ($this->classes as $a) $a->dump();
        foreach ($this->constants as $a) $a->dump();
        foreach ($this->enumerations as $a) $a->dump();
 
        parent::dump();
        echo '</div>';
    }
 
 
}
 
 
?>