Pelzini

source of /processor/parser_class.php

Contains the ParserClass 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 ParserClass} class
 *
 * @package Parser model
 * @author Josh Heidenreich
 * @since 0.1
 **/
 
/**
 * Stores information about a specific class
 **/
class ParserClass extends CodeParserItem {
    public $name;
    public $functions;
    public $variables;
    public $visibility;
    public $extends;
    public $implements;
    public $abstract;
    public $description;
    public $final;
 
    /**
     * Creates this object
     **/
    public function __construct()
    {
        parent::__construct();
 
        $this->functions = array ();
        $this->variables = array ();
        $this->implements = array ();
        $this->visibility = 'public';
        $this->final = false;
    }
 
 
    /**
     * Applies the contents of a doc-block to this element
     *
     * @param $text The content of the DocBlock
     **/
    protected 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->functions as $item) {
            $item->treeWalk($function_name, $this);
        }
 
        foreach ($this->variables as $item) {
            $item->treeWalk($function_name, $this);
        }
    }
 
 
    /**
     * Debugging use only
     **/
    public function dump()
    {
        echo '<div style="border: 1px blue solid;">';
        echo $this->visibility . ' ';
        echo $this->name;
 
        if ($this->extends) echo '<br>extends ' . $this->extends;
        if ($this->implements) echo '<br>implements ' . implode(', ', $this->implements);
 
        if ($this->abstract) echo '<br>abstract';
        if ($this->final) echo '<br>final';
 
        echo '<br>' . $this->description;
 
        foreach ($this->variables as $a) $a->dump();
        foreach ($this->functions as $a) $a->dump();
 
        parent::dump();
        echo '</div>';
    }
 
 
}
 
 
?>