CodeIgniter v4.5 API

Console
in package

Console

Tags
see
ConsoleTest

Table of Contents

Methods

run()  : int|void
Runs the current command discovered on the CLI.
showHeader()  : void
Displays basic information about the Console.
parseParamsForHelpOption()  : array<string|int, mixed>
Introspects the `$params` passed for presence of the `--help` option.

Methods

run()

Runs the current command discovered on the CLI.

public run() : int|void
Tags
throws
Exception
Return values
int|void

Exit code

showHeader()

Displays basic information about the Console.

public showHeader([bool $suppress = false ]) : void
Parameters
$suppress : bool = false

parseParamsForHelpOption()

Introspects the `$params` passed for presence of the `--help` option.

private parseParamsForHelpOption(array<string|int, mixed> $params) : array<string|int, mixed>

If present, it will be found as ['help' => null]. We'll remove that as an option from $params and unshift it as argument instead.

Parameters
$params : array<string|int, mixed>
Return values
array<string|int, mixed>

        
On this page

Search results