PHP Класс yii\apidoc\commands\ApiController

С версии: 2.0

Автор: Carsten Brandt ([email protected])

Наследование: extends yii\apidoc\components\BaseController

Показать файл Открыть проект

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

Свойство	Тип	Описание
$guide		url to where the guide files are located
$guidePrefix		prefix to prepend to all guide file names.

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

Метод	Описание
actionIndex ( array $sourceDirs, string $targetDir ) : integer	Renders API documentation files
options ( $actionID )

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

Метод	Описание
findFiles ( $path, $except = [] )
findRenderer ( $template ) : yii\apidoc\renderers\ApiRenderer

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

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

Renders API documentation files

public actionIndex ( array $sourceDirs, string $targetDir ) : integer
$sourceDirs	array
$targetDir	string
Результат	integer

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

protected findFiles ( $path, $except = [] )

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

protected findRenderer ( $template ) : yii\apidoc\renderers\ApiRenderer
Результат	yii\apidoc\renderers\ApiRenderer

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

public options ( $actionID )

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

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

url to where the guide files are located

public $guide

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

prefix to prepend to all guide file names.

public $guidePrefix