Trait yii\apidoc\templates\bootstrap\RendererTrait

All Classes | Properties | Methods
Implemented byyii\apidoc\templates\bootstrap\ApiRenderer, yii\apidoc\templates\bootstrap\GuideRenderer, yii\apidoc\templates\project\ApiRenderer, yii\apidoc\templates\project\GuideRenderer
Source Code https://github.com/yiisoft/yii2-apidoc/blob/master/templates/bootstrap/RendererTrait.php

Common methods for renderers

Public Properties

Hide inherited properties

Property Type Description Defined By
$extensions array Official Yii extensions yii\apidoc\templates\bootstrap\RendererTrait

Public Methods

Hide inherited methods

Method Description Defined By
getNavTypes() Returns nav TypeDocs yii\apidoc\templates\bootstrap\RendererTrait

Protected Methods

Hide inherited methods

Method Description Defined By
filterTypes() Returns types of a given class yii\apidoc\templates\bootstrap\RendererTrait
getTypeCategory() Returns category of TypeDoc yii\apidoc\templates\bootstrap\RendererTrait

Property Details

Hide inherited properties

$extensions public property

Official Yii extensions

public array $extensions = [
    'apidoc',
    'authclient',
    'bootstrap',
    'codeception',
    'composer',
    'debug',
    'elasticsearch',
    'faker',
    'gii',
    'httpclient',
    'imagine',
    'jui',
    'mongodb',
    'redis',
    'shell',
    'smarty',
    'sphinx',
    'swiftmailer',
    'twig',
]

Method Details

Hide inherited methods

filterTypes() protected method

Returns types of a given class

protected array filterTypes ( yii\apidoc\models\TypeDoc[] $types, string $navClasses )
$types yii\apidoc\models\TypeDoc[]
$navClasses string 

                protected function filterTypes($types, $navClasses)
{
    switch ($navClasses) {
        case 'app':
            $types = array_filter($types, fn($val) => !str_starts_with((string) $val->name, 'yii\\'));
            break;
        case 'yii':
            $self = $this;
            $types = array_filter($types, function ($val) use ($self) {
                if ($val->name == 'Yii' || $val->name == 'YiiRequirementChecker') {
                    return true;
                }
                if (strlen((string) $val->name) < 5) {
                    return false;
                }
                $subName = substr((string) $val->name, 4, strpos((string) $val->name, '\\', 5) - 4);
                return str_starts_with((string) $val->name, 'yii\\') && !in_array($subName, $self->extensions);
            });
            break;
        default:
            $types = array_filter($types, fn($val) => str_starts_with((string) $val->name, "yii\\$navClasses\\"));
    }
    return $types;
}
getNavTypes() public method

Returns nav TypeDocs

public array getNavTypes ( yii\apidoc\models\TypeDoc|null $type, yii\apidoc\models\TypeDoc[] $types )
$type yii\apidoc\models\TypeDoc|null

Typedoc to take category from
$types yii\apidoc\models\TypeDoc[]

TypeDocs to filter

 

                public function getNavTypes($type, $types)
{
    if ($type === null) {
        return $types;
    }
    return $this->filterTypes($types, $this->getTypeCategory($type));
}
getTypeCategory() protected method

Returns category of TypeDoc

protected string getTypeCategory ( yii\apidoc\models\TypeDoc|null $type )
$type yii\apidoc\models\TypeDoc|null 

                protected function getTypeCategory($type)
{
    $extensions = $this->extensions;
    $navClasses = 'app';
    if (isset($type)) {
        if ($type->name == 'Yii' || $type->name == 'YiiRequirementChecker') {
            $navClasses = 'yii';
        } elseif (str_starts_with((string) $type->name, 'yii\\')) {
            $navClasses = 'yii';
            $subName = substr((string) $type->name, 4);
            if (($pos = strpos($subName, '\\')) !== false) {
                $subNamespace = substr($subName, 0, $pos);
                if (in_array($subNamespace, $extensions)) {
                    $navClasses = $subNamespace;
                }
            }
        }
    }
    return $navClasses;
}