UserFrosting API

DebugCommand extends BaseCommand Uses DatabaseTest, NodeVersionCheck

Debug CLI tool.

Tags
author

Alex Weissman (https://alexanderweissman.com)

Table of Contents

$io SymfonyStyle
$ci ContainerInterface
configure() {@inheritdoc} mixed
execute() {@inheritdoc} mixed
checkPhpVersion() Check the minimum version of php. string
listSprinkles() List all sprinkles defined in the Sprinkles schema file, making sure this file exist at the same time. void
checkDatabase() Check the database connexion and setup the `.env` file if we can't connect and there's no one found. void
showConfig() Display database config as for debug purposes. void
testDB() Function to test the db connexion. bool
checkNodeVersion() Check the minimum version requirement of Node installed. string
checkNpmVersion() Check the minimum version requirement for Npm. string
initialize() {@inheritdoc} mixed
setContainer() Setup the global container object. void
isProduction() Return if the app is in production mode. bool

Properties

Methods

configure()

{@inheritdoc}

protected configure( ) : mixed
Return values
mixed

execute()

{@inheritdoc}

protected execute( $input : InputInterface , $output : OutputInterface ) : mixed
Parameters
$input : InputInterface
$output : OutputInterface
Return values
mixed

checkPhpVersion()

Check the minimum version of php.

protected checkPhpVersion( ) : string

This is done by composer itself, but we do it again for good mesure.

Return values
string —

The current PHP Version

listSprinkles()

List all sprinkles defined in the Sprinkles schema file, making sure this file exist at the same time.

protected listSprinkles( $input : InputInterface , $output : OutputInterface ) : void
Parameters
$input : InputInterface
$output : OutputInterface

checkDatabase()

Check the database connexion and setup the `.env` file if we can't connect and there's no one found.

protected checkDatabase( ) : void

showConfig()

Display database config as for debug purposes.

protected showConfig( ) : void

testDB()

Function to test the db connexion.

protected testDB( ) : bool
Return values
bool —

True if success

checkNodeVersion()

Check the minimum version requirement of Node installed.

protected checkNodeVersion( ) : string
Return values
string —

Node version

checkNpmVersion()

Check the minimum version requirement for Npm.

protected checkNpmVersion( ) : string
Return values
string —

NPM version

initialize()

{@inheritdoc}

protected initialize( $input : InputInterface , $output : OutputInterface ) : mixed
Parameters
$input : InputInterface
$output : OutputInterface
Return values
mixed

setContainer()

Setup the global container object.

public setContainer( $ci : ContainerInterface ) : void
Parameters
$ci : ContainerInterface

isProduction()

Return if the app is in production mode.

protected isProduction( ) : bool

@return bool True/False if the app is in production mode

Return values
bool

Search results