Свойство | Тип | Описание | |
---|---|---|---|
$apiContext | the [[Context]] currently being rendered. | ||
$apiUrl | |||
$controller | the apidoc controller instance. Can be used to control output. | ||
$guidePrefix | |||
$guideUrl | |||
$pageTitle | string to use as the title of the generated page. |
Метод | Описание | |
---|---|---|
createSubjectLink ( |
creates a link to a subject | |
createTypeLink ( yii\apidoc\models\ClassDoc | yii\apidoc\models\InterfaceDoc | yii\apidoc\models\TraitDoc | yii\apidoc\models\ClassDoc[] | yii\apidoc\models\InterfaceDoc[] | yii\apidoc\models\TraitDoc[] | string | string[] $types, |
creates a link to a type (class, interface or trait) | |
generateApiUrl ( $typeName ) : mixed | Generate an url to a type in apidocs | |
generateGuideUrl ( string $file ) : string | Generate an url to a guide page | |
init ( ) |
Метод | Описание | |
---|---|---|
generateLink ( $text, $href, array $options = [] ) : mixed | generate link markup |
Метод | Описание | |
---|---|---|
resolveNamespace ( |
public createSubjectLink ( |
||
$subject | ||
$title | string | |
$options | array | additional HTML attributes for the link. |
Результат | string |
public createTypeLink ( yii\apidoc\models\ClassDoc | yii\apidoc\models\InterfaceDoc | yii\apidoc\models\TraitDoc | yii\apidoc\models\ClassDoc[] | yii\apidoc\models\InterfaceDoc[] | yii\apidoc\models\TraitDoc[] | string | string[] $types, |
||
$types | yii\apidoc\models\ClassDoc | yii\apidoc\models\InterfaceDoc | yii\apidoc\models\TraitDoc | yii\apidoc\models\ClassDoc[] | yii\apidoc\models\InterfaceDoc[] | yii\apidoc\models\TraitDoc[] | string | string[] | |
$context | ||
$title | string | a title to be used for the link TODO check whether [[yii\...|Class]] is supported |
$options | array | additional HTML attributes for the link. |
Результат | string |
abstract public generateApiUrl ( $typeName ) : mixed | ||
$typeName | ||
Результат | mixed |
public generateGuideUrl ( string $file ) : string | ||
$file | string | |
Результат | string |
abstract protected generateLink ( $text, $href, array $options = [] ) : mixed | ||
$text | ||
$href | ||
$options | array | additional HTML attributes for the link. |
Результат | mixed |
public $controller |