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

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

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

Свойство Тип Описание
$description string The console command description.
$headers array The table headers for the command.
$name string The console command name.
$router Dingo\Api\Routing\Router Dingo router instance.
$routes array Array of route collections.

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

Метод Описание
__construct ( Router $router ) : void Create a new routes command instance.
fire ( ) : void Execute the console command.

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

Метод Описание
filterByName ( array $route ) : boolean Filter the route by its name.
filterByPath ( array $route ) : boolean Filter the route by its path.
filterByProtected ( array $route ) : boolean Filter the route by whether or not it is protected.
filterByScopes ( array $route ) : boolean Filter the route by its scopes.
filterByUnprotected ( array $route ) : boolean Filter the route by whether or not it is unprotected.
filterByVersions ( array $route ) : boolean Filter the route by its versions.
filterRoute ( array $route ) : array | null Filter the route by URI, Version, Scopes and / or name.
getOptions ( ) : array Get the console command options.
getRoutes ( ) : array Compile the routes into a displayable format.
routeRateLimit ( Route $route ) : null | string Display the routes rate limiting requests per second. This takes the limit and divides it by the expiration time in seconds to give you a rough idea of how many requests you'd be able to fire off per second on the route.

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

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

Create a new routes command instance.
public __construct ( Router $router ) : void
$router Dingo\Api\Routing\Router
Результат void

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

Filter the route by its name.
protected filterByName ( array $route ) : boolean
$route array
Результат boolean

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

Filter the route by its path.
protected filterByPath ( array $route ) : boolean
$route array
Результат boolean

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

Filter the route by whether or not it is protected.
protected filterByProtected ( array $route ) : boolean
$route array
Результат boolean

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

Filter the route by its scopes.
protected filterByScopes ( array $route ) : boolean
$route array
Результат boolean

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

Filter the route by whether or not it is unprotected.
protected filterByUnprotected ( array $route ) : boolean
$route array
Результат boolean

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

Filter the route by its versions.
protected filterByVersions ( array $route ) : boolean
$route array
Результат boolean

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

Filter the route by URI, Version, Scopes and / or name.
protected filterRoute ( array $route ) : array | null
$route array
Результат array | null

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

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

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

Get the console command options.
protected getOptions ( ) : array
Результат array

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

Compile the routes into a displayable format.
protected getRoutes ( ) : array
Результат array

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

Display the routes rate limiting requests per second. This takes the limit and divides it by the expiration time in seconds to give you a rough idea of how many requests you'd be able to fire off per second on the route.
protected routeRateLimit ( Route $route ) : null | string
$route Dingo\Api\Routing\Route
Результат null | string

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

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

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

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

The table headers for the command.
protected array $headers
Результат array

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

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

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

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

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

Array of route collections.
protected array $routes
Результат array