Projects / Api Generator

<?php
/**
 * DocblockTools - Contains helper methods for Documentator classes
 *
 * PHP 5.2+
 *
 * CakePHP(tm) : Rapid Development Framework (http://cakephp.org)
 * Copyright 2005-2009, Cake Software Foundation, Inc. (http://cakefoundation.org)
 *
 * Licensed under The MIT License
 * Redistributions of files must retain the above copyright notice.
 *
 * @copyright     Copyright 2005-2009, Cake Software Foundation, Inc. (http://cakefoundation.org)
 * @link          http://cakephp.org
 * @package       api_generator
 * @subpackage    api_generator.vendors
 * @since         ApiGenerator 0.1
 * @license       MIT License (http://www.opensource.org/licenses/mit-license.php)
 **/
class DocblockTools {
/**
 * parseDocBlock
 *
 * Cleans input comments of stars and /'s so it is more readable.
 * Creates a multi dimensional array. That contains semi parsed comments
 * 
 * Returns an array with the following
 * 'title' contains the title / first line of the doc-block
 * 'desc' contains the remainder of the doc block
 * 'tags' contains all the doc-blocks @tags.
 * 
 * @param string $comments The comment block to be cleaned
 * @return array Array of Filtered and separated comments
 **/
	public static function parseDocBlock($comments){
		$com = array();

		//remove stars and slashes
		$tmp = preg_replace('#^(\s*/\*\*|\s*\*+/|\s+\* ?)#m', '', $comments);

		//fix new lines
		$tmp = str_replace("\r\n", "\n", $tmp);
		$tmp = explode("\n", $tmp);

		$desc = '';	
		$tags = array();
		$preprocessed = array();
		for ($i = 0, $count = count($tmp); $i < $count; $i++ ) {
			$line = $tmp[$i];
			if (substr($line, 0, 1) !== '@' && $line !== '*' && !isset($preprocessed[$i])) {
				$desc .= "\n" . $line;
			}

			if (preg_match('/@([a-z0-9_-]+)\s?(.*)$/i', $tmp[$i], $parsedTag)) {
				// capture continued lines. (indented with 3 spaces or 1 tab)
				$done = false;
				$next = $i + 1;
				while (!$done) {
					if (isset($tmp[$next]) && preg_match('/^(?: {1,3}|\t)([^\t]*)$/i', $tmp[$next], $nextLine)) {
						$parsedTag[2] .= ' ' . trim($nextLine[1]);
						$preprocessed[$next] = true;
						$next++;
					} else {
						$done = true;
					}
				}
				if (isset($tags[$parsedTag[1]]) && !is_array($tags[$parsedTag[1]])) {
					$tags[$parsedTag[1]] = (array)$tags[$parsedTag[1]];
					$tags[$parsedTag[1]][] = $parsedTag[2];
				} elseif (isset($tags[$parsedTag[1]]) && is_array($tags[$parsedTag[1]])) {
					$tags[$parsedTag[1]][] = $parsedTag[2];
				} else {
					$tags[$parsedTag[1]] = $parsedTag[2];
				}
			}

		}
		if (isset($tags['param'])) {
			$params = (array)$tags['param'];
			$tags['param'] = array();
			foreach ($params as $param) {
				$paramDoc = preg_split('/\s+/', trim($param), 3);
				switch (count($paramDoc)) {
					case 2:
						list($type, $name) = $paramDoc;
						break;
					case 3:
						list($type, $name, $description) = $paramDoc;
						break;
				}
				$name = @trim($name, '$');
				$tags['param'][$name] = compact('type', 'description');
			}
		}
		$com['description'] = trim($desc);
		$com['tags'] = $tags;
		return $com;
	}
/**
 * Create a string representation of the method signature.
 *
 * @param ReflectionFunctionAbstract $func The function you want a signature for.
 * @return void
 **/
	public static function makeFunctionSignature(ReflectionFunctionAbstract $func) {
		$signature = $func->getName() . '( ';
		foreach ($func->getParameters() as $param) {
			$signature .= '$' . $param->getName();
			if ($param->isDefaultValueAvailable()) {
				$signature .= ' = ' . var_export($param->getDefaultValue(), true);
			}
			$signature .= ', ';
		}
		if ($func->getNumberOfParameters() > 0) {
			$signature = substr($signature, 0, -2);
		}
		$signature .= ' )';
		return $signature;
	}
}