Gitee
\
CodeIgniter
API
Autoloader
Cache
Exceptions
Handlers
CLI
Exceptions
Commands
Database
Server
Sessions
Utilities
Config
Database
Exceptions
MySQLi
Postgre
SQLite3
Debug
Toolbar
Collectors
Email
Encryption
Exceptions
Handlers
Events
Exceptions
Files
Exceptions
Filters
Exceptions
Format
Exceptions
Honeypot
Exceptions
HTTP
Exceptions
Files
I18n
Exceptions
Images
Exceptions
Handlers
Log
Exceptions
Handlers
Pager
Exceptions
Router
Exceptions
Security
Exceptions
Session
Exceptions
Handlers
Test
Filters
Throttle
Typography
Validation
Exceptions
View
Exceptions
Config
My
Field
Book
Phpcmf
Admin
Controllers
Admin
Api
Member
Extend
Field
Home
Library
Member
Model
Bbs
Bdtj
Bdts
Block
Book
Cqx
Fstatus
Hy
Mbdyf
Myapp
Navigator
Order
Page
Sitemap
Sites
Store
Tag
Tixian
Variable
Xcx
Yuedusf
Zone
ThirdParty
Storage
Psr
Log
Xcx
Zend
Escaper
Exception

\CodeIgniter\CommandsListCommands

CI Help command for the spark script.

Lists the basic usage information for the spark script, and provides a way to list help for other commands.

Summary

Methods
Properties
Constants
__construct()
run()
__get()
__isset()
showHelp()
getPad()
$group
$name
$description
No constants found
call()
showError()
describeCommands()
padTitle()
$group
$name
$usage
$description
$options
$arguments
$logger
$commands
$maxFirstLength
N/A
No private methods found
No private properties found
N/A

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

$commands

$commands : \CodeIgniter\CLI\CommandRunner

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

Type

\CodeIgniter\CLI\CommandRunner

$maxFirstLength

$maxFirstLength : integer

The length of the longest command name.

Used during display in columns.

Type

integer

Methods

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

describeCommands()

describeCommands(array  $commands = array())

Displays the commands on the CLI.

Parameters

array $commands

padTitle()

padTitle(string  $item, integer  $max, integer  $extra = 2, integer  $indent) : string

Pads our string out so that all titles are the same length to nicely line up descriptions.

Parameters

string $item
integer $max
integer $extra

// How many extra spaces to add at the end
integer $indent

Returns

string