Class yii\apidoc\templates\bootstrap\ApiRenderer

                public function createSubjectLink($subject, $title = null, $options = [], $type = null)
{
    if ($subject instanceof PseudoTypeDoc) {
        $href = $this->generateApiUrl($subject->parent->name) . "#{$subject->type}-type-{$subject->name}";
        return $this->generateLink($subject->name, $href, $options);
    }
    if ($subject instanceof PseudoTypeImportDoc) {
        $typeParentFqsen = (string) $subject->typeParentFqsen;
        $href = $this->generateApiUrl(ltrim($typeParentFqsen, '\\')) . "#{$subject->type}-type-{$subject->typeName}";
        return $this->generateLink($subject->typeName, $href, $options);
    }
    if ($title === null) {
        if ($subject instanceof MethodDoc) {
            $title = $subject->name . '()';
        } else {
            $title = $subject->name;
        }
    }
    if (!$type && property_exists($subject, 'definedBy')) {
        $type = $this->apiContext->getType($subject->definedBy);
    }
    if (!$type) {
        return $subject->name;
    }
    $link = $this->generateApiUrl($type->name) . '#' . $subject->name;
    if ($subject instanceof MethodDoc) {
        $link .= '()';
    }
    $link .= '-detail';
    return $this->generateLink($title, $link, $options);
}

            

                public function createTypeLink(
    $types,
    ?BaseDoc $context = null,
    ?string $title = null,
    array $options = [],
    ?TypeDoc $currentTypeDoc = null
) {
    if ($types === null) {
        return '';
    }
    if (!is_array($types)) {
        $types = [$types];
    } elseif (count($types) > 1) {
        $title = null;
    }
    $links = [];
    foreach ($types as $type) {
        if (is_string($type)) {
            if ($type !== '') {
                $typeDoc = $this->getTypeDocByQualifiedClassName($type, $context);
                if ($typeDoc !== null) {
                    $links[] = $this->createTypeLink($typeDoc, $context, $title, $options);
                    continue;
                }
            }
        } elseif ($type instanceof Type) {
            if ($type instanceof Compound) {
                $innerTypes = TypeHelper::getTypesByAggregatedType($type);
                $links[] = $this->createTypeLink($innerTypes, $context, $title, $options, $currentTypeDoc);
                continue;
            }
            if ($type instanceof ConditionalForParameter || $type instanceof Conditional) {
                $possibleTypes = TypeHelper::getPossibleTypesByConditionalType($type);
                $links[] = $this->createTypeLink($possibleTypes, $context, $title, $options, $currentTypeDoc);
                continue;
            }
            if ($type instanceof Intersection) {
                $innerTypes = TypeHelper::getTypesByAggregatedType($type);
                $innerTypesLinks = array_map(
                    fn(Type $innerType) => $this->createTypeLink($innerType, $context, $title, $options, $currentTypeDoc),
                    $innerTypes,
                );
                $links[] = implode('&', $innerTypesLinks);
                continue;
            }
            if ($type instanceof OffsetAccess) {
                $offsetAccessType = $type->getType();
                if ($offsetAccessType instanceof Object_ && ($offsetAccessTypeFqsen = $offsetAccessType->getFqsen()) !== null) {
                    $templateType = $this->getTemplateType($offsetAccessTypeFqsen->getName(), $context);
                    if ($templateType instanceof Array_) {
                        $links[] = $this->createTypeLink(
                            $templateType->getValueType(),
                            $context,
                            $title,
                            $options,
                            $currentTypeDoc
                        );
                        continue;
                    }
                }
                $typeLink = $this->createTypeLink($offsetAccessType, $context, $title, $options);
                $links[] = $typeLink . '[' . $type->getOffset() . ']';
                continue;
            }
            if ($type instanceof Array_ && str_ends_with((string) $type, '[]')) {
                $valueType = $type->getValueType();
                if ($valueType instanceof Object_ && ($valueTypeFqsen = $valueType->getFqsen()) !== null) {
                    $templateType = $this->getTemplateType($valueTypeFqsen->getName(), $context);
                    if ($templateType !== null) {
                        $typeLink = $this->createTypeLink($templateType, $context, $title, $options, $currentTypeDoc);
                        $links[] = $this->generateLink('array', self::PHPSTAN_TYPE_BASE_URL . 'general-arrays', $options) . "<{$typeLink}>";
                        continue;
                    }
                }
                $links[] = $this->createTypeLink($valueType, $context, $title, $options, $currentTypeDoc) . '[]';
                continue;
            }
            if ($type instanceof ListShape) {
                $itemsLinks = $this->createLinksByShapeItems($type->getItems(), $context, $title, $options, $currentTypeDoc);
                $mainTypeLink = $this->generateLink('list', self::PSALM_TYPE_BASE_URL . 'array_types/#list-shapes', $options);
                $links[] = $mainTypeLink . '{' . implode(', ', $itemsLinks) . '}';
                continue;
            }
            if ($type instanceof ArrayShape) {
                $itemsLinks = $this->createLinksByShapeItems($type->getItems(), $context, $title, $options, $currentTypeDoc);
                $mainTypeLink = $this->generateLink('array', self::PHPSTAN_TYPE_BASE_URL . 'array-shapes', $options);
                $links[] = $mainTypeLink . '{' . implode(', ', $itemsLinks) . '}';
                continue;
            }
            if ($type instanceof ObjectShape) {
                $itemsLinks = $this->createLinksByShapeItems($type->getItems(), $context, $title, $options, $currentTypeDoc);
                $mainTypeLink = $this->generateLink('object', self::PHPSTAN_TYPE_BASE_URL . 'object-shapes', $options);
                $links[] = $mainTypeLink . '{' . implode(', ', $itemsLinks) . '}';
                continue;
            }
            if ($type instanceof Callable_) {
                $links[] = $this->createCallableTypeLink($type, $context, $title, $options, $currentTypeDoc);
                continue;
            }
            if ($type instanceof This && $currentTypeDoc !== null) {
                $links[] = $this->createTypeLink($currentTypeDoc, null, '$this', $options);
                continue;
            }
            if ($type instanceof Static_ && !$type->getGenericTypes() && $currentTypeDoc !== null) {
                $links[] = $this->createTypeLink($currentTypeDoc, null, null, $options);
                continue;
            }
            if ($type instanceof Nullable) {
                $links[] = $this->createTypeLink([$type->getActualType(), new Null_()]);
                continue;
            }
            if (($link = $this->createLinkByTypeWithGenerics($type, $context, $title, $options, $currentTypeDoc)) !== null) {
                $links[] = $link;
                continue;
            }
            if ($type instanceof Object_ && ($typeFqsen = $type->getFqsen()) !== null) {
                $typeName = $typeFqsen->getName();
                if (($typeDoc = $this->getTypeDocByQualifiedClassName((string) $typeFqsen, $context)) !== null) {
                    $links[] = $this->createTypeLink($typeDoc, $context, $typeDoc->name, $options);
                    continue;
                }
                if (($templateType = $this->getTemplateType($typeName, $context)) !== null) {
                    $links[] = $this->createTypeLink($templateType, $context, $title, $options, $currentTypeDoc);
                    continue;
                }
                if (($phpStanType = $this->getPhpStanType($typeName, $context)) !== null) {
                    $links[] = $this->createSubjectLink($phpStanType);
                    continue;
                }
                if (($psalmType = $this->getPsalmType($typeName, $context)) !== null) {
                    $links[] = $this->createSubjectLink($psalmType);
                    continue;
                }
                if (($phpStanTypeImport = $this->getPhpStanTypeImport($typeName, $context)) !== null) {
                    $links[] = $this->createSubjectLink($phpStanTypeImport);
                    continue;
                }
                if (($psalmTypeImport = $this->getPsalmTypeImport($typeName, $context)) !== null) {
                    $links[] = $this->createSubjectLink($psalmTypeImport);
                    continue;
                }
            }
        }
        if (is_object($type) && method_exists($type, '__toString')) {
            $type = (string) $type;
        }
        $link = $this->createTypeLinkByType($type, $title, $options);
        if ($link !== null) {
            $links[] = $link;
        }
    }
    return implode('|', array_unique($links));
}

            

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

            

                public function generateApiUrl($typeName)
{
    return $this->generateFileName($typeName);
}

            

                protected function generateFileName($typeName)
{
    return strtolower(str_replace('\\', '-', $typeName)) . '.html';
}

            

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

            

                protected function generateLink($text, $href, $options = [])
{
    $options['href'] = $href;
    return Html::a($text, null, $options);
}

            

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

            

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

            

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

            

                public function getViewPath()
{
    return Yii::getAlias('@yii/apidoc/templates/html/views');
}

            

                public function init()
{
    parent::init();
    if ($this->pageTitle === null) {
        $this->pageTitle = 'Yii Framework 2.0 API Documentation';
    }
}

            

                public function renderClasses($names)
{
    $classes = [];
    sort($names, SORT_STRING);
    foreach ($names as $class) {
        if (isset($this->apiContext->classes[$class])) {
            $classes[] = $this->createTypeLink($this->apiContext->classes[$class]);
        } else {
            $classes[] = $this->createTypeLink($class);
        }
    }
    return implode(', ', $classes);
}

            

                public function renderDefaultValue($value)
{
    if ($value === null) {
        return 'null';
    }
    // special numbers which are usually used in octal or hex notation
    static $specials = [
        // file permissions
        '420' => '0644',
        '436' => '0664',
        '438' => '0666',
        '493' => '0755',
        '509' => '0775',
        '511' => '0777',
        // colors used in yii\captcha\CaptchaAction
        '2113696' => '0x2040A0',
        '16777215' => '0xFFFFFF',
    ];
    return $specials[$value] ?? $value;
}

            

                public function renderInheritance($class)
{
    $parents = [];
    $parents[] = $this->createTypeLink($class);
    while ($class->parentClass !== null) {
        if (isset($this->apiContext->classes[$class->parentClass])) {
            $class = $this->apiContext->classes[$class->parentClass];
            $parents[] = $this->createTypeLink($class);
        } else {
            $parents[] = $this->createTypeLink($class->parentClass);
            break;
        }
    }
    return implode(" »\n", $parents);
}

            

                public function renderInterfaces($names)
{
    $interfaces = [];
    sort($names, SORT_STRING);
    foreach ($names as $interface) {
        if (isset($this->apiContext->interfaces[$interface])) {
            $interfaces[] = $this->createTypeLink($this->apiContext->interfaces[$interface]);
        } else {
            $interfaces[] = $this->createTypeLink($interface);
        }
    }
    return implode(', ', $interfaces);
}

            

                public function renderMethodSignature(MethodDoc $method, ?TypeDoc $context = null): string
{
    $params = [];
    foreach ($method->params as $param) {
        $params[] = '<span class="signature-type">' . $this->createTypeLink($param->type, $method) . '</span> '
            . ($param->isPassedByReference ? '<b>&</b>' : '')
            . ApiMarkdown::highlight(
                $param->name
                . ($param->isOptional ? ' = ' . $this->renderDefaultValue($param->defaultValue) : ''),
                'php',
            );
    }
    $definition = [];
    $definition[] = $method->visibility;
    if ($method->isAbstract) {
        $definition[] = 'abstract';
    }
    if ($method->isStatic) {
        $definition[] = 'static';
    }
    return '<span class="signature-defs">' . implode(' ', $definition) . '</span> '
        . '<strong>' . $this->createSubjectLink($method, $method->name) . '</strong>'
        . str_replace('  ', ' ', '( ' . implode(', ', $params) . ' )')
        . ': <span class="signature-type">' . ($method->isReturnByReference ? '<b>&</b>' : '')
        . $this->createTypeLink($method->returnType, $method, null, [], $context) . '</span>';
}

            

                public function renderPropertySignature($property, $context = null)
{
    if ($property->getter !== null || $property->setter !== null) {
        $sig = [];
        if ($property->getter !== null) {
            $sig[] = $this->renderMethodSignature($property->getter, $context);
        }
        if ($property->setter !== null) {
            $sig[] = $this->renderMethodSignature($property->setter, $context);
        }
        return implode('<br />', $sig);
    }
    $definition = [];
    $definition[] = $property->visibility;
    if ($property->isStatic) {
        $definition[] = 'static';
    }
    return '<span class="signature-defs">' . implode(' ', $definition) . '</span> '
        . '<span class="signature-type">' . $this->createTypeLink($property->type, $property) . '</span>'
        . ' ' . $this->createSubjectLink($property, $property->name) . ' '
        . ApiMarkdown::highlight('= ' . $this->renderDefaultValue($property->defaultValue), 'php');
}

            

                public function renderTraits($names)
{
    $traits = [];
    sort($names, SORT_STRING);
    foreach ($names as $trait) {
        if (isset($this->apiContext->traits[$trait])) {
            $traits[] = $this->createTypeLink($this->apiContext->traits[$trait]);
        } else {
            $traits[] = $this->createTypeLink($trait);
        }
    }
    return implode(', ', $traits);
}

            

                protected function renderWithLayout($viewFile, $params)
{
    $output = $this->getView()->render($viewFile, $params, $this);
    if ($this->layout !== false) {
        $params['content'] = $output;
        return $this->getView()->renderFile($this->layout, $params, $this);
    }
    return $output;
}