Property | Type | Description | |
---|---|---|---|
$blueprint | The blueprint instance. | ||
$description | string | The console command description. | |
$docs | Blueprint instance. | ||
$name | string | Default documentation name. | |
$router | Router instance. | ||
$signature | string | The name and signature of the console command. | |
$version | string | Default documentation version. | |
$writer | Dingo\Blueprint\Writer | Writer instance. |
Method | Description | |
---|---|---|
__construct ( |
Create a new docs command instance. | |
handle ( ) : mixed | Execute the console command. |
Method | Description | |
---|---|---|
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. | |
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. |
protected addControllerIfNotExists ( |
||
$controllers | ||
$controller | object | |
return | void |
protected getControllers ( ) : array | ||
return | array |
protected getDocName ( ) : string | ||
return | string |
protected getIncludePath ( ) : string | ||
return | string |
protected getVersion ( ) : string | ||
return | string |
protected Blueprint,Dingo\Blueprint $blueprint | ||
return |
protected string $description | ||
return | string |
protected Blueprint,Dingo\Blueprint $docs | ||
return |
protected Router,Dingo\Api\Routing $router | ||
return |
protected string $signature | ||
return | string |
protected string $version | ||
return | string |