Documentation

Commander extends AbstractBaseCommand
in package

Class that can be used as Base for other commands It exposes functions to unify the look&feel

Table of Contents

$description  : string
The command description
$signature  : string
The command signature
$silent  : bool
Suppress all info,error,warn and printWelcome output messages use `$this->line` instead to force writing output in silent mode
__construct()  : mixed
Constructor, it will start a new batch to group all log items
call()  : int
Call another console command.
error()  : void
Print an <error>$string</error> message
handle()  : void
This function will handle all the logic of the command
info()  : void
Print an <info>$string</info> message
warn()  : void
Print an <error>$string</error> message
printWelcome()  : bool
Prints a Welcome message
chooser()  : mixed
This is a generic function to prompt a menu and ask the user to choose an option
mainFunctionChooser()  : void
The main entry point for the command
manageBootstrap()  : void
This function will manage bootstrap tools
manageCloud()  : void
This function will manage all OpenStack related tools
manageCloudOpenStackCompute()  : void
This function will manage specific Cloud OpenStack Compute tools
manageCloudOpenStackIdentity()  : void
This function will manage specific Cloud OpenStack Identity tools
manageCloudOpenStackNetworking()  : void
This function will manage specific Cloud OpenStack Networking tools
manageCRM()  : void
This function will manage specific CRM tools
manageDatabase()  : void
This function will manage database tools
manageExit()  : void
This function is used when the user should exit
manageGenerate()  : void
This function will manage generate tools
manageInspectModel()  : void
This function is used to inspect, using default Laravel model:show, one of the system models
manageSystem()  : void
This function will manage specific System tools
promptTeam()  : void

Properties

$description

The command description

protected string $description = "This is the main command menu for the bennu system"

$signature

The command signature

protected string $signature = "bennu:commander"

$silent

Suppress all info,error,warn and printWelcome output messages use `$this->line` instead to force writing output in silent mode

protected bool $silent = false

Methods

__construct()

Constructor, it will start a new batch to group all log items

public __construct() : mixed
Return values
mixed

call()

Call another console command.

public call( $command[, array<string|int, mixed> $arguments = [] ]) : int
Parameters
$command :
$arguments : array<string|int, mixed> = []
Return values
int

error()

Print an <error>$string</error> message

public error( $string[,  $verbosity = null ]) : void
Parameters
$string :
$verbosity : = null
Return values
void

handle()

This function will handle all the logic of the command

public handle() : void
Return values
void

info()

Print an <info>$string</info> message

public info( $string[,  $verbosity = null ]) : void
Parameters
$string :
$verbosity : = null
Return values
void

warn()

Print an <error>$string</error> message

public warn( $string[,  $verbosity = null ]) : void
Parameters
$string :
$verbosity : = null
Return values
void

printWelcome()

Prints a Welcome message

protected printWelcome([string|null $message = null ][, bool $assumeYes = false ]) : bool
Parameters
$message : string|null = null
$assumeYes : bool = false
Return values
bool

chooser()

This is a generic function to prompt a menu and ask the user to choose an option

private chooser(string $question, array<string|int, mixed> $list[, bool $anticipate = false ]) : mixed
Parameters
$question : string
$list : array<string|int, mixed>
$anticipate : bool = false
Return values
mixed

mainFunctionChooser()

The main entry point for the command

private mainFunctionChooser() : void
Return values
void

manageBootstrap()

This function will manage bootstrap tools

private manageBootstrap() : void
Return values
void

manageCloud()

This function will manage all OpenStack related tools

private manageCloud() : void
Return values
void

manageCloudOpenStackCompute()

This function will manage specific Cloud OpenStack Compute tools

private manageCloudOpenStackCompute() : void
Return values
void

manageCloudOpenStackIdentity()

This function will manage specific Cloud OpenStack Identity tools

private manageCloudOpenStackIdentity() : void
Return values
void

manageCloudOpenStackNetworking()

This function will manage specific Cloud OpenStack Networking tools

private manageCloudOpenStackNetworking() : void
Return values
void

manageCRM()

This function will manage specific CRM tools

private manageCRM() : void
Return values
void

manageDatabase()

This function will manage database tools

private manageDatabase() : void
Return values
void

manageExit()

This function is used when the user should exit

private manageExit() : void
Return values
void

manageGenerate()

This function will manage generate tools

private manageGenerate() : void
Return values
void

manageInspectModel()

This function is used to inspect, using default Laravel model:show, one of the system models

private manageInspectModel() : void
Return values
void

manageSystem()

This function will manage specific System tools

private manageSystem() : void
Return values
void

promptTeam()

private promptTeam() : void
Tags
noinspection

DisconnectedForeachInstructionInspection

Return values
void

Search results