class Output

Class Output

Constants

VERBOSITY_ALWAYS

VERBOSITY_QUIET

VERBOSITY_NORMAL

VERBOSITY_VERBOSE

VERBOSITY_VERY_VERBOSE

VERBOSITY_DEBUG

Properties

protected int $verbosity

Methods

__construct(int $verbosity = self::VERBOSITY_NORMAL)

Output constructor.

string
_parseCLITagsCallback(array $matches)

No description

string
applyColor(string $string, string $colorFormatTag)

Color, Formatting

block(string $text, string $underline = '-', string $topline = '')

No description

box($text)

Print Text in box Example: ┌─────────────────────┐ │ No changes detected │ └─────────────────────┘

error($message, array $vars = [], $verbosity = self::VERBOSITY_ALWAYS)

No description

int
getVerbosity()

No description

h1($headline, bool $subheadline = false)

No description

h2($headline)

No description

h3($headline)

No description

bool
hasVerbosity($verbosityLevel)

Returns true if the current verbosity includes the passed verbosity level

message($message, array $vars = [], $verbosity = self::VERBOSITY_ALWAYS)

No description

newLine(int $count = 1)

No description

string
parseColorTags($string)

No description

success($message, array $vars = [], $verbosity = self::VERBOSITY_ALWAYS)

Outputs a Success Message

table(array $tableRows, bool $firstRowIsHead = true)

Print Table in CLI, Example: ┌────────────────────────────────────────────────────────────────────────────────────────────────────────┐ │ Module │ Installed │ Repository │ Package │ ┝━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┥ │ Directory Sync │ 8.2.4 │ 9.0.5 │ Active Directory and SSO Authentication │ └────────────────────────────────────────────────────────────────────────────────────────────────────────┘

warning($message, array $vars = [], $verbosity = self::VERBOSITY_ALWAYS)

Outputs a Success Message

Details

at line 26
__construct(int $verbosity = self::VERBOSITY_NORMAL)

Output constructor.

Parameters

int $verbosity

at line 162
string _parseCLITagsCallback(array $matches)

No description

Parameters

array $matches

Return Value

string

at line 153
string applyColor(string $string, string $colorFormatTag)

Color, Formatting

Parameters

string $string
string $colorFormatTag

b,u,red,green,warning,error,note,success

Return Value

string

at line 197
block(string $text, string $underline = '-', string $topline = '')

No description

Parameters

string $text
string $underline
string $topline

at line 212
box($text)

Print Text in box Example: ┌─────────────────────┐ │ No changes detected │ └─────────────────────┘

Parameters

$text

at line 50
error($message, array $vars = [], $verbosity = self::VERBOSITY_ALWAYS)

No description

Parameters

$message
array $vars
$verbosity

at line 33
int getVerbosity()

No description

Return Value

int

at line 101
h1($headline, bool $subheadline = false)

No description

Parameters

$headline
bool $subheadline

at line 120
h2($headline)

No description

Parameters

$headline

at line 129
h3($headline)

No description

Parameters

$headline

at line 42
bool hasVerbosity($verbosityLevel)

Returns true if the current verbosity includes the passed verbosity level

Parameters

$verbosityLevel

Return Value

bool

at line 89
message($message, array $vars = [], $verbosity = self::VERBOSITY_ALWAYS)

No description

Parameters

$message
array $vars
$verbosity

at line 113
newLine(int $count = 1)

No description

Parameters

int $count

at line 139
string parseColorTags($string)

No description

Parameters

$string

Return Value

string

at line 64
success($message, array $vars = [], $verbosity = self::VERBOSITY_ALWAYS)

Outputs a Success Message

Parameters

$message
array $vars
$verbosity

at line 228
table(array $tableRows, bool $firstRowIsHead = true)

Print Table in CLI, Example: ┌────────────────────────────────────────────────────────────────────────────────────────────────────────┐ │ Module │ Installed │ Repository │ Package │ ┝━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┥ │ Directory Sync │ 8.2.4 │ 9.0.5 │ Active Directory and SSO Authentication │ └────────────────────────────────────────────────────────────────────────────────────────────────────────┘

Parameters

array $tableRows

= [['headcol','col2'],['bodycol,'col2']]

bool $firstRowIsHead

at line 77
warning($message, array $vars = [], $verbosity = self::VERBOSITY_ALWAYS)

Outputs a Success Message

Parameters

$message
array $vars
$verbosity