CodeIgniter v4.5 API

ConfigCheck extends BaseCommand
in package

FinalYes

Check the Config values.

Tags
see
ConfigCheckTest

Table of Contents

Properties

$arguments  : array<string, string>
$commands  : Commands
$description  : string
$group  : string
$logger  : LoggerInterface
$name  : string
$options  : array<string, string>
$usage  : string
$arguments  : array<string, string>
The Command's arguments
$commands  : Commands
Instance of Commands so commands can call other commands.
$description  : string
The Command's short description
$group  : string
The group the command is lumped under when listing commands.
$logger  : LoggerInterface
The Logger to use for a command
$name  : string
The Command's name
$options  : array<string, string>
The Command's options
$usage  : string
The Command's usage

Methods

__construct()  : mixed
__get()  : array<string, string>|Commands|LoggerInterface|string|null
Makes it simple to access our protected properties.
__isset()  : bool
Makes it simple to check our protected properties.
getPad()  : int
Get pad for $key => $value array output
run()  : int|void
Actually execute a command.
setPad()  : string
Pads our string out so that all titles are the same length to nicely line up descriptions.
showHelp()  : void
Show Help includes (Usage, Arguments, Description, Options).
call()  : int|void
Can be used by a command to run other commands.
showError()  : void
A simple method to display an error with line/file, in child commands.
getKintD()  : string
Gets object dump by Kint d()
getVarDump()  : string
Gets object dump by var_dump()

Properties

$arguments

The Command's arguments

protected array<string, string> $arguments = ['classname' => 'The config classname to check. Short classname or FQCN.']

$commands

Instance of Commands so commands can call other commands.

protected Commands $commands

$description

The Command's short description

protected string $description = 'Check your Config values.'

$group

The group the command is lumped under when listing commands.

protected string $group = 'CodeIgniter'

$logger

The Logger to use for a command

protected LoggerInterface $logger

$name

The Command's name

protected string $name = 'config:check'

$options

The Command's options

protected array<string, string> $options = []

$usage

The Command's usage

protected string $usage = 'config:check <classname>'

Methods

__construct()

public __construct(LoggerInterface $logger, Commands $commands) : mixed
Parameters
$logger : LoggerInterface
$commands : Commands

__get()

Makes it simple to access our protected properties.

public __get(string $key) : array<string, string>|Commands|LoggerInterface|string|null
Parameters
$key : string
Return values
array<string, string>|Commands|LoggerInterface|string|null

__isset()

Makes it simple to check our protected properties.

public __isset(string $key) : bool
Parameters
$key : string
Return values
bool

getPad()

Get pad for $key => $value array output

public getPad(array<string, string> $array, int $pad) : int

Use setPad() instead.

Parameters
$array : array<string, string>
$pad : int
Tags
codeCoverageIgnore
Return values
int

run()

Actually execute a command.

public run(array<string|int, mixed> $params) : int|void
Parameters
$params : array<string|int, mixed>
Return values
int|void

setPad()

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

public setPad(string $item, int $max[, int $extra = 2 ][, int $indent = 0 ]) : string
Parameters
$item : string
$max : int
$extra : int = 2

How many extra spaces to add at the end

$indent : int = 0
Return values
string

showHelp()

Show Help includes (Usage, Arguments, Description, Options).

public showHelp() : void

call()

Can be used by a command to run other commands.

protected call(string $command[, array<int|string, string|null> $params = [] ]) : int|void
Parameters
$command : string
$params : array<int|string, string|null> = []
Tags
throws
ReflectionException
Return values
int|void

showError()

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

protected showError(Throwable $e) : void
Parameters
$e : Throwable

getKintD()

Gets object dump by Kint d()

private getKintD(object $config) : string
Parameters
$config : object
Return values
string

getVarDump()

Gets object dump by var_dump()

private getVarDump(object $config) : string
Parameters
$config : object
Return values
string 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results