Lists all of the user-defined routes. This will include any Routes files that can be discovered, but will NOT include any routes that are not defined in a routes file, but are instead discovered through auto-routing.

Summary

Methods

Properties

Constants

__construct()
run()
__get()
__isset()
showHelp()
getPad()

$group
$name
$description

No constants found

call()
showError()

$group
$name
$usage
$description
$options
$arguments
$logger
$commands

N/A

No private methods found

No private properties found

N/A

File: src/System/Commands/Utilities/Routes.php
Package: CodeIgniter\Commands
Class hierarchy: \CodeIgniter\CLI\BaseCommand

\CodeIgniter\Commands\Utilities\Routes

Properties

$group

$group :

Type

$name

$name :

Type

$description

$description :

Type

$group

$group : string

The group the command is lumped under when listing commands.

Type

string

$name

$name : string

The Command's name

Type

string

$usage

$usage : string

the Command's usage

Type

string

$description

$description : string

the Command's short description

Type

string

$options

$options : array

the Command's Options

Type

array

$arguments

$arguments : array

the Command's Arguments

Type

array

$logger

$logger : \Psr\Log\LoggerInterface

The Logger to use for a command

Type

\Psr\Log\LoggerInterface

$commands

$commands : \CodeIgniter\CLI\CommandRunner

Instance of the CommandRunner controller so commands can call other commands.

Type

\CodeIgniter\CLI\CommandRunner

Methods

__construct()

__construct(\Psr\Log\LoggerInterface  $logger, \CodeIgniter\CLI\CommandRunner  $commands)

BaseCommand constructor.

Parameters

\Psr\Log\LoggerInterface	$logger
\CodeIgniter\CLI\CommandRunner	$commands

run()

run(array  $params)

Displays the help for the spark cli script itself.

This has to be over-ridden in any concrete implementation.

Parameters

array

$params

__get()

__get(string  $key) : mixed

Makes it simple to access our protected properties.

Parameters

string

$key

Returns

mixed

__isset()

__isset(string  $key) : boolean

Makes it simple to check our protected properties.

Parameters

string

$key

Returns

boolean

showHelp()

showHelp()

show Help include (usage,arguments,description,options)

getPad()

getPad(array  $array, integer  $pad) : integer

Get pad for $key => $value array output

Parameters

array	$array
integer	$pad

Returns

integer

call()

call(string  $command, array  $params = array()) : mixed

Can be used by a command to run other commands.

Parameters

string	$command
array	$params

Throws

\ReflectionException

Returns

mixed

showError()

showError(\Exception  $e)

A simple method to display an error with line/file, in child commands.

Parameters

\Exception

$e