PHP 클래스 Dingo\Api\Console\Command\Docs

상속: extends Illuminate\Console\Command

보호된 프로퍼티들

프로퍼티	타입	설명
$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