api_generator / branches / master / views / helpers / api_utils.php

history 
<?php
/**
 * Class to style php code as an ordered list.
 *
 * Originally from http://shiflett.org/blog/2006/oct/formatting-and-highlighting-php-code-listings
 * 
 * Adapted into a helper for use in ApiGenerator
 * Some minor modifications to allow it to work with php4. 
 * 
 * Also changed:
 *  - And to add line-# anchors to each line.
 *  - Removed whitespace reductions. Caused issues with source -> highlight links
 *
 * 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 ApiUtilsHelper extends AppHelper {
/**
 * Helpers
 *
 * @var array
 **/
	public $helpers = array('Number');
/**
 * constructor
 *
 * @return void
 **/
	function __construct() {
		ini_set('highlight.comment', 'comment');
		ini_set('highlight.default', 'default');
		ini_set('highlight.keyword', 'keyword');
		ini_set('highlight.string', 'string');
		ini_set('highlight.html', 'html');
	}

/**
 * Genereates a coloured percentage number
 * @param float $value Value to display
 * @return string Html with colour class name
 **/
	public function colourPercent($value) {
		$value = $float = $this->Number->toPercentage($value * 100);
		$class = '';
		if ($value >= 75) {
			$class = 'green';
		} else if ($value < 75 && $value > 50) {
			$class = 'yellow';
		} else {
			$class = 'red';
		}
		return $this->output(sprintf('<span class="%s">%s</span>', $class, $float));
	}

/**
 * highlights code so it can be displayed
 *
 * @param string $code Code to highlight.
 * @return string
 **/
	function highlight($code= "") {
		$code= highlight_string($code, TRUE);
		/* Clean Up */
		if (phpversion() >= 5) {
			$code= substr($code, 33, -15);
			$code= str_replace('<span style="color: ', '<span class="', $code);
		}

		$code= str_replace('&nbsp;', ' ', $code);
		$code= str_replace('&amp;', '&#38;', $code);
		$code= str_replace('<br />', "\n", $code);

		/* Normalize Newlines */
		$code= str_replace("\r", "\n", $code);

		$lines= explode("\n", $code);

		/* Previous Style */
		$previous= FALSE;

		/* Output Listing */
		$htmlOut = '';
		
		foreach ($lines as $key => $line) {
			if (substr($line, 0, 7) == '</span>') {
				$previous= FALSE;
				$line = substr($line, 7);
			}

			if (empty ($line)) {
				$line = '&#160;';
			}

			if ($previous) {
				$line = "<span class=\"$previous\">" . $line;
			}

			/* Set Previous Style */
			if (strpos($line, '<span') !== FALSE) {
				switch (substr($line, strrpos($line, '<span') + 13, 1)) {
					case 'c' :
						$previous= 'comment';
						break;
					case 'd' :
						$previous= 'default';
						break;
					case 'k' :
						$previous= 'keyword';
						break;
					case 's' :
						$previous= 'string';
						break;
				}
			}

			/* Unset Previous Style Unless Span Continues */
			if (substr($line, -7) == '</span>') {
				$previous= FALSE;
			} elseif ($previous) {
				$line .= '</span>';
			}
			$lineno = $key + 1;
			if ($key % 2) {
				$htmlOut .= '<tr class="even">';
			} else {
				$htmlOut .= '<tr>';
			}
			$htmlOut .= "<th id=\"l-$lineno\"><a href=\"#l-$lineno\">$lineno</a></th>\n";
			$htmlOut .= "\t<td id=\"line-$lineno\">$line</td>\n";
		}
		$table = <<<HTML
<div class="code-container">
<table class="code-block" cellpadding="0" cellspacing="0">
	%s
</table>
</div>
HTML;
		$return = sprintf($table, $htmlOut);
		return $return;
	}

/**
 * Sort a collection of arrays by the key 'name'
 *
 * @param array $collection Reference to the array needing sorting.
 * @return void works by reference
 **/
	public function sortByName(&$collection) {
		if (!is_array($collection)) {
			return;
		}
		return usort($collection, array($this, '_sorter'));
	}
/**
 * sortByName helper function
 *
 * @return integer
 **/
	protected function _sorter($one, $two) {
		$cleanOne = str_replace('_', '', $one['name']);
		$cleanTwo = str_replace('_', '', $two['name']);
		return strnatcasecmp($cleanOne, $cleanTwo);
	}
/**
 * Element inclusion, checks for file existence first, and if exists, passes to regular view helper
 *
 * @param string $name 
 * @param string $params 
 * @param string $loadHelpers 
 * @return string
 * @access public
 */	
	public function element($name, $params = array(), $loadHelpers = false) {
		$file = $plugin = $key = null;
		$view = ClassRegistry::getObject('view');
		$paths = $view->_paths($this->plugin);

		foreach ($paths as $path) {
			if (file_exists($path . 'elements' . DS . $name . $view->ext)) {
				return $view->element($name, $params, $loadHelpers);
			}
		}
		return '';
	}
}