KMP PHP API Reference

KmpInstallCommand extends Command
in package

KMP installer wizard for first-time setup and targeted upgrades.

Table of Contents

Methods

buildOptionParser()  : ConsoleOptionParser
execute()  : int|null
askOrDefault()  : string
Ask or default.
buildDatabaseUrl()  : string
Build database url.
buildEnvPayload()  : array<string|int, mixed>
Build env payload.
confirmWrite()  : bool
Confirm write.
normalizeChoice()  : string
Normalize choice.
runBootstrap()  : int|null
Run bootstrap.
runShellCommand()  : bool
Run shell command.
writeEnvFile()  : void
Write env file.

Methods

buildOptionParser()

public buildOptionParser(ConsoleOptionParser $parser) : ConsoleOptionParser
Parameters
$parser : ConsoleOptionParser
Tags
inheritDoc
Return values
ConsoleOptionParser

execute()

public execute(Arguments $args, ConsoleIo $io) : int|null
Parameters
$args : Arguments
$io : ConsoleIo
Tags
inheritDoc
Return values
int|null

askOrDefault()

Ask or default.

private askOrDefault(ConsoleIo $io, string $label, array<string|int, mixed> $options, string $default, mixed $optionValue) : string
Parameters
$io : ConsoleIo
$label : string
$options : array<string|int, mixed>
$default : string
$optionValue : mixed
Return values
string

buildDatabaseUrl()

Build database url.

private buildDatabaseUrl(ConsoleIo $io, string $driver, string $dbHost, string $dbPort, string $dbName, string $dbUser, string $dbPass) : string
Parameters
$io : ConsoleIo
$driver : string
$dbHost : string
$dbPort : string
$dbName : string
$dbUser : string
$dbPass : string
Return values
string

buildEnvPayload()

Build env payload.

private buildEnvPayload(string $profile, string $databaseDriver, string $databaseUrl, string $redisUrl, string $storage, string $azureConnection, string $s3Bucket, string $s3Region, string $s3Endpoint) : array<string|int, mixed>
Parameters
$profile : string
$databaseDriver : string
$databaseUrl : string
$redisUrl : string
$storage : string
$azureConnection : string
$s3Bucket : string
$s3Region : string
$s3Endpoint : string
Return values
array<string|int, mixed>

confirmWrite()

Confirm write.

private confirmWrite(ConsoleIo $io, array<string|int, mixed> $payload, bool $nonInteractive) : bool
Parameters
$io : ConsoleIo
$payload : array<string|int, mixed>
$nonInteractive : bool
Return values
bool

normalizeChoice()

Normalize choice.

private normalizeChoice(string $value, array<string|int, mixed> $valid, string $default) : string
Parameters
$value : string
$valid : array<string|int, mixed>
$default : string
Return values
string

runBootstrap()

Run bootstrap.

private runBootstrap(ConsoleIo $io) : int|null
Parameters
$io : ConsoleIo
Return values
int|null

runShellCommand()

Run shell command.

private runShellCommand(string $command, ConsoleIo $io) : bool
Parameters
$command : string
$io : ConsoleIo
Return values
bool

writeEnvFile()

Write env file.

private writeEnvFile(string $path, array<string|int, mixed> $payload) : void
Parameters
$path : string
$payload : array<string|int, mixed> 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results