Property | Type | Description | |
---|---|---|---|
$dotPrefix | |||
$headers | array | The table headers for the command. | |
$prefix | |||
$router | |||
$routes | Illuminate\Routing\RouteCollection | An array of all the registered routes. | |
$storagePath |
Method | Description | |
---|---|---|
__construct ( |
Create a new route command instance. | |
make ( string $prefix ) : void | Generates the API Documentation based upon a prefix |
Method | Description | |
---|---|---|
copyAndSaveTemplate ( $type, $filepath ) : void | Copies template type from filepath to target | |
filterRoute ( array $route ) : array | null | Filter the route by URI and / or name. | |
generateDirectoryStructure ( ) : void | Generates the directory structure for the API documentation | |
generateHTMLCode ( $endpoints ) : void | Generates the HTML Code from the templates and saves them | |
getEndpointMethods ( $endpoints ) : array | Returns functions for the endpoints | |
getEndpoints ( ) : array | Returns an array of endpoints | |
getMethodPatterns ( string $uri, string $method ) : array | Get the pattern filters for a given URI and method. | |
getPatternFilters ( Illuminate\Routing\Route $route ) : array | Get all of the pattern filters matching the route. | |
getRouteInformation ( Illuminate\Routing\Route $route ) : array | Get the route information for a given route. | |
getRoutes ( ) : array | Compile the routes into a displayable format. | |
normalizeSectionName ( $name ) : string | Retuns the last part of the section name | |
updateAndSaveDefaultLayoutTemplate ( string $content ) : void | Saves the default layout with HTML content | |
updatePrefixAndSaveTemplate ( $type, $filepath ) : void | Retrieves the content from the template and saves it to a new file | |
viewPathForType ( $viewType ) : array | Returns the path for the view based upon View Type |
Method | Description | |
---|---|---|
convertToSnakeCase ( string $input ) : string | Converts a CamelCase String to Snake Case | |
createContentForTemplate ( array $endpoints = [] ) : void | Generates the content for the templates | |
generateAssetsDirectory ( ) : void | Generates the assets directory by copying the files from the template directory to a public diretory |
public __construct ( |
||
$router | ||
return | void |
protected copyAndSaveTemplate ( $type, $filepath ) : void | ||
return | void |
protected generateDirectoryStructure ( ) : void | ||
return | void |
protected generateHTMLCode ( $endpoints ) : void | ||
$endpoints | ||
return | void |
protected getEndpointMethods ( $endpoints ) : array | ||
$endpoints | ||
return | array |
protected getEndpoints ( ) : array | ||
return | array |
protected getPatternFilters ( Illuminate\Routing\Route $route ) : array | ||
$route | Illuminate\Routing\Route | |
return | array |
protected getRouteInformation ( Illuminate\Routing\Route $route ) : array | ||
$route | Illuminate\Routing\Route | |
return | array |
protected normalizeSectionName ( $name ) : string | ||
return | string |
protected updateAndSaveDefaultLayoutTemplate ( string $content ) : void | ||
$content | string | |
return | void |
protected updatePrefixAndSaveTemplate ( $type, $filepath ) : void | ||
return | void |
protected viewPathForType ( $viewType ) : array | ||
$viewType | ||
return | array |
protected array $headers | ||
return | array |
protected RouteCollection,Illuminate\Routing $routes | ||
return | Illuminate\Routing\RouteCollection |