# Class yii\apidoc\helpers\ApiMarkdownLaTeX

Inheritance | yii\apidoc\helpers\ApiMarkdownLaTeX » cebe\markdown\latex\GithubMarkdown
Uses Traits | yii\apidoc\helpers\ApiMarkdownTrait
Available since version | 2.0
Source Code | https://github.com/yiisoft/yii2-apidoc/blob/master/helpers/ApiMarkdownLaTeX.php

A Markdown helper with support for class reference links.

## Public Properties

Hide inherited properties

Property | Type | Description | Defined By
--- | --- | --- | ---
$renderer | yii\apidoc\renderers\BaseRenderer |  | yii\apidoc\helpers\ApiMarkdownLaTeX
$renderingContext |  |  | yii\apidoc\helpers\ApiMarkdownLaTeX

## Protected Properties

Hide inherited properties

Property | Type | Description | Defined By
--- | --- | --- | ---

## Public Methods

Hide inherited methods

Method | Description | Defined By
--- | --- | ---
process() | Converts markdown into HTML | yii\apidoc\helpers\ApiMarkdownLaTeX

## Protected Methods

Hide inherited 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() |  | yii\apidoc\helpers\ApiMarkdownLaTeX
renderApiLinkText() |  | yii\apidoc\helpers\ApiMarkdownTrait
renderBrokenApiLink() |  | yii\apidoc\helpers\ApiMarkdownLaTeX
renderCode() |  | yii\apidoc\helpers\ApiMarkdownLaTeX
renderHeadline() |  | yii\apidoc\helpers\ApiMarkdownLaTeX
renderInlineCode() |  | yii\apidoc\helpers\ApiMarkdownLaTeX
renderQuote() | Renders a blockquote | yii\apidoc\helpers\ApiMarkdownLaTeX
translateBlockType() |  | yii\apidoc\helpers\ApiMarkdownLaTeX

## Property Details

Hide inherited properties

$renderer public static property
public static yii\apidoc\renderers\BaseRenderer $renderer = null
$renderingContext protected property
protected $renderingContext = null

## Method Details

Hide inherited methods

consumeQuote() protected method

Defined in: yii\apidoc\helpers\ApiMarkdownTrait::consumeQuote()

Consume lines for a blockquote element

protected void consumeQuote ( $lines, $current )
$lines |  |
$current |  |

Source code

                    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;
    }

parseApiLinkForContext() protected method (available since version 2.1.3)

Defined in: yii\apidoc\helpers\ApiMarkdownTrait::parseApiLinkForContext()

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

Source code

                    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);
    }

parseApiLinks() protected method

Defined in: yii\apidoc\helpers\ApiMarkdownTrait::parseApiLinks()

protected void parseApiLinks ( $text )
$text |  |

Source code

                    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
        ];
    }

process() public static method

Converts markdown into HTML

public static string process ( $content, $context = null, $paragraph = false )
$content | string |
$context | yii\apidoc\models\TypeDoc |
$paragraph | boolean |

Source code

                    public static function process($content, $context = null, $paragraph = false)
    {
        if (!isset(Markdown::$flavors['api-latex'])) {
            Markdown::$flavors['api-latex'] = new static;
        }
        if (is_string($context)) {
            $context = static::$renderer->apiContext->getType($context);
        }
        Markdown::$flavors['api-latex']->renderingContext = $context;
        if ($paragraph) {
            return Markdown::processParagraph($content, 'api-latex');
        } else {
            return Markdown::process($content, 'api-latex');
        }
    }

renderApiLink() protected method

protected void renderApiLink ( $block )
$block |  |

Source code

                    protected function renderApiLink($block)
    {
        // TODO allow break also on camel case
        $latex = '\texttt{';
        $latex .= str_replace(
            ['\\textbackslash', '::'],
            ['\allowbreak{}\\textbackslash', '\allowbreak{}::\allowbreak{}'],
            $this->escapeLatex(strip_tags($block[1]))
        );
        $latex .= '}';
        return $latex;
    }

renderApiLinkText() protected method

Defined in: yii\apidoc\helpers\ApiMarkdownTrait::renderApiLinkText()

protected null|string renderApiLinkText ( $title )
$title | null|string |

Source code

                    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();
    }

renderBrokenApiLink() protected method

protected void renderBrokenApiLink ( $block )
$block |  |

Source code

                    protected function renderBrokenApiLink($block)
    {
        return $this->renderApiLink($block);
    }

renderCode() protected method

protected void renderCode ( $block )
$block |  |

Source code

                    protected function renderCode($block)
    {
        $language = $block['language'] ?? 'text';
        // replace No-Break Space characters in code block, which do not render in LaTeX
        $content = preg_replace("/[\x{00a0}\x{202f}]/u", ' ', $block['content']);
        return implode("\n", [
            "\\begin{minted}{" . "$language}",
            $content,
            '\end{minted}',
            '',
        ]);
    }

renderHeadline() protected method

protected void renderHeadline ( $block )
$block |  |

Source code

                    protected function renderHeadline($block)
    {
        foreach ($block['content'] as $i => &$item) {
            if ($item[0] === 'inlineCode') {
                unset($block['content'][$i]);
            }
        }
        return parent::renderHeadline($block);
    }

renderInlineCode() protected method

protected void renderInlineCode ( $block )
$block |  |

Source code

                    protected function renderInlineCode($block)
    {
        // replace No-Break Space characters in code block, which do not render in LaTeX
        $content = preg_replace("/[\x{00a0}\x{202f}]/u", ' ', $block[1]);
        return '\\mintinline{text}{' . str_replace("\n", ' ', $content) . '}';
    }

renderQuote() protected method

Renders a blockquote

protected void renderQuote ( $block )
$block |  |

Source code

                    protected function renderQuote($block)
    {
        return '\begin{quote}' . $this->renderAbsy($block['content']) . "\\end{quote}\n";
    }

translateBlockType() protected method (available since version 2.0.5)

protected void translateBlockType ( $type )
$type |  |

Source code

                    protected function translateBlockType($type)
    {
        $key = ucfirst($type) . ':';
        if (isset(ApiMarkdown::$blockTranslations[$key])) {
            $translation = ApiMarkdown::$blockTranslations[$key];
        } else {
            $translation = $key;
        }
        return "$translation ";
    }