classWriter.php | searchcode

/.dev/lib/phpdoctor/doclets/standard/classWriter.php

https://github.com/istran/core
PHP | 386 lines | 306 code | 31 blank | 49 comment | 46 complexity | 35d6ede24634013ac2b798af3f91ad55 MD5 | raw file
Possible License(s): GPL-2.0, BSD-3-Clause

<?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 HTML API documentation for each individual interface
 * and class.
 *
 * @package PHPDoctor\Doclets\Standard
 */
class ClassWriter extends HTMLWriter
{

	/** Build the class definitons.
	 *
	 * @param Doclet doclet
	 */
	function classWriter(&$doclet)
    {
	
		parent::HTMLWriter($doclet);
		
		$this->_id = 'definition';

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

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

			$this->_sections[0] = array('title' => 'Overview', 'url' => 'overview-summary.html');
			$this->_sections[1] = array('title' => 'Namespace', 'url' => $package->asPath().'/package-summary.html');
			$this->_sections[2] = array('title' => 'Class', 'selected' => TRUE);
			//$this->_sections[3] = array('title' => 'Use');
			if ($phpdoctor->getOption('tree')) $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');
			
			$this->_depth = $package->depth() + 1;
			
			$classes =& $package->allClasses();
			
			if ($classes) {
                ksort($classes);
				foreach ($classes as $name => $class) {
					
					ob_start();
					
					echo "<hr>\n\n";
					
					echo '<div class="qualifiedName">', $class->qualifiedName(), "</div>\n";
					$this->_sourceLocation($class);
					
					if ($class->isInterface()) {
						echo '<h1>Interface ', $class->name(), "</h1>\n\n";
					} else {
						echo '<h1>Class ', $class->name(), "</h1>\n\n";
					}
					
					echo '<pre class="tree">';
					$result = $this->_buildTree($rootDoc, $classes[$name]);
					echo $result[0];
					echo "</pre>\n\n";
					
					$implements =& $class->interfaces();
					if (count($implements) > 0) {
						echo "<dl>\n";
						echo "<dt>All Implemented Interfaces:</dt>\n";
						echo '<dd>';
						foreach ($implements as $interface) {
						    echo '<a href="', str_repeat('../', $this->_depth), $interface->asPath(), '">';
						    if ($interface->packageName() != $class->packageName()) {
						        echo $interface->packageName(), '\\';
						    }
						    echo $interface->name(), '</a> ';
						}
						echo "</dd>\n";
						echo "</dl>\n\n";
					}
					
					echo "<hr>\n\n";
					
					if ($class->isInterface()) {
						echo '<p class="signature">', $class->modifiers(), ' interface <strong>', $class->name(), '</strong>';
					} else {
						echo '<p class="signature">', $class->modifiers(), ' class <strong>', $class->name(), '</strong>';
					}
					if ($class->superclass()) {
						$superclass =& $rootDoc->classNamed($class->superclass());
						if ($superclass) {
							echo '<br>extends <a href="', str_repeat('../', $this->_depth), $superclass->asPath(), '">', $superclass->name(), "</a>\n\n";
						} else {
							echo '<br>extends ', $class->superclass(), "\n\n";
						}
					}
					echo "</p>\n\n";
					
					$textTag =& $class->tags('@text');
					if ($textTag) {
						echo '<div class="comment" id="overview_description">', $this->_processInlineTags($textTag), "</div>\n\n";
					}

					$this->_processTags($class->tags());

					echo "<hr>\n\n";

					$constants =& $class->constants();
                    ksort($constants);
					$fields =& $class->fields();
                    ksort($fields);
					$methods =& $class->methods();
                    ksort($methods);

					if ($constants) {
						echo '<table id="summary_field">', "\n";
						echo '<tr><th colspan="2">Constant Summary</th></tr>', "\n";
						foreach ($constants as $field) {
							$textTag =& $field->tags('@text');
							echo "<tr>\n";
							echo '<td class="type">', $field->modifiers(FALSE), ' ', $field->typeAsString(), "</td>\n";
							echo '<td class="description">';
							echo '<p class="name"><a href="#', $field->name(), '">';
							if (is_null($field->constantValue())) echo '$';
							echo $field->name(), '</a></p>';
							if ($textTag) {
								echo '<p class="description">', strip_tags($this->_processInlineTags($textTag, TRUE), '<a><b><strong><u><em>'), '</p>';
							}
							echo "</td>\n";
							echo "</tr>\n";
						}
						echo "</table>\n\n";
					}
					
					if ($fields) {
						echo '<table id="summary_field">', "\n";
						echo '<tr><th colspan="2">Field Summary</th></tr>', "\n";
						foreach ($fields as $field) {
							$textTag =& $field->tags('@text');
							echo "<tr>\n";
							echo '<td class="type">', $field->modifiers(FALSE), ' ', $field->typeAsString(), "</td>\n";
							echo '<td class="description">';
							echo '<p class="name"><a href="#', $field->name(), '">';
							if (is_null($field->constantValue())) echo '$';
							echo $field->name(), '</a></p>';
							if ($textTag) {
								echo '<p class="description">', strip_tags($this->_processInlineTags($textTag, TRUE), '<a><b><strong><u><em>'), '</p>';
							}
							echo "</td>\n";
							echo "</tr>\n";
						}
						echo "</table>\n\n";
					}
					
					if ($class->superclass()) {
                        $superclass =& $rootDoc->classNamed($class->superclass());
                        if ($superclass) {
                            $this->inheritFields($superclass, $rootDoc, $package);
                        }
					}

					if ($methods) {
						echo '<table id="summary_method">', "\n";
						echo '<tr><th colspan="2">Method Summary</th></tr>', "\n";
                        foreach($methods as $method) {
                            $textTag =& $method->tags('@text');
                            echo "<tr>\n";
                            echo '<td class="type">', $method->modifiers(FALSE), ' ', $method->returnTypeAsString(), "</td>\n";
                            echo '<td class="description">';
                            echo '<p class="name"><a href="#', $method->name(), '()">', $method->name(), '</a>', $method->flatSignature(), '</p>';
                            if ($textTag) {
                                echo '<p class="description">', strip_tags($this->_processInlineTags($textTag, TRUE), '<a><b><strong><u><em>'), '</p>';
                            }
                            echo "</td>\n";
                            echo "</tr>\n";
                        }
						echo "</table>\n\n";
					}
					
					if ($class->superclass()) {
                        $superclass =& $rootDoc->classNamed($class->superclass());
                        if ($superclass) {
                            $this->inheritMethods($superclass, $rootDoc, $package);
                        }
					}

					if ($constants) {
						echo '<h2 id="detail_field">Constant Detail</h2>', "\n";
						foreach($constants as $field) {
							$textTag =& $field->tags('@text');
							$type =& $field->type();
							$this->_sourceLocation($field);
							echo '<h3 id="', $field->name(),'">', $field->name(), "</h3>\n";
							echo '<code class="signature">', $field->modifiers(), ' ', $field->typeAsString(), ' <strong>';
							if (is_null($field->constantValue())) echo '$';
							echo $field->name(), '</strong>';
							if (!is_null($field->value())) echo ' = ', htmlspecialchars($field->value());
							echo "</code>\n";
                            echo '<div class="details">', "\n";
							if ($textTag) {
								echo $this->_processInlineTags($textTag);
							}
							$this->_processTags($field->tags());
                            echo "</div>\n\n";
							echo "<hr>\n\n";
						}
					}

					if ($fields) {
						echo '<h2 id="detail_field">Field Detail</h2>', "\n";
						foreach($fields as $field) {
							$textTag =& $field->tags('@text');
							$type =& $field->type();
							$this->_sourceLocation($field);
							echo '<h3 id="', $field->name(),'">', $field->name(), "</h3>\n";
							echo '<code class="signature">', $field->modifiers(), ' ', $field->typeAsString(), ' <strong>';
							if (is_null($field->constantValue())) echo '$';
							echo $field->name(), '</strong>';
							if (!is_null($field->value())) echo ' = ', htmlspecialchars($field->value());
							echo "</code>\n";
                            echo '<div class="details">', "\n";
							if ($textTag) {
								echo $this->_processInlineTags($textTag);
							}
							$this->_processTags($field->tags());
                            echo "</div>\n\n";
							echo "<hr>\n\n";
						}
					}
					
					if ($methods) {
						echo '<h2 id="detail_method">Method Detail</h2>', "\n";
                        foreach($methods as $method) {
                            $textTag =& $method->tags('@text');
                            $this->_sourceLocation($method);
                            echo '<h3 id="', $method->name(),'()">', $method->name(), "</h3>\n";
                            echo '<code class="signature">', $method->modifiers(), ' ', $method->returnTypeAsString(), ' <strong>';
                            echo $method->name(), '</strong>', $method->flatSignature();
                            echo "</code>\n";
                            echo '<div class="details">', "\n";
                            if ($textTag) {
                                echo $this->_processInlineTags($textTag);
                            }
                            $this->_processTags($method->tags());
                            echo "</div>\n\n";
                            echo "<hr>\n\n";
                        }
					}

					$this->_output = ob_get_contents();
					ob_end_clean();
					
					$this->_write($package->asPath().'/'.strtolower($class->name()).'.html', $class->name(), TRUE);
				}
			}
		}
    }

	/** Build the class hierarchy tree which is placed at the top of the page.
	 *
	 * @param RootDoc rootDoc The root doc
	 * @param ClassDoc class Class to generate tree for
	 * @param int depth Depth of recursion
	 * @return mixed[]
	 */
	function _buildTree(&$rootDoc, &$class, $depth = NULL)
    {
		if ($depth === NULL) {
			$start = TRUE;
			$depth = 0;
		} else {
			$start = FALSE;
		}
		$output = '';
		$undefinedClass = FALSE;
		if ($class->superclass()) {
			$superclass =& $rootDoc->classNamed($class->superclass());
			if ($superclass) {
				$result = $this->_buildTree($rootDoc, $superclass, $depth);
				$output .= $result[0];
				$depth = ++$result[1];
			} else {
				$output .= $class->superclass().'<br>';
				$output .= str_repeat('   ', $depth).' └─';
				$depth++;
				$undefinedClass = TRUE;
			}
		}
		if ($depth > 0 && !$undefinedClass) {
			$output .= str_repeat('   ', $depth).' └─';
		}
		if ($start) {
			$output .= '<strong>'.$class->name().'</strong><br />';
		} else {
			$output .= '<a href="'.str_repeat('../', $this->_depth).$class->asPath().'">'.$class->name().'</a><br>';
		}
		return array($output, $depth);
	}
	
	/** Display the inherited fields of an element. This method calls itself
	 * recursively if the element has a parent class.
	 *
	 * @param ProgramElementDoc element
	 * @param RootDoc rootDoc
	 * @param PackageDoc package
	 */
	function inheritFields(&$element, &$rootDoc, &$package)
    {
		$fields =& $element->fields();
		if ($fields) {
            ksort($fields);
			$num = count($fields); $foo = 0;
			echo '<table class="inherit">', "\n";
			echo '<tr><th colspan="2">Fields inherited from ', $element->qualifiedName(), "</th></tr>\n";
			echo '<tr><td>';
			foreach($fields as $field) {
				echo '<a href="', str_repeat('../', $this->_depth), $field->asPath(), '">', $field->name(), '</a>';
				if (++$foo < $num) {
					echo ', ';
				}
			}
			echo '</td></tr>';
			echo "</table>\n\n";
			if ($element->superclass()) {
                $superclass =& $rootDoc->classNamed($element->superclass());
                if ($superclass) {
                    $this->inheritFields($superclass, $rootDoc, $package);
                }
			}
		}
	}
	
	/** Display the inherited methods of an element. This method calls itself
	 * recursively if the element has a parent class.
	 *
	 * @param ProgramElementDoc element
	 * @param RootDoc rootDoc
	 * @param PackageDoc package
	 */
	function inheritMethods(&$element, &$rootDoc, &$package)
    {
		$methods =& $element->methods();
		if ($methods) {
            ksort($methods);
			$num = count($methods); $foo = 0;
			echo '<table class="inherit">', "\n";
			echo '<tr><th colspan="2">Methods inherited from ', $element->qualifiedName(), "</th></tr>\n";
			echo '<tr><td>';
			foreach($methods as $method) {
				echo '<a href="', str_repeat('../', $this->_depth), $method->asPath(), '">', $method->name(), '</a>';
				if (++$foo < $num) {
					echo ', ';
				}
			}
			echo '</td></tr>';
			echo "</table>\n\n";
			if ($element->superclass()) {
                $superclass =& $rootDoc->classNamed($element->superclass());
                if ($superclass) {
                    $this->inheritMethods($superclass, $rootDoc, $package);
                }
			}
		}
	}

}

?>