ApiMarkdown.php 4.94 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39
<?php
/**
 * @link http://www.yiiframework.com/
 * @copyright Copyright (c) 2008 Yii Software LLC
 * @license http://www.yiiframework.com/license/
 */

namespace yii\apidoc\helpers;

use phpDocumentor\Reflection\DocBlock\Type\Collection;
use yii\apidoc\models\MethodDoc;
use yii\apidoc\models\TypeDoc;
use yii\apidoc\templates\BaseRenderer;

/**
 * A Markdown helper with support for class reference links.
 *
 * @author Carsten Brandt <mail@cebe.cc>
 * @since 2.0
 */
class ApiMarkdown extends Markdown
{
	/**
	 * @var BaseRenderer
	 */
	public static $renderer;
	/**
	 * @var ApiMarkdown
	 */
	private static $_instance;

	private $context;

	public function highlight(&$block, &$markup)
	{
		// TODO improve code highlighting
		if (strncmp($block['text'], '<?php', 5) === 0) {
			$text = highlight_string(trim($block['text']), true);
		} else {
40
			$text = highlight_string("<?php ".trim($block['text']), true);
Carsten Brandt committed
41
			$text = str_replace('&lt;?php', '', $text);
42 43 44
			if (($pos = strpos($text, '&nbsp;')) !== false) {
				$text = substr($text, 0, $pos) . substr($text, $pos + 6);
			}
45
		}
46 47
		// remove <code><span style="color: #000000">\n and </span>tags added by php
		$text = substr(trim($text), 36, -16);
48

49 50 51 52 53 54 55 56 57
		$code = '<pre><code';
		if (isset($block['language']))
		{
			if ($block['language'] !== 'php') {
				return false;
			}
			$code .= ' class="language-'.$block['language'].'"';
		}
		$code .= '>'.$text.'</code></pre>'."\n";
58

59
		$markup .= $code;
60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162
		return true;
	}

	public function init()
	{
		$this->registerBlockHander('code', [$this, 'highlight']);
		$this->registerBlockHander('fenced', [$this, 'highlight']);

		$context = &$this->context;
		// register marker for code links
		$this->unregisterInlineMarkerHandler('[');
		$this->registerInlineMarkerHandler('[[', function($text, &$markup) use (&$context) {

			if (preg_match('/^\[\[([\w\d\\\\\(\):$]+)(\|[^\]]*)?\]\]/', $text, $matches)) {

				$offset = strlen($matches[0]);

				$object = $matches[1];
				$title = (empty($matches[2]) || $matches[2] == '|') ? null : substr($matches[2], 1);

				if (($pos = strpos($object, '::')) !== false) {
					$typeName = substr($object, 0, $pos);
					$subjectName = substr($object, $pos + 2);
					if ($context !== null) {
						// Collection resolves relative types
						$typeName = (new Collection([$typeName], $context->phpDocContext))->__toString();
					}
					$type = static::$renderer->context->getType($typeName);
					if ($type === null) {
						static::$renderer->context->errors[] = [
							'file' => ($context !== null) ? $context->sourceFile : null,
							'message' => 'broken link to ' . $typeName . '::' . $subjectName . (($context !== null) ? ' in ' . $context->name : ''),
						];
						$markup .= '<span style="background: #f00;">' . $typeName . '::' . $subjectName . '</span>';
					} else {
						if (($subject = $type->findSubject($subjectName)) !== null) {
							if ($title === null) {
								$title = $type->name . '::' . $subject->name;
								if ($subject instanceof MethodDoc) {
									$title .= '()';
								}
							}
							$markup .= static::$renderer->subjectLink($subject, $title);
						} else {
							static::$renderer->context->errors[] = [
								'file' => ($context !== null) ? $context->sourceFile : null,
								'message' => 'broken link to ' . $type->name . '::' . $subjectName . (($context !== null) ? ' in ' . $context->name : ''),
							];
							$markup .= '<span style="background: #ff0;">' . $type->name . '</span><span style="background: #f00;">::' . $subjectName . '</span>';
						}
					}
					return $offset;
				} elseif ($context !== null && ($subject = $context->findSubject($object)) !== null) {
					$markup .= static::$renderer->subjectLink($subject, $title);
					return $offset;
				}
				if ($context !== null) {
					// Collection resolves relative types
					$object = (new Collection([$object], $context->phpDocContext))->__toString();
				}
				if (($type = static::$renderer->context->getType($object)) !== null) {
					$markup .= static::$renderer->typeLink($type, $title);
					return $offset;
				}
				static::$renderer->context->errors[] = [
					'file' => ($context !== null) ? $context->sourceFile : null,
					'message' => 'broken link to ' . $object . (($context !== null) ? ' in ' . $context->name : ''),
				];
				$markup .= '<span style="background: #f00;">' . $object . '</span>';
				return $offset;
			} else {
				$markup .= '[[';
				return 2;
			}
		});
		$this->registerInlineMarkerHandler('[', null);
	}

	/**
	 * Converts markdown into HTML
	 *
	 * @param string $content
	 * @param TypeDoc $context
	 * @return string
	 */
	public static function process($content, $context = null, $line = false)
	{
		if (static::$_instance === null) {
			static::$_instance = new static;
		}

		if (is_string($context)) {
			$context = static::$renderer->context->getType($context);
		}
		static::$_instance->context = $context;

		if ($line) {
			return static::$_instance->parseLine($content);
		} else {
			return static::$_instance->parse($content);
		}
	}
}