Trait yii\apidoc\helpers\ApiMarkdownTrait
| Implemented by | yii\apidoc\helpers\ApiMarkdown, yii\apidoc\helpers\ApiMarkdownLaTeX |
|---|---|
| Source Code | https://github.com/yiisoft/yii2-apidoc/blob/master/helpers/ApiMarkdownTrait.php |
Class ApiMarkdownTrait
Public Properties
| Property | Type | Description | Defined By |
|---|---|---|---|
| $renderingContext | yii\apidoc\models\TypeDoc | yii\apidoc\helpers\ApiMarkdownTrait |
Protected Methods
| Method | Description | Defined By |
|---|---|---|
| consumeQuote() | Consume lines for a blockquote element | yii\apidoc\helpers\ApiMarkdownTrait |
| parseApiLinkForContext() | Attempts to parse an API link for the given context. | yii\apidoc\helpers\ApiMarkdownTrait |
| parseApiLinks() | yii\apidoc\helpers\ApiMarkdownTrait | |
| renderApiLink() | Renders API link | yii\apidoc\helpers\ApiMarkdownTrait |
| renderApiLinkText() | yii\apidoc\helpers\ApiMarkdownTrait | |
| renderBrokenApiLink() | Renders API link that is broken i.e. points nowhere | yii\apidoc\helpers\ApiMarkdownTrait |
| renderQuote() | Renders a blockquote | yii\apidoc\helpers\ApiMarkdownTrait |
| translateBlockType() | yii\apidoc\helpers\ApiMarkdownTrait |
Property Details
Method Details
Consume lines for a blockquote element
| protected void consumeQuote ( $lines, $current ) | ||
| $lines | ||
| $current | ||
protected function consumeQuote($lines, $current)
{
$block = parent::consumeQuote($lines, $current);
$blockTypes = [
'warning',
'note',
'info',
'tip',
];
// check whether this is a special Info, Note, Warning, Tip block
$content = $block[0]['content'];
$first = reset($content);
if (isset($first[0]) && $first[0] === 'paragraph') {
$parfirst = reset($first['content']);
if (isset($parfirst[0]) && $parfirst[0] === 'text') {
foreach ($blockTypes as $type) {
if (strncasecmp("$type: ", $parfirst[1], $len = strlen($type) + 2) === 0) {
// remove block indicator
$block[0]['content'][0]['content'][0][1] = substr($parfirst[1], $len);
// add translated block indicator as bold text
array_unshift($block[0]['content'][0]['content'], [
'strong',
[
['text', $this->translateBlockType($type)],
],
]);
$block[0]['blocktype'] = $type;
break;
}
}
}
}
return $block;
}
Attempts to parse an API link for the given context.
| protected array parseApiLinkForContext ( $offset, $object, $title, $context ) | ||
| $offset | integer | |
| $object | string | |
| $title | string|null | |
| $context | yii\apidoc\models\TypeDoc|null | |
| throws | yii\apidoc\helpers\BrokenLinkException |
if the object can't be resolved |
|---|---|---|
protected function parseApiLinkForContext($offset, $object, $title, $context)
{
if (($pos = strpos($object, '::')) !== false) {
$typeName = substr($object, 0, $pos);
$subjectName = substr($object, $pos + 2);
if ($context !== null) {
if (!$context->phpDocContext) {
throw new BrokenLinkException($object, $context);
}
if (isset($context->phpDocContext->getNamespaceAliases()[$typeName])) {
$typeName = $context->phpDocContext->getNamespaceAliases()[$typeName];
} else {
$typeName = $context->phpDocContext->getNamespace() . '\\' . $typeName;
}
}
/** @var $type TypeDoc */
$type = static::$renderer->apiContext->getType($typeName);
if ($type === null || $subjectName === '') {
throw new BrokenLinkException($typeName . '::' . $subjectName, $context);
}
if (($subject = $type->findSubject($subjectName)) === null) {
throw new BrokenLinkException($type->name . '::' . $subjectName, $context);
}
if ($title === null) {
$title = $type->name . '::' . $subject->name;
if ($subject instanceof MethodDoc) {
$title .= '()';
}
}
return [
['apiLink', static::$renderer->createSubjectLink($subject, $title)],
$offset
];
}
if ($context !== null) {
if (($subject = $context->findSubject($object)) !== null) {
return [
['apiLink', static::$renderer->createSubjectLink($subject, $title)],
$offset
];
}
if (!$context->phpDocContext) {
throw new BrokenLinkException($object, $context);
}
if (isset($context->phpDocContext->getNamespaceAliases()[$object])) {
$object = $context->phpDocContext->getNamespaceAliases()[$object];
} else {
$object = $context->phpDocContext->getNamespace() . '\\' . $object;
}
}
if (($type = static::$renderer->apiContext->getType($object)) !== null) {
return [
['apiLink', static::$renderer->createTypeLink($type, null, $title)],
$offset
];
}
if (strpos($typeLink = static::$renderer->createTypeLink($object, null, $title), '<a href') !== false) {
return [
['apiLink', $typeLink],
$offset
];
}
throw new BrokenLinkException($object, $context);
}
| protected void parseApiLinks ( $text ) | ||
| $text | ||
protected function parseApiLinks($text)
{
if (!preg_match('/^\[\[([\w\d\\\\():$]+)(\|[^]]*)?]]/', $text, $matches)) {
return [['text', '[['], 2];
}
$offset = strlen($matches[0]);
$object = $matches[1];
$title = (empty($matches[2]) || $matches[2] === '|') ? null : substr($matches[2], 1);
$title = $this->renderApiLinkText($title);
/** @var TypeDoc[] $contexts */
$contexts = [];
$this->_findContexts($this->renderingContext, $contexts);
$contexts = array_unique($contexts, SORT_REGULAR);
$contexts[] = null;
$e = null;
foreach ($contexts as $context) {
/** @var TypeDoc|null $context */
try {
return $this->parseApiLinkForContext($offset, $object, $title, $context);
} catch (BrokenLinkException $e) {
// Keep going if there are more contexts to check
}
}
// If we made it this far, there was a broken link
/** @var BrokenLinkException $e */
static::$renderer->apiContext->errors[] = [
'file' => ($e->context !== null) ? $e->context->sourceFile : null,
'message' => $e->getMessage(),
];
return [
['brokenApiLink', '<span class="broken-link">' . $object . '</span>'],
$offset
];
}
Renders API link
| protected string renderApiLink ( $block ) | ||
| $block | array | |
protected function renderApiLink($block)
{
return $block[1];
}
| protected null|string renderApiLinkText ( $title ) | ||
| $title | null|string | |
protected function renderApiLinkText($title)
{
if (!$title) {
return $title;
}
$title = Markdown::process($title);
$title = mb_convert_encoding($title, 'HTML-ENTITIES', 'UTF-8');
$doc = new DOMDocument();
$doc->loadHTML($title);
return $doc->getElementsByTagName('p')[0]->childNodes[0]->c14n();
}
Renders API link that is broken i.e. points nowhere
| protected string renderBrokenApiLink ( $block ) | ||
| $block | array | |
protected function renderBrokenApiLink($block)
{
return $block[1];
}
Renders a blockquote
| protected void renderQuote ( $block ) | ||
| $block | ||
protected function renderQuote($block)
{
$class = '';
if (isset($block['blocktype'])) {
$class = ' class="' . $block['blocktype'] . '"';
}
return "<blockquote{$class}>" . $this->renderAbsy($block['content']) . "</blockquote>\n";
}
| protected abstract void translateBlockType ( $type ) | ||
| $type | ||
protected abstract function translateBlockType($type);