PHP Класс Dingo\Api\Console\Command\Docs

Наследование: extends Illuminate\Console\Command
Показать файл Открыть проект

Защищенные свойства (Protected)

Свойство Тип Описание
$blueprint Dingo\Blueprint\Blueprint The blueprint instance.
$description string The console command description.
$docs Dingo\Blueprint\Blueprint Blueprint instance.
$name string Default documentation name.
$router Dingo\Api\Routing\Router Router instance.
$signature string The name and signature of the console command.
$version string Default documentation version.
$writer Dingo\Blueprint\Writer Writer instance.

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

Метод Описание
__construct ( Router $router, Blueprint $blueprint, Dingo\Blueprint\Writer $writer, string $name, string $version ) : void Create a new docs command instance.
handle ( ) : mixed Execute the console command.

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

Метод Описание
addControllerIfNotExists ( Collection $controllers, object $controller ) : void Add a controller to the collection if it does not exist. If the controller implements an interface suffixed with "Docs" it will be used instead of the controller.
getControllers ( ) : array Get all the controller instances.
getDocName ( ) : string Get the documentation name.
getIncludePath ( ) : string Get the include path for documentation files.
getVersion ( ) : string Get the documentation version.

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

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

Create a new docs command instance.
public __construct ( Router $router, Blueprint $blueprint, Dingo\Blueprint\Writer $writer, string $name, string $version ) : void
$router Dingo\Api\Routing\Router
$blueprint Dingo\Blueprint\Blueprint
$writer Dingo\Blueprint\Writer
$name string
$version string
Результат void

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

Add a controller to the collection if it does not exist. If the controller implements an interface suffixed with "Docs" it will be used instead of the controller.
protected addControllerIfNotExists ( Collection $controllers, object $controller ) : void
$controllers Illuminate\Support\Collection
$controller object
Результат void

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

Get all the controller instances.
protected getControllers ( ) : array
Результат array

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

Get the documentation name.
protected getDocName ( ) : string
Результат string

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

Get the include path for documentation files.
protected getIncludePath ( ) : string
Результат string

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

Get the documentation version.
protected getVersion ( ) : string
Результат string

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

Execute the console command.
public handle ( ) : mixed
Результат mixed

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

$blueprint защищенное свойство

The blueprint instance.
protected Blueprint,Dingo\Blueprint $blueprint
Результат Dingo\Blueprint\Blueprint

$description защищенное свойство

The console command description.
protected string $description
Результат string

$docs защищенное свойство

Blueprint instance.
protected Blueprint,Dingo\Blueprint $docs
Результат Dingo\Blueprint\Blueprint

$name защищенное свойство

Default documentation name.
protected string $name
Результат string

$router защищенное свойство

Router instance.
protected Router,Dingo\Api\Routing $router
Результат Dingo\Api\Routing\Router

$signature защищенное свойство

The name and signature of the console command.
protected string $signature
Результат string

$version защищенное свойство

Default documentation version.
protected string $version
Результат string

$writer защищенное свойство

Writer instance.
protected Writer,Dingo\Blueprint $writer
Результат Dingo\Blueprint\Writer