Magento 2 Documentation  2.3
Documentation for Magento 2 CMS v2.3 (December 2018)
Public Member Functions | Protected Attributes
ConsoleLogger Class Reference
Inheritance diagram for ConsoleLogger:
LoggerInterface

Public Member Functions

 __construct (OutputInterface $output)
 
 logSuccess ($message)
 
 logError (\Exception $e)
 
 log ($message)
 
 logInline ($message)
 
 logMeta ($message)
 

Protected Attributes

 $console
 

Detailed Description

Definition at line 17 of file ConsoleLogger.php.

Constructor & Destructor Documentation

◆ __construct()

__construct ( OutputInterface  $output)

Constructor

Parameters
OutputInterface$output

Definition at line 38 of file ConsoleLogger.php.

39  {
40  $this->console = $output;
41  $outputFormatter = $this->console->getFormatter();
42  $outputFormatter->setStyle('detail', new OutputFormatterStyle('blue'));
43  $outputFormatter->setStyle('metadata', new OutputFormatterStyle('cyan'));
44  }

Member Function Documentation

◆ log()

log (   $message)

{Logs a message

Parameters
string$message
Returns
void
}

Implements LoggerInterface.

Definition at line 67 of file ConsoleLogger.php.

68  {
69  $this->terminateLine();
70  $this->console->writeln('<detail>' . $message . '</detail>');
71  }
$message

◆ logError()

logError ( \Exception  $e)

{Logs error message

Parameters
\Exception$e
Returns
void
}

Implements LoggerInterface.

Definition at line 58 of file ConsoleLogger.php.

59  {
60  $this->terminateLine();
61  $this->console->writeln("<error>[ERROR]: " . $e . '</error>');
62  }

◆ logInline()

logInline (   $message)

{Logs a message in the current line

Parameters
string$message
Returns
void
}

Implements LoggerInterface.

Definition at line 76 of file ConsoleLogger.php.

77  {
78  $this->isInline = true;
79  $this->console->write('<detail>' . $message . '</detail>');
80  }
$message

◆ logMeta()

logMeta (   $message)

{Logs meta information

Parameters
string$message
Returns
void
}

Implements LoggerInterface.

Definition at line 85 of file ConsoleLogger.php.

86  {
87  $this->terminateLine();
88  $this->console->writeln('<metadata>' . $message . '</metadata>');
89  }
$message

◆ logSuccess()

logSuccess (   $message)

{Logs success message

Parameters
string$message
Returns
void
}

Implements LoggerInterface.

Definition at line 49 of file ConsoleLogger.php.

50  {
51  $this->terminateLine();
52  $this->console->writeln("<info>[SUCCESS]" . ($message ? ": $message" : '') . '</info>');
53  }
$message

Field Documentation

◆ $console

$console
protected

Definition at line 31 of file ConsoleLogger.php.


The documentation for this class was generated from the following file: