CliOutput

Base class defining a command line output handler

abstract deprecated
since

4.0.0

deprecated

4.3 will be removed in 6.0 Use the joomla/console package instead

package

Joomla CMS

Methods

__construct

Constructor

__construct(\Joomla\CMS\Application\CLI\Output\Processor\ProcessorInterface processor = null) : mixed
since

4.0.0

Arguments

processor

\Joomla\CMS\Application\CLI\Output\Processor\ProcessorInterfaceThe output processor.

Response

mixed

getProcessor

Get a processor

getProcessor() : \Joomla\CMS\Application\CLI\Output\Processor\ProcessorInterface
since

4.0.0

throws

\RuntimeException

Response

\Joomla\CMS\Application\CLI\Output\Processor\ProcessorInterface

out

Write a string to an output handler.

out(string text = '', bool nl = true) : $this
abstract
since

4.0.0

Arguments

text

stringThe text to display.

nl

boolTrue (default) to append a new line at the end of the output string.

Response

$this

setProcessor

Set a processor

setProcessor(\Joomla\CMS\Application\CLI\Output\Processor\ProcessorInterface processor) : $this
since

4.0.0

Arguments

processor

\Joomla\CMS\Application\CLI\Output\Processor\ProcessorInterfaceThe output processor.

Response

$this

Properties

processor

Output processing object

since

4.0.0

Type(s)

\Joomla\CMS\Application\CLI\Output\Processor\ProcessorInterface