PHP Класс yii\apidoc\templates\html\ApiRenderer

С версии: 2.0
Автор: Carsten Brandt ([email protected])
Наследование: extends yii\apidoc\renderers\ApiRenderer, implements yii\base\ViewContextInterface
Показать файл Открыть проект Примеры использования класса

Открытые свойства

Свойство Тип Описание
$indexView path or alias of the view file to use for rendering the index page.
$layout path or alias of the layout file to use.
$typeView path or alias of the view file to use for rendering types (classes, interfaces, traits).

Открытые методы

Метод Описание
generateApiUrl ( $typeName )
getSourceUrl ( $type, $line = null )
getView ( ) : View
getViewPath ( )
init ( )
render ( Context $context, $targetDir ) Renders a given [[Context]].
renderClasses ( array $names ) : string
renderDefaultValue ( mixed $value ) : string Renders the default value.
renderInheritance ( yii\apidoc\models\ClassDoc $class ) : string
renderInterfaces ( array $names ) : string
renderMethodSignature ( yii\apidoc\models\MethodDoc $method, $context = null ) : string
renderPropertySignature ( PropertyDoc $property, $context = null ) : string
renderTraits ( array $names ) : string

Защищенные методы

Метод Описание
generateFileName ( string $typeName ) : string Generates file name for API page for a given type
generateLink ( $text, $href, $options = [] )
renderWithLayout ( string $viewFile, array $params ) : string Renders file applying layout

Описание методов

generateApiUrl() публичный Метод

public generateApiUrl ( $typeName )

generateFileName() защищенный Метод

Generates file name for API page for a given type
protected generateFileName ( string $typeName ) : string
$typeName string
Результат string

getSourceUrl() публичный Метод

public getSourceUrl ( $type, $line = null )

getView() публичный Метод

public getView ( ) : View
Результат yii\web\View the view instance

getViewPath() публичный Метод

public getViewPath ( )

init() публичный Метод

public init ( )

render() публичный Метод

Renders a given [[Context]].
public render ( Context $context, $targetDir )
$context yii\apidoc\models\Context the api documentation context to render.
$targetDir

renderClasses() публичный Метод

public renderClasses ( array $names ) : string
$names array
Результат string

renderDefaultValue() публичный Метод

Renders the default value.
С версии: 2.1.1
public renderDefaultValue ( mixed $value ) : string
$value mixed
Результат string

renderInheritance() публичный Метод

public renderInheritance ( yii\apidoc\models\ClassDoc $class ) : string
$class yii\apidoc\models\ClassDoc
Результат string

renderInterfaces() публичный Метод

public renderInterfaces ( array $names ) : string
$names array
Результат string

renderMethodSignature() публичный Метод

public renderMethodSignature ( yii\apidoc\models\MethodDoc $method, $context = null ) : string
$method yii\apidoc\models\MethodDoc
Результат string

renderPropertySignature() публичный Метод

public renderPropertySignature ( PropertyDoc $property, $context = null ) : string
$property yii\apidoc\models\PropertyDoc
Результат string

renderTraits() публичный Метод

public renderTraits ( array $names ) : string
$names array
Результат string

renderWithLayout() защищенный Метод

Renders file applying layout
protected renderWithLayout ( string $viewFile, array $params ) : string
$viewFile string the view name
$params array the parameters (name-value pairs) that will be extracted and made available in the view file.
Результат string

Описание свойств

$indexView публичное свойство

path or alias of the view file to use for rendering the index page.
public $indexView

$layout публичное свойство

path or alias of the layout file to use.
public $layout

$typeView публичное свойство

path or alias of the view file to use for rendering types (classes, interfaces, traits).
public $typeView