/doclets/standard/packageWriter.php

<?php
/*
PHPDoctor: The PHP Documentation Creator
Copyright (C) 2004 Paul James <paul@peej.co.uk>

This program 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 2 of the License, or
(at your option) any later version.

This program 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 this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
*/

/** This generates the package-summary.html files that list the interfaces and
 * classes for a given package.
 *
 * @package PHPDoctor\Doclets\Standard
 */
class packageWriter extends HTMLWriter
{

    /** Build the package summaries.
     *
     * @param Doclet doclet
     */
    public function packageWriter(&$doclet)
    {

        parent::HTMLWriter($doclet);

        $rootDoc =& $this->_doclet->rootDoc();
        $phpdoctor =& $this->_doclet->phpdoctor();

        $displayTree = $phpdoctor->getOption('tree');

        if ($displayTree) {
            $this->_sections[0] = array('title' => 'Overview', 'url' => 'overview-summary.html');
            $this->_sections[1] = array('title' => 'Namespace');
            $this->_sections[2] = array('title' => 'Class');
            //$this->_sections[3] = array('title' => 'Use');
            $this->_sections[4] = array('title' => 'Tree', 'selected' => TRUE);
            if ($doclet->includeSource()) $this->_sections[5] = array('title' => 'Files', 'url' => 'overview-files.html');
            $this->_sections[6] = array('title' => 'Deprecated', 'url' => 'deprecated-list.html');
            $this->_sections[7] = array('title' => 'Todo', 'url' => 'todo-list.html');
            $this->_sections[8] = array('title' => 'Index', 'url' => 'index-all.html');

            $this->_id = 'tree';

            $tree = array();
            $classes =& $rootDoc->classes();
            if ($classes) {
                foreach ($classes as $class) {
                    $this->_buildTree($tree, $class);
                }
            }

            ob_start();

            echo "<hr>\n\n";
            echo '<h1>Class Hierarchy</h1>';

            $this->_displayTree($tree);

            $this->_output = ob_get_contents();
            ob_end_clean();

            $this->_write('overview-tree.html', 'Overview', TRUE);
        }

        $this->_id = 'package';

        $packages =& $rootDoc->packages();
        ksort($packages);

        foreach ($packages as $packageName => $package) {

            $this->_depth = $package->depth() + 1;

            $this->_sections[0] = array('title' => 'Overview', 'url' => 'overview-summary.html');
            $this->_sections[1] = array('title' => 'Namespace', 'selected' => TRUE);
            $this->_sections[2] = array('title' => 'Class');
            //$this->_sections[3] = array('title' => 'Use');
            if ($displayTree) $this->_sections[4] = array('title' => 'Tree', 'url' => $package->asPath().'/package-tree.html');
            if ($doclet->includeSource()) $this->_sections[5] = array('title' => 'Files', 'url' => 'overview-files.html');
            $this->_sections[6] = array('title' => 'Deprecated', 'url' => 'deprecated-list.html');
            $this->_sections[7] = array('title' => 'Todo', 'url' => 'todo-list.html');
            $this->_sections[8] = array('title' => 'Index', 'url' => 'index-all.html');

            ob_start();

            echo "<hr>\n\n";

            echo '<h1>Namespace ', $package->name(), "</h1>\n\n";

            $textTag =& $package->tags('@text');
            if ($textTag) {
                echo '<div class="comment">', $this->_processInlineTags($textTag, TRUE), "</div>\n\n";
                echo '<dl><dt>See:</dt><dd><b><a href="#overview_description">Description</a></b></dd></dl>', "\n\n";
            }

            $classes =& $package->ordinaryClasses();
            if ($classes) {
                ksort($classes);
                echo '<table class="title">', "\n";
                echo '<tr><th colspan="2" class="title">Class Summary</th></tr>', "\n";
                foreach ($classes as $name => $class) {
                    $textTag =& $classes[$name]->tags('@text');
                    echo '<tr><td class="name"><a href="', str_repeat('../', $this->_depth), $classes[$name]->asPath(), '">', $classes[$name]->name(), '</a></td>';
                    echo '<td class="description">';
                    if ($textTag) echo strip_tags($this->_processInlineTags($textTag, TRUE), '<a><b><strong><u><em>');
                    echo "</td></tr>\n";
                }
                echo "</table>\n\n";
            }

            $interfaces =& $package->interfaces();
            if ($interfaces) {
                ksort($interfaces);
                echo '<table class="title">'."\n";
                echo '<tr><th colspan="2" class="title">Interface Summary</th></tr>'."\n";
                foreach ($interfaces as $name => $interface) {
                    $textTag =& $interfaces[$name]->tags('@text');
                    echo '<tr><td class="name"><a href="', str_repeat('../', $this->_depth), $interfaces[$name]->asPath(), '">', $interfaces[$name]->name(), '</a></td>';
                    echo '<td class="description">';
                    if ($textTag) echo strip_tags($this->_processInlineTags($textTag, TRUE), '<a><b><strong><u><em>');
                    echo "</td></tr>\n";
                }
                echo "</table>\n\n";
            }

            $traits =& $package->traits();
            if ($traits) {
                ksort($traits);
                echo '<table class="title">'."\n";
                echo '<tr><th colspan="2" class="title">Trait Summary</th></tr>'."\n";
                foreach ($traits as $name => $trait) {
                    $textTag =& $traits[$name]->tags('@text');
                    echo '<tr><td class="name"><a href="', str_repeat('../', $this->_depth), $traits[$name]->asPath(), '">', $traits[$name]->name(), '</a></td>';
                    echo '<td class="description">';
                    if ($textTag) echo strip_tags($this->_processInlineTags($textTag, TRUE), '<a><b><strong><u><em>');
                    echo "</td></tr>\n";
                }
                echo "</table>\n\n";
            }

            $exceptions =& $package->exceptions();
            if ($exceptions) {
                ksort($exceptions);
                echo '<table class="title">'."\n";
                echo '<tr><th colspan="2" class="title">Exception Summary</th></tr>'."\n";
                foreach ($exceptions as $name => $exception) {
                    $textTag =& $exceptions[$name]->tags('@text');
                    echo '<tr><td class="name"><a href="', str_repeat('../', $this->_depth), $exceptions[$name]->asPath(), '">', $exceptions[$name]->name(), '</a></td>';
                    echo '<td class="description">';
                    if ($textTag) echo strip_tags($this->_processInlineTags($textTag, TRUE), '<a><b><strong><u><em>');
                    echo "</td></tr>\n";
                }
                echo "</table>\n\n";
            }

            $functions =& $package->functions();
            if ($functions) {
                ksort($functions);
                echo '<table class="title">', "\n";
                echo '<tr><th colspan="2" class="title">Function Summary</th></tr>', "\n";
                foreach ($functions as $name => $function) {
                    $textTag =& $functions[$name]->tags('@text');
                    echo '<tr><td class="name"><a href="package-functions.html#', $functions[$name]->name(), '">', $functions[$name]->name(), '</a></td>';
                    echo '<td class="description">';
                    if ($textTag) echo strip_tags($this->_processInlineTags($textTag, TRUE), '<a><b><strong><u><em>');
                    echo "</td></tr>\n";
                }
                echo "</table>\n\n";
            }

            $globals =& $package->globals();
            if ($globals) {
                ksort($globals);
                echo '<table class="title">', "\n";
                echo '<tr><th colspan="2" class="title">Global Summary</th></tr>', "\n";
                foreach ($globals as $name => $global) {
                    $textTag =& $globals[$name]->tags('@text');
                    echo '<tr><td class="name"><a href="package-globals.html#', $globals[$name]->name(), '">', $globals[$name]->name(), '</a></td>';
                    echo '<td class="description">';
                    if ($textTag) echo strip_tags($this->_processInlineTags($textTag, TRUE), '<a><b><strong><u><em>');
                    echo "</td></tr>\n";
                }
                echo "</table>\n\n";
            }

            $textTag =& $package->tags('@text');
            if ($textTag) {
                echo '<h1>Namespace ', $package->name(), " Description</h1>\n\n";
                echo '<div class="comment" id="overview_description">'. $this->_processInlineTags($textTag), "</div>\n\n";
            }

            echo "<hr>\n\n";

            $this->_output = ob_get_contents();
            ob_end_clean();

            $this->_write($package->asPath().'/package-summary.html', $package->name(), TRUE);

            if ($displayTree) {

                $this->_sections[0] = array('title' => 'Overview', 'url' => 'overview-summary.html');
                $this->_sections[1] = array('title' => 'Namespace', 'url' => $package->asPath().'/package-summary.html', 'relative' => TRUE);
                $this->_sections[2] = array('title' => 'Class');
                //$this->_sections[3] = array('title' => 'Use');
                $this->_sections[4] = array('title' => 'Tree', 'url' => $package->asPath().'/package-tree.html', 'selected' => TRUE, 'relative' => TRUE);
                if ($doclet->includeSource()) $this->_sections[5] = array('title' => 'Files', 'url' => 'overview-files.html');
                $this->_sections[6] = array('title' => 'Deprecated', 'url' => 'deprecated-list.html');
                $this->_sections[7] = array('title' => 'Todo', 'url' => 'todo-list.html');
                $this->_sections[8] = array('title' => 'Index', 'url' => 'index-all.html');

                $this->_id = 'tree';

                $tree = array();
                $classes =& $package->ordinaryClasses();
                if ($classes) {
                    ksort($classes);
                    foreach ($classes as $class) {
                        $this->_buildTree($tree, $class);
                    }
                }

                ob_start();

                echo "<hr>\n\n";

                echo '<h1>Class Hierarchy for Package ', $package->name(),'</h1>';

                $this->_displayTree($tree);

                $this->_output = ob_get_contents();
                ob_end_clean();

                $this->_write($package->asPath().'/package-tree.html', $package->name(), TRUE);
            }

        }

    }

    /**
     * Build the class tree branch for the given element
     *
     * @param ClassDoc[] tree
     * @param ClassDoc element
     */
    public function _buildTree(&$tree, &$element)
    {
        $tree[$element->name()] = $element;
        if ($element->superclass()) {
            $rootDoc =& $this->_doclet->rootDoc();
            $superclass =& $rootDoc->classNamed($element->superclass());
            if ($superclass) {
                $this->_buildTree($tree, $superclass);
            }
        }
    }

    /**
     * Build the class tree branch for the given element
     *
     * @param ClassDoc[] tree
     * @param str parent
     */
    public function _displayTree($tree, $parent = NULL)
    {
        $outputList = TRUE;
        foreach ($tree as $name => $element) {
            if ($element->superclass() == $parent) {
                if ($outputList) echo "<ul>\n";
                echo '<li><a href="', str_repeat('../', $this->_depth), $element->asPath(), '">', $element->qualifiedName(), '</a>';
                $this->_displayTree($tree, $name);
                echo "</li>\n";
                $outputList = FALSE;
            }
        }
        if (!$outputList) echo "</ul>\n";
    }

}