Trait yii\apidoc\helpers\ApiMarkdownTrait

Implemented byyii\apidoc\helpers\ApiMarkdown, yii\apidoc\helpers\ApiMarkdownLaTeX
Source Code https://github.com/yiisoft/yii2-apidoc/blob/master/helpers/ApiMarkdownTrait.php

Class ApiMarkdownTrait

Property Details

Hide inherited properties

$renderingContext public property

Method Details

Hide inherited methods

consumeQuote() protected method

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

            
parseApiLinks() protected method

protected void parseApiLinks ( $text )
$text

renderApiLink() protected method

Renders API link

protected string renderApiLink ( $block )
$block array

renderBrokenApiLink() protected method

Renders API link that is broken i.e. points nowhere

protected string renderBrokenApiLink ( $block )
$block array

renderQuote() protected method

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

            
translateBlockType() protected abstract method (available since version 2.0.5)

protected abstract void translateBlockType ( $type )
$type

                protected abstract function translateBlockType($type);