You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
124 lines
3.4 KiB
124 lines
3.4 KiB
<?php |
|
/** |
|
* @link http://www.yiiframework.com/ |
|
* @copyright Copyright (c) 2008 Yii Software LLC |
|
* @license http://www.yiiframework.com/license/ |
|
*/ |
|
|
|
namespace yii\apidoc\helpers; |
|
|
|
use cebe\markdown\GithubMarkdown; |
|
use phpDocumentor\Reflection\DocBlock\Type\Collection; |
|
use yii\apidoc\models\TypeDoc; |
|
use yii\apidoc\renderers\BaseRenderer; |
|
use yii\helpers\Inflector; |
|
use yii\helpers\Markdown; |
|
|
|
/** |
|
* A Markdown helper with support for class reference links. |
|
* |
|
* @author Carsten Brandt <mail@cebe.cc> |
|
* @since 2.0 |
|
*/ |
|
class ApiMarkdown extends GithubMarkdown |
|
{ |
|
use ApiMarkdownTrait; |
|
|
|
/** |
|
* @var BaseRenderer |
|
*/ |
|
public static $renderer; |
|
|
|
protected $renderingContext; |
|
|
|
|
|
/** |
|
* Renders a code block |
|
*/ |
|
protected function renderCode($block) |
|
{ |
|
if (isset($block['language'])) { |
|
$class = isset($block['language']) ? ' class="language-' . $block['language'] . '"' : ''; |
|
|
|
return "<pre><code$class>" . $this->highlight($block['content'] . "\n", $block['language']) . "</code></pre>\n"; |
|
} else { |
|
return parent::renderCode($block); |
|
} |
|
} |
|
|
|
public static function highlight($code, $language) |
|
{ |
|
if ($language !== 'php') { |
|
return htmlspecialchars($code, ENT_NOQUOTES | ENT_SUBSTITUTE, 'UTF-8'); |
|
} |
|
|
|
// TODO improve code highlighting |
|
if (strncmp($code, '<?php', 5) === 0) { |
|
$text = @highlight_string(trim($code), true); |
|
} else { |
|
$text = highlight_string("<?php ".trim($code), true); |
|
$text = str_replace('<?php', '', $text); |
|
if (($pos = strpos($text, ' ')) !== false) { |
|
$text = substr($text, 0, $pos) . substr($text, $pos + 6); |
|
} |
|
} |
|
// remove <code><span style="color: #000000">\n and </span>tags added by php |
|
$text = substr(trim($text), 36, -16); |
|
|
|
return $text; |
|
} |
|
|
|
/** |
|
* @inheritDoc |
|
*/ |
|
protected function renderHeadline($block) |
|
{ |
|
$content = $this->renderAbsy($block['content']); |
|
$hash = Inflector::slug(strip_tags($content)); |
|
$hashLink = "<a href=\"#$hash\" name=\"$hash\" class=\"hashlink\">¶</a>"; |
|
|
|
$tag = 'h' . $block['level']; |
|
return "<$tag>$content $hashLink</$tag>"; |
|
} |
|
|
|
/** |
|
* @inheritdoc |
|
*/ |
|
protected function renderLink($block) |
|
{ |
|
$result = parent::renderLink($block); |
|
|
|
// add special syntax for linking to the guide |
|
$result = preg_replace_callback('/href="guide:([A-z0-9-.#]+)"/i', function($match) { |
|
return 'href="' . static::$renderer->generateGuideUrl($match[1]) . '"'; |
|
}, $result, 1); |
|
|
|
return $result; |
|
} |
|
|
|
/** |
|
* Converts markdown into HTML |
|
* |
|
* @param string $content |
|
* @param TypeDoc $context |
|
* @param boolean $paragraph |
|
* @return string |
|
*/ |
|
public static function process($content, $context = null, $paragraph = false) |
|
{ |
|
if (!isset(Markdown::$flavors['api'])) { |
|
Markdown::$flavors['api'] = new static; |
|
} |
|
|
|
if (is_string($context)) { |
|
$context = static::$renderer->apiContext->getType($context); |
|
} |
|
Markdown::$flavors['api']->renderingContext = $context; |
|
|
|
if ($paragraph) { |
|
return Markdown::processParagraph($content, 'api'); |
|
} else { |
|
return Markdown::process($content, 'api'); |
|
} |
|
} |
|
}
|
|
|