Abstract Class yii\apidoc\templates\html\GuideRenderer

All Classes | Properties | Methods | Constants
Inheritanceyii\apidoc\templates\html\GuideRenderer » yii\apidoc\renderers\GuideRenderer » yii\apidoc\renderers\BaseRenderer » yii\base\Component
Subclassesyii\apidoc\templates\bootstrap\GuideRenderer, yii\apidoc\templates\pdf\GuideRenderer, yii\apidoc\templates\project\GuideRenderer
Available since extension's version2.0
Source Code https://github.com/yiisoft/yii2-apidoc/blob/master/templates/html/GuideRenderer.php

Public Properties

Hide inherited properties

Property Type Description Defined By
$apiContext yii\apidoc\models\Context|null The yii\apidoc\models\Context currently being rendered. yii\apidoc\renderers\BaseRenderer
$apiUrl string|null yii\apidoc\renderers\BaseRenderer
$controller \yii\console\Controller<\yii\console\Application>|null The apidoc controller instance. yii\apidoc\renderers\BaseRenderer
$guidePrefix string yii\apidoc\renderers\BaseRenderer
$guideUrl string|null yii\apidoc\renderers\BaseRenderer
$layout string|false yii\apidoc\templates\html\GuideRenderer
$pageTitle string|null String to use as the title of the generated page. yii\apidoc\renderers\BaseRenderer
$readmeUrl string|null URL for the README to use for the index of the guide. yii\apidoc\renderers\BaseRenderer
$view \yii\web\View The view instance. yii\apidoc\templates\html\GuideRenderer

Public Methods

Hide inherited methods

Method Description Defined By
createSubjectLink() Creates a link to a subject yii\apidoc\renderers\BaseRenderer
createTypeLink() Creates a link to a type (class, interface or trait) yii\apidoc\renderers\BaseRenderer
generateApiUrl() Generate an url to a type in apidocs yii\apidoc\templates\html\GuideRenderer
generateGuideUrl() Generate an url to a guide page yii\apidoc\renderers\BaseRenderer
getGuideReferences() yii\apidoc\templates\html\GuideRenderer
getView() yii\apidoc\templates\html\GuideRenderer
init() yii\apidoc\templates\html\GuideRenderer
render() Renders a set of files given into target directory. yii\apidoc\templates\html\GuideRenderer

Protected Methods

Hide inherited methods

Method Description Defined By
afterMarkdownProcess() Callback that is called after markdown is processed. yii\apidoc\templates\html\GuideRenderer
fixMarkdownLinks() Adds guide name to link URLs in markdown yii\apidoc\templates\html\GuideRenderer
generateGuideFileName() Given markdown file name generates resulting html file name yii\apidoc\templates\html\GuideRenderer
generateLink() Generate link markup yii\apidoc\templates\html\GuideRenderer
loadGuideStructure() Loads guide structure from a set of files yii\apidoc\renderers\GuideRenderer

Constants

Hide inherited constants

Constant Value Description Defined By
PHPSTAN_TYPE_BASE_URL 'https://phpstan.org/writing-php-code/phpdoc-types#' yii\apidoc\renderers\BaseRenderer
PHP_CLASS_BASE_URL 'https://www.php.net/class.' yii\apidoc\renderers\BaseRenderer
PHP_TYPES [ 'callable', 'array', 'string', 'boolean', 'bool', 'integer', 'int', 'float', 'object', 'resource', 'null', 'false', 'true', 'iterable', 'mixed', 'never', 'void', ] yii\apidoc\renderers\BaseRenderer
PHP_TYPE_ALIASES [ 'true' => 'boolean', 'false' => 'boolean', 'bool' => 'boolean', 'int' => 'integer', ] yii\apidoc\renderers\BaseRenderer
PHP_TYPE_BASE_URL 'https://www.php.net/language.types.' yii\apidoc\renderers\BaseRenderer
PHP_TYPE_DISPLAY_ALIASES [ 'bool' => 'boolean', 'int' => 'integer', ] yii\apidoc\renderers\BaseRenderer
PSALM_TYPE_BASE_URL 'https://psalm.dev/docs/annotating_code/type_syntax/' yii\apidoc\renderers\BaseRenderer

Property Details

Hide inherited properties

$layout public property
public string|false $layout = null
$view public property

The view instance.

public \yii\web\View $view = null

Method Details

Hide inherited methods

afterMarkdownProcess() protected method (available since version 2.0.5)

Callback that is called after markdown is processed.

You may override it to do some post processing. The default implementation fixes some markdown links using fixMarkdownLinks() on the output.

protected string afterMarkdownProcess ( string $file, string $output, yii\apidoc\helpers\ApiMarkdown $renderer )
$file string

The file that has been processed.
$output string

The rendered HTML output.
$renderer yii\apidoc\helpers\ApiMarkdown

The renderer instance.

 

                protected function afterMarkdownProcess($file, $output, $renderer)
{
    return $this->fixMarkdownLinks($output);
}
createSubjectLink() public method

Defined in: yii\apidoc\renderers\BaseRenderer::createSubjectLink()

Creates a link to a subject

public string createSubjectLink ( yii\apidoc\models\BaseDoc|yii\apidoc\models\PseudoTypeDoc|yii\apidoc\models\PseudoTypeImportDoc $subject, string|null $title = null, array $options = [], yii\apidoc\models\TypeDoc|null $type = null )
$subject yii\apidoc\models\BaseDoc|yii\apidoc\models\PseudoTypeDoc|yii\apidoc\models\PseudoTypeImportDoc
$title string|null
$options array

Additional HTML attributes for the link.
$type yii\apidoc\models\TypeDoc|null

createTypeLink() public method

Defined in: yii\apidoc\renderers\BaseRenderer::createTypeLink()

Creates a link to a type (class, interface or trait)

public string createTypeLink ( yii\apidoc\models\BaseDoc|yii\apidoc\models\BaseDoc[]|\phpDocumentor\Reflection\Type|\phpDocumentor\Reflection\Type[]|string|string[]|null $types, yii\apidoc\models\BaseDoc|null $context = null, string|null $title = null, array $options = [], ?\yii\apidoc\models\TypeDoc $currentTypeDoc = null )
$types yii\apidoc\models\BaseDoc|yii\apidoc\models\BaseDoc[]|\phpDocumentor\Reflection\Type|\phpDocumentor\Reflection\Type[]|string|string[]|null
$context yii\apidoc\models\BaseDoc|null
$title string|null

A title to be used for the link TODO check whether [[yii...|Class]] is supported
$options array

Additional HTML attributes for the link.
$currentTypeDoc ?\yii\apidoc\models\TypeDoc

fixMarkdownLinks() protected method

Adds guide name to link URLs in markdown

protected string fixMarkdownLinks ( string $content )
$content string

generateApiUrl() public method

Generate an url to a type in apidocs

public mixed generateApiUrl ( mixed $typeName )
$typeName mixed 

                public function generateApiUrl($typeName)
{
    return rtrim((string) $this->apiUrl, '/') . '/' . strtolower(str_replace('\\', '-', $typeName)) . '.html';
}
generateGuideFileName() protected method

Given markdown file name generates resulting html file name

protected string generateGuideFileName ( string $file )
$file string

Markdown file name

 

                protected function generateGuideFileName($file)
{
    return $this->guidePrefix . basename($file, '.md') . '.html';
}
generateGuideUrl() public method

Defined in: yii\apidoc\renderers\BaseRenderer::generateGuideUrl()

Generate an url to a guide page

public string generateGuideUrl ( string $file )
$file string 

                public function generateGuideUrl($file)
{
    //skip parsing external url
    if ((str_contains($file, 'https://')) || (str_contains($file, 'http://'))) {
        return $file;
    }
    $hash = '';
    if (($pos = strpos($file, '#')) !== false) {
        $hash = substr($file, $pos);
        $file = substr($file, 0, $pos);
    }
    return rtrim((string) $this->guideUrl, '/') . '/' . $this->guidePrefix . basename($file, '.md') . '.html' . $hash;
}
generateLink() protected method

Generate link markup

protected mixed generateLink ( mixed $text, mixed $href, mixed $options = [] )
$text mixed
$href mixed
$options mixed

Additional HTML attributes for the link.

getGuideReferences() public method

public mixed getGuideReferences ( )

                public function getGuideReferences()
{
    // TODO implement for api docs
    // $refs = [];
    // foreach ($this->markDownFiles as $file) {
    //     $refName = 'guide-' . basename($file, '.md');
    //     $refs[$refName] = ['url' => $this->generateGuideFileName($file)];
    // }
    // return $refs;
}
getView() public method

public \yii\web\View getView ( )
return \yii\web\View

The view instance

 

                public function getView()
{
    if ($this->_view === null) {
        $this->_view = new View();
        $assetPath = Yii::getAlias($this->_targetDir) . '/assets';
        if (!is_dir($assetPath)) {
            mkdir($assetPath);
        }
        $this->_view->assetManager = new AssetManager([
            'basePath' => $assetPath,
            'baseUrl' => './assets',
        ]);
    }
    return $this->_view;
}
init() public method

public mixed init ( )

                public function init()
{
    parent::init();
    if ($this->pageTitle === null) {
        $this->pageTitle = 'The Definitive Guide to Yii 2.0';
    }
}
loadGuideStructure() protected method

Defined in: yii\apidoc\renderers\GuideRenderer::loadGuideStructure()

Loads guide structure from a set of files

protected array loadGuideStructure ( array $files )
$files array 

                protected function loadGuideStructure($files)
{
    $chapters = [];
    foreach ($files as $file) {
        $contents = file_get_contents($file);
        if (basename((string) $file) == 'README.md') {
            $indexAnalyzer = new IndexFileAnalyzer();
            $chapters = $indexAnalyzer->analyze($contents);
            break;
        }
        if (preg_match("/^(.*)\n=+/", $contents, $matches)) {
            $headlines[$file] = $matches[1];
        } else {
            $headlines[$file] = basename((string) $file);
        }
    }
    return $chapters;
}
render() public method

Renders a set of files given into target directory.

public mixed render ( array $files, string $targetDir )
$files array
$targetDir string 

                public function render($files, $targetDir)
{
    $this->_targetDir = $targetDir;
    $fileCount = count($files) + 1;
    if ($this->controller !== null) {
        Console::startProgress(0, $fileCount, 'Rendering markdown files: ', false);
    }
    $done = 0;
    $fileData = [];
    $chapters = $this->loadGuideStructure($files);
    foreach ($files as $file) {
        $fileData[$file] = file_get_contents($file);
        if (basename((string) $file) == 'README.md') {
            continue; // to not add index file to nav
        }
    }
    foreach ($fileData as $file => $content) {
        $output = ApiMarkdown::process($content); // TODO generate links to yiiframework.com by default
        $output = $this->afterMarkdownProcess($file, $output, Markdown::$flavors['api']);
        if ($this->layout !== false) {
            $params = [
                'chapters' => $chapters,
                'currentFile' => $file,
                'content' => $output,
            ];
            $output = $this->getView()->renderFile($this->layout, $params, $this);
        }
        $fileName = $this->generateGuideFileName($file);
        file_put_contents($targetDir . '/' . $fileName, $output);
        if ($this->controller !== null) {
            Console::updateProgress(++$done, $fileCount);
        }
    }
    if ($this->controller !== null) {
        Console::updateProgress(++$done, $fileCount);
        Console::endProgress(true);
        $this->controller->stdout('done.' . PHP_EOL, Console::FG_GREEN);
    }
}