Monolog\Formatter\LineFormatter Class Reference

Formats incoming records into a one-line string. More...

Inheritance diagram for Monolog\Formatter\LineFormatter:

Collaboration diagram for Monolog\Formatter\LineFormatter:

Public Member Functions
	__construct ($format=null, $dateFormat=null, $allowInlineLineBreaks=false, $ignoreEmptyContextAndExtra=false)
	includeStacktraces ($include=true)
	allowInlineLineBreaks ($allow=true)
	ignoreEmptyContextAndExtra ($ignore=true)
	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. More...
	stringify ($value)
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...

Data Fields
const	SIMPLE_FORMAT = "[%datetime%] %channel%.%level_name%: %message% %context% %extra%\n"
Data Fields inherited from Monolog\Formatter\NormalizerFormatter
const	SIMPLE_DATE = "Y-m-d H:i:s"

Protected Member Functions
	normalizeException ($e)
	convertToString ($data)
	replaceNewlines ($str)
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
	$format
	$allowInlineLineBreaks
	$ignoreEmptyContextAndExtra
	$includeStacktraces
Protected Attributes inherited from Monolog\Formatter\NormalizerFormatter
	$dateFormat

Detailed Description

Formats incoming records into a one-line string.

This is especially useful for logging to files

Author

Jordi Boggiano j.bog.nosp@m.gian.nosp@m.o@sel.nosp@m.d.be

Christophe Coevoet stof@.nosp@m.notk.nosp@m..org

Definition at line 22 of file LineFormatter.php.

Constructor & Destructor Documentation

__construct()

Monolog\Formatter\LineFormatter::__construct	(		$format = null,
			$dateFormat = null,
			$allowInlineLineBreaks = false,
			$ignoreEmptyContextAndExtra = false
	)

Parameters

string	$format	The format of the message
string	$dateFormat	The format of the timestamp: one supported by DateTime::format
bool	$allowInlineLineBreaks	Whether to allow inline line breaks in log entries
bool	$ignoreEmptyContextAndExtra

Definition at line 37 of file LineFormatter.php.

References Monolog\Formatter\LineFormatter\$allowInlineLineBreaks, Monolog\Formatter\NormalizerFormatter\$dateFormat, Monolog\Formatter\LineFormatter\$format, Monolog\Formatter\LineFormatter\$ignoreEmptyContextAndExtra, Monolog\Formatter\LineFormatter\allowInlineLineBreaks(), Monolog\Formatter\LineFormatter\format(), and Monolog\Formatter\LineFormatter\ignoreEmptyContextAndExtra().

    {
        $this->format = $format ?: static::SIMPLE_FORMAT;
        $this->allowInlineLineBreaks = $allowInlineLineBreaks;
        $this->ignoreEmptyContextAndExtra = $ignoreEmptyContextAndExtra;
        parent::__construct($dateFormat);
    }

Here is the call graph for this function:

Member Function Documentation

allowInlineLineBreaks()

Monolog\Formatter\LineFormatter::allowInlineLineBreaks

(

$allow = true

)

Definition at line 53 of file LineFormatter.php.

Referenced by Monolog\Formatter\LineFormatter\__construct(), Monolog\Formatter\LineFormatter\includeStacktraces(), and Monolog\Formatter\LineFormatter\replaceNewlines().

    {
        $this->allowInlineLineBreaks = $allow;
    }

Here is the caller graph for this function:

convertToString()

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

protected

Definition at line 144 of file LineFormatter.php.

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

Referenced by Monolog\Formatter\LineFormatter\stringify().

    {
        if (null === $data || is_bool($data)) {
            return var_export($data, true);
        }

        if (is_scalar($data)) {
            return (string) $data;
        }

        if (version_compare(PHP_VERSION, '5.4.0', '>=')) {
            return $this->toJson($data, true);
        }

        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\LineFormatter::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 66 of file LineFormatter.php.

References Monolog\Formatter\LineFormatter\$format, $output, format, and Monolog\Formatter\LineFormatter\ignoreEmptyContextAndExtra().

Referenced by Monolog\Formatter\LineFormatter\__construct(), and Monolog\Formatter\LineFormatter\formatBatch().

    {
        $vars = parent::format($record);

        $output = $this->format;

        foreach ($vars['extra'] as $var => $val) {
            if (false !== strpos($output, '%extra.'.$var.'%')) {
                $output = str_replace('%extra.'.$var.'%', $this->stringify($val), $output);
                unset($vars['extra'][$var]);
            }
        }

        foreach ($vars['context'] as $var => $val) {
            if (false !== strpos($output, '%context.'.$var.'%')) {
                $output = str_replace('%context.'.$var.'%', $this->stringify($val), $output);
                unset($vars['context'][$var]);
            }
        }

        if ($this->ignoreEmptyContextAndExtra) {
            if (empty($vars['context'])) {
                unset($vars['context']);
                $output = str_replace('%context%', '', $output);
            }

            if (empty($vars['extra'])) {
                unset($vars['extra']);
                $output = str_replace('%extra%', '', $output);
            }
        }

        foreach ($vars as $var => $val) {
            if (false !== strpos($output, '%'.$var.'%')) {
                $output = str_replace('%'.$var.'%', $this->stringify($val), $output);
            }
        }

        return $output;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

formatBatch()

Monolog\Formatter\LineFormatter::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 107 of file LineFormatter.php.

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

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

        return $message;
    }

Here is the call graph for this function:

ignoreEmptyContextAndExtra()

Monolog\Formatter\LineFormatter::ignoreEmptyContextAndExtra

(

$ignore = true

)

Definition at line 58 of file LineFormatter.php.

References $ignore.

Referenced by Monolog\Formatter\LineFormatter\__construct(), and Monolog\Formatter\LineFormatter\format().

    {
        $this->ignoreEmptyContextAndExtra = $ignore;
    }

Here is the caller graph for this function:

includeStacktraces()

Monolog\Formatter\LineFormatter::includeStacktraces

(

$include = true

)

Definition at line 45 of file LineFormatter.php.

References Monolog\Formatter\LineFormatter\allowInlineLineBreaks().

Referenced by Monolog\Formatter\LineFormatter\normalizeException().

    {
        $this->includeStacktraces = $include;
        if ($this->includeStacktraces) {
            $this->allowInlineLineBreaks = true;
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

normalizeException()

Monolog\Formatter\LineFormatter::normalizeException (   $e )

protected

Definition at line 122 of file LineFormatter.php.

References Monolog\Formatter\LineFormatter\includeStacktraces().

    {
        // TODO 2.0 only check for Throwable
        if (!$e instanceof \Exception && !$e instanceof \Throwable) {
            throw new \InvalidArgumentException('Exception/Throwable expected, got '.gettype($e).' / '.get_class($e));
        }

        $previousText = '';
        if ($previous = $e->getPrevious()) {
            do {
                $previousText .= ', '.get_class($previous).'(code: '.$previous->getCode().'): '.$previous->getMessage().' at '.$previous->getFile().':'.$previous->getLine();
            } while ($previous = $previous->getPrevious());
        }

        $str = '[object] ('.get_class($e).'(code: '.$e->getCode().'): '.$e->getMessage().' at '.$e->getFile().':'.$e->getLine().$previousText.')';
        if ($this->includeStacktraces) {
            $str .= "\n[stacktrace]\n".$e->getTraceAsString();
        }

        return $str;
    }

Here is the call graph for this function:

replaceNewlines()

Monolog\Formatter\LineFormatter::replaceNewlines (   $str )

protected

Definition at line 161 of file LineFormatter.php.

References Monolog\Formatter\LineFormatter\allowInlineLineBreaks(), and array.

Referenced by Monolog\Formatter\LineFormatter\stringify().

    {
        if ($this->allowInlineLineBreaks) {
            return $str;
        }

        return str_replace(array("\r\n", "\r", "\n"), ' ', $str);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

stringify()

Monolog\Formatter\LineFormatter::stringify

(

$value

)

Definition at line 117 of file LineFormatter.php.

References Monolog\Formatter\LineFormatter\convertToString(), and Monolog\Formatter\LineFormatter\replaceNewlines().

    {
        return $this->replaceNewlines($this->convertToString($value));
    }

Here is the call graph for this function:

Field Documentation

$allowInlineLineBreaks

Monolog\Formatter\LineFormatter::$allowInlineLineBreaks

protected

Definition at line 27 of file LineFormatter.php.

Referenced by Monolog\Formatter\LineFormatter\__construct().

$format

Monolog\Formatter\LineFormatter::$format

protected

Definition at line 26 of file LineFormatter.php.

Referenced by Monolog\Formatter\LineFormatter\__construct(), and Monolog\Formatter\LineFormatter\format().

$ignoreEmptyContextAndExtra

Monolog\Formatter\LineFormatter::$ignoreEmptyContextAndExtra

protected

Definition at line 28 of file LineFormatter.php.

Referenced by Monolog\Formatter\LineFormatter\__construct().

$includeStacktraces

Monolog\Formatter\LineFormatter::$includeStacktraces

protected

Definition at line 29 of file LineFormatter.php.

SIMPLE_FORMAT

const Monolog\Formatter\LineFormatter::SIMPLE_FORMAT = "[%datetime%] %channel%.%level_name%: %message% %context% %extra%\n"

Definition at line 24 of file LineFormatter.php.

---

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

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