\phpDocumentor\Command\HelperLoggerHelper

Summary

Methods
Properties
Constants
addOptions()
getName()
connectOutputToLogging()
logEvent()
reconfigureLogger()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
No private properties found
N/A

Methods

addOptions()

addOptions(\phpDocumentor\Command\Command  $command) : void

Initializes the given command to accept logging options.

This method is intended to be executed once in the Constructor of the given Command as it adds a new option log.

Parameters

\phpDocumentor\Command\Command $command

getName()

getName() : string

Returns the canonical name of this helper.

Returns

string —

The canonical name

connectOutputToLogging()

connectOutputToLogging(\Symfony\Component\Console\Output\OutputInterface  $output, \phpDocumentor\Command\Command  $command) : void

Connect the logging events to the output object of Symfony Console.

Parameters

\Symfony\Component\Console\Output\OutputInterface $output
\phpDocumentor\Command\Command $command

logEvent()

logEvent(\Symfony\Component\Console\Output\OutputInterface  $output, \phpDocumentor\Event\LogEvent  $event, \phpDocumentor\Command\Command  $command) : void

Logs an event with the output.

This method will also colorize the message based on priority and withhold certain logging in case of verbosity or not.

Parameters

\Symfony\Component\Console\Output\OutputInterface $output
\phpDocumentor\Event\LogEvent $event
\phpDocumentor\Command\Command $command

reconfigureLogger()

reconfigureLogger(\Symfony\Component\Console\Input\InputInterface  $input, \Symfony\Component\Console\Output\OutputInterface  $output,   $command) 

Parameters

\Symfony\Component\Console\Input\InputInterface $input
\Symfony\Component\Console\Output\OutputInterface $output
$command