Monolog\Formatter\HtmlFormatter Class Reference

Formats incoming records into an HTML table. More...

Inheritance diagram for Monolog\Formatter\HtmlFormatter:

Collaboration diagram for Monolog\Formatter\HtmlFormatter:

Public Member Functions
	__construct ($dateFormat=null)
	format (array $record)
	Formats a log record. More...
	formatBatch (array $records)
	Formats a set of log records. More...
Public Member Functions inherited from Monolog\Formatter\NormalizerFormatter
	__construct ($dateFormat=null)
	format (array $record)
	{Formats a log record. Parameters array $record A record to format Returns mixed The formatted record } More...
	formatBatch (array $records)
	{Formats a set of log records. Parameters array $records A set of records to format Returns mixed The formatted set of records } More...
	detectAndCleanUtf8 (&$data)
	Detect invalid UTF-8 string characters and convert to valid UTF-8. More...

Protected Member Functions
	addRow ($th, $td=' ', $escapeTd=true)
	Creates an HTML table row. More...
	addTitle ($title, $level)
	Create a HTML h1 tag. More...
	convertToString ($data)
Protected Member Functions inherited from Monolog\Formatter\NormalizerFormatter
	normalize ($data)
	normalizeException ($e)
	toJson ($data, $ignoreErrors=false)
	Return the JSON representation of a value. More...

Protected Attributes
	$logLevels
	Translates Monolog log levels to html color priorities. More...
Protected Attributes inherited from Monolog\Formatter\NormalizerFormatter
	$dateFormat

Additional Inherited Members
Data Fields inherited from Monolog\Formatter\NormalizerFormatter
const	SIMPLE_DATE = "Y-m-d H:i:s"

Detailed Description

Formats incoming records into an HTML table.

This is especially useful for html email logging

Author

Tiago Brito tlfbr.nosp@m.ito@.nosp@m.gmail.nosp@m..com

Definition at line 22 of file HtmlFormatter.php.

Constructor & Destructor Documentation

__construct()

Monolog\Formatter\HtmlFormatter::__construct

(

$dateFormat = null

)

Parameters

string

$dateFormat

The format of the timestamp: one supported by DateTime::format

Definition at line 41 of file HtmlFormatter.php.

References Monolog\Formatter\NormalizerFormatter\$dateFormat.

    {
        parent::__construct($dateFormat);
    }

Member Function Documentation

addRow()

Monolog\Formatter\HtmlFormatter::addRow (   $th,   $td = ' ',   $escapeTd = true  )

protected

Creates an HTML table row.

Parameters

string	$th	Row header content
string	$td	Row standard cell content
bool	$escapeTd	false if td content must not be html escaped

Returns

string

Definition at line 54 of file HtmlFormatter.php.

Referenced by Monolog\Formatter\HtmlFormatter\format().

    {
        $th = htmlspecialchars($th, ENT_NOQUOTES, 'UTF-8');
        if ($escapeTd) {
            $td = '<pre>'.htmlspecialchars($td, ENT_NOQUOTES, 'UTF-8').'</pre>';
        }

        return "<tr style=\"padding: 4px;spacing: 0;text-align: left;\">\n<th style=\"background: #cccccc\" width=\"100px\">$th:</th>\n<td style=\"padding: 4px;spacing: 0;text-align: left;background: #eeeeee\">".$td."</td>\n</tr>";
    }

Here is the caller graph for this function:

addTitle()

Monolog\Formatter\HtmlFormatter::addTitle (   $title,   $level  )

protected

Create a HTML h1 tag.

Parameters

string	$title	Text to be in the h1
int	$level	Error level

Returns

string

Definition at line 71 of file HtmlFormatter.php.

References $title.

Referenced by Monolog\Formatter\HtmlFormatter\format().

    {
        $title = htmlspecialchars($title, ENT_NOQUOTES, 'UTF-8');

        return '<h1 style="background: '.$this->logLevels[$level].';color: #ffffff;padding: 5px;" class="monolog-output">'.$title.'</h1>';
    }

Here is the caller graph for this function:

convertToString()

Monolog\Formatter\HtmlFormatter::convertToString (   $data )

protected

Definition at line 128 of file HtmlFormatter.php.

References $data, and Monolog\Formatter\NormalizerFormatter\normalize().

Referenced by Monolog\Formatter\HtmlFormatter\format().

    {
        if (null === $data || is_scalar($data)) {
            return (string) $data;
        }

        $data = $this->normalize($data);
        if (version_compare(PHP_VERSION, '5.4.0', '>=')) {
            return json_encode($data, JSON_PRETTY_PRINT | JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE);
        }

        return str_replace('\\/', '/', json_encode($data));
    }

Here is the call graph for this function:

Here is the caller graph for this function:

format()

Monolog\Formatter\HtmlFormatter::format

(

array

$record

)

Formats a log record.

Parameters

array

$record

A record to format

Returns

mixed The formatted record

Implements Monolog\Formatter\FormatterInterface.

Definition at line 84 of file HtmlFormatter.php.

References $key, $output, Monolog\Formatter\HtmlFormatter\addRow(), Monolog\Formatter\HtmlFormatter\addTitle(), and Monolog\Formatter\HtmlFormatter\convertToString().

Referenced by Monolog\Formatter\HtmlFormatter\formatBatch().

    {
        $output = $this->addTitle($record['level_name'], $record['level']);
        $output .= '<table cellspacing="1" width="100%" class="monolog-output">';

        $output .= $this->addRow('Message', (string) $record['message']);
        $output .= $this->addRow('Time', $record['datetime']->format($this->dateFormat));
        $output .= $this->addRow('Channel', $record['channel']);
        if ($record['context']) {
            $embeddedTable = '<table cellspacing="1" width="100%">';
            foreach ($record['context'] as $key => $value) {
                $embeddedTable .= $this->addRow($key, $this->convertToString($value));
            }
            $embeddedTable .= '</table>';
            $output .= $this->addRow('Context', $embeddedTable, false);
        }
        if ($record['extra']) {
            $embeddedTable = '<table cellspacing="1" width="100%">';
            foreach ($record['extra'] as $key => $value) {
                $embeddedTable .= $this->addRow($key, $this->convertToString($value));
            }
            $embeddedTable .= '</table>';
            $output .= $this->addRow('Extra', $embeddedTable, false);
        }

        return $output.'</table>';
    }

Here is the call graph for this function:

Here is the caller graph for this function:

formatBatch()

Monolog\Formatter\HtmlFormatter::formatBatch

(

array

$records

)

Formats a set of log records.

Parameters

array

$records

A set of records to format

Returns

mixed The formatted set of records

Implements Monolog\Formatter\FormatterInterface.

Definition at line 118 of file HtmlFormatter.php.

References $message, and Monolog\Formatter\HtmlFormatter\format().

    {
        $message = '';
        foreach ($records as $record) {
            $message .= $this->format($record);
        }

        return $message;
    }

Here is the call graph for this function:

Field Documentation

$logLevels

Monolog\Formatter\HtmlFormatter::$logLevels

protected

Initial value:

= array(
        Logger::DEBUG     => '#cccccc',
        Logger::INFO      => '#468847',
        Logger::NOTICE    => '#3a87ad',
        Logger::WARNING   => '#c09853',
        Logger::ERROR     => '#f0ad4e',
        Logger::CRITICAL  => '#FF7708',
        Logger::ALERT     => '#C12A19',
        Logger::EMERGENCY => '#000000',
    )

Translates Monolog log levels to html color priorities.

Definition at line 27 of file HtmlFormatter.php.

---

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

• libs/composer/vendor/monolog/monolog/src/Monolog/Formatter/HtmlFormatter.php