Output
in package
Components_Output:: handles output from the components application.
Copyright 2010-2020 Horde LLC (http://www.horde.org/)
See the enclosed file LICENSE for license information (LGPL). If you did not receive this file, see http://www.horde.org/licenses/lgpl21.
Tags
Table of Contents
- $_cli : Horde_Cli
- $_nocolor : bool
- Did the user request to avoid colored output?
- $_quiet : bool
- Did the user request quiet output?
- $_verbose : bool
- Did the user request verbose output?
- __construct() : mixed
- Constructor.
- blue() : void
- bold() : void
- error() : void
- fail() : void
- green() : void
- help() : void
- info() : void
- isQuiet() : bool
- isVerbose() : bool
- log() : void
- ok() : void
- pear() : void
- plain() : void
- warn() : void
- yellow() : void
- _getType() : string
- Modify the type for the --nocolor switch.
Properties
$_cli read-only
private
Horde_Cli
$_cli
$_nocolor read-only
Did the user request to avoid colored output?
private
bool
$_nocolor
$_quiet read-only
Did the user request quiet output?
private
bool
$_quiet
$_verbose read-only
Did the user request verbose output?
private
bool
$_verbose
Methods
__construct()
Constructor.
public
__construct(Horde_Cli $_cli, array<string|int, mixed> $options) : mixed
Parameters
- $_cli : Horde_Cli
-
The CLI handler.
- $options : array<string|int, mixed>
-
The configuration for the current job.
Return values
mixed —blue()
public
blue(mixed $text) : void
Parameters
- $text : mixed
Return values
void —bold()
public
bold(mixed $text) : void
Parameters
- $text : mixed
Return values
void —error()
public
error(mixed $text) : void
Parameters
- $text : mixed
Return values
void —fail()
public
fail(mixed $text) : void
Parameters
- $text : mixed
Return values
void —green()
public
green(mixed $text) : void
Parameters
- $text : mixed
Return values
void —help()
public
help(mixed $text) : void
Parameters
- $text : mixed
Return values
void —info()
public
info(mixed $text) : void
Parameters
- $text : mixed
Return values
void —isQuiet()
public
isQuiet() : bool
Return values
bool —isVerbose()
public
isVerbose() : bool
Return values
bool —log()
public
log(mixed $status, mixed $text) : void
Parameters
- $status : mixed
- $text : mixed
Return values
void —ok()
public
ok(mixed $text) : void
Parameters
- $text : mixed
Return values
void —pear()
public
pear(mixed $text) : void
Parameters
- $text : mixed
Return values
void —plain()
public
plain(mixed $text) : void
Parameters
- $text : mixed
Return values
void —warn()
public
warn(mixed $text) : void
Parameters
- $text : mixed
Return values
void —yellow()
public
yellow(mixed $text) : void
Parameters
- $text : mixed
Return values
void —_getType()
Modify the type for the --nocolor switch.
private
_getType(string $type) : string
Parameters
- $type : string
-
The message to rewrite.
Return values
string —The message type that should be used for the output.