IO Component - Method Reference

In the following you find a detailled explanation of the logging component.

---

Logger methods¶

• logDebug($message, array $context = [])

  Add a debug message to the logfile directly.

  ---

• logInfo($message, array $context = [])

  Add an info to the logfile directly.

  ---

• logNotice($message, array $context = [])

  Add a notice to the logfile directly.

  ---

• logWarning($message, array $context = [])

  Add a warning to the logfile directly.

  ---

• logError($message, array $context = [])

  Add an error message to the logfile directly.

  ---

• logCritical($message, array $context = [])

  Add a critical event to the logfile directly.

  ---

• logAlert($message, array $context = [])

  Add an alert to the logfile directly.

  ---

• logEmergency($message, array $context = [])

  Add an emergency event to the logfile directly.

---

RawIO methods¶

• emergency(string $message, array $context = [])

  The system is unusable, e.g. a fatal startup error happened.

  This method is part of the PSR LoggerInterface.

  ---

• alert(string $message, array $context = [])

  Action must be taken immediately, e.g. database is unavailable.

  This method is part of the PSR LoggerInterface.

  ---

• critical(string $message, array $context = [])

  Critical conditions, e.g. an app component is unavailable.

  This method is part of the PSR LoggerInterface.

  ---

• error(string $message, array $context = [])

  Runtime errors that do not require immediate action but should be monitored.

  This method is part of the PSR LoggerInterface.

  ---

• warning(string $message, array $context = [])

  Exceptional occurrences that are not errors, e.g. use of deprecated APIs.

  This method is part of the PSR LoggerInterface.

  ---

• notice(string $message, array $context = [])

  Normal but significant events.

  This method is part of the PSR LoggerInterface.

  ---

• info(string $message, array $context = [])

  Interesting events, e.g. an SQL log.

  This method is part of the PSR LoggerInterface.

  ---

• debug(string $message, array $context = [])

  Detailed debug information.

  This method is part of the PSR LoggerInterface.

  ---

• log($level, string $message, array $context = [])

  Logs with an arbitrary level.

  This method is part of the PSR LoggerInterface.

  ---

• interpolate(string $message, array $context = [])

  Interpolates message placeholders with the corresponding context values supplied.

  A placeholder is in the form of: {MyPlaceholder}

  ---

• out(string $message, array $context = [], string $color = null, string $background = null)

  Output an optionally colored message to the terminal.

  ---

• success(string $message, array $context = [])

  Output a success-message.

  ---

• newline(int $count = 1)

  Output a linebreak.

  ---

• clear()

  Clear the terminal screen

---

IO methods¶

• setInteractive(bool $interactive)

  Set the interactiveness of the application.

  ---

• isInteractive()

  Get if the application runs in interactive mode.

  ---

• setVerbosity(int $verbosity)

  Set the verbosity of the application.

  ---

• getVerbosity()

  Get the verbosity of the application.

  ---

• isNormal()

  Get if the application runs with normal verbosity.

  ---

• isVerbose()

  Get if the application runs in verbose mode.

  ---

• isVeryVerbose()

  Get if the application runs in very verbose mode.

  ---

• isDebug()

  Get if the application runs in debug mode.

  ---

• setQuiet(bool $quiet)

  Set if the application runs in quiet mode.

  ---

• isQuiet()

  Get if the application runs in quiet mode.

  ---

• setNoAnsi(bool $noAnsi)

  Set the surpression of ANSI-output.

  ---

• isNoAnsi()

  Get if ANSI-output is beeing surpressed.

  ---

• setAssumeYes(bool $assumeYes)

  Set if the application shall assume 'yes' for questions in quiet mode.

  ---

• isYesAssumed()

  Get if the application assumes 'yes' for questions in quiet mode.

  ---

• prompt(string $question, bool $forceAnswer = false, string $default = null, bool $hint = false, bool $multiline = false, bool $hidden = false, string $color = 'yellow', string $background = null, string $hintColor = 'cyan', string $hintBackground = null)

  ---

• choose(string $question, array $answers, string $default = null, bool $hint = false, bool $strict = false, string $color = 'yellow', string $background = null)

  ---

• confirm(string $question, string $color = 'yellow', string $background = null)

  ---

• checkboxes(string $question, array $options)

  ---

• radiobuttons(string $question, array $options)

  ---

• simpleTable(array $data, bool $borderless = false)

  ---

• table(array $data, bool $borderless = false)

  ---

• columns(array $data, int $count = null, string $color = null, string $background = null)

  ---

• padding(array $data, $size = '+5', string $character = null, string $color = null, string $background = null, string $resultColor = null, string $resultBackground = null)

  ---

• border(string $pattern = null, int $size = null, string $color = null, string $background = null)

  ---

• startProgressBar(int $total = 100, string $color = null, string $background = null)

  ---

• setProgress(int $progress, string $label = null)

  ---

• advanceProgress(int $step, string $label = null)

  ---

• finishProgress(string $label = null)

  ---

• paddedBox(string $message, int $padding = 2, int $margin = 0, string $color = null, string $background = null)

---

RawIO vs. IO¶

It may occur, that you need to output something during startup of your application. This is done by using a preliminary (or raw) IO, which lacks most of the dynamic features but is capable of basic output. The IO class is built on top of the RawIO and includes the more complex features.

The main differences are as following:

• RawIO ignores any verbosity or quiet flag. Any message will always appear in the terminal unless you mute the application through piping to a null-device.
• RawIO does not allow any input or dynamic output to ensure functionality even in case of a fatal startup error.
• RawIO can be instantiated directly, whereas the IO class requires additional dependencies to be handed over.