Monolog\Formatter\NormalizerFormatter Class Reference

Normalizes incoming records to remove objects/resources so it's easier to dump to various targets. More...

Inheritance diagram for Monolog\Formatter\NormalizerFormatter:

Collaboration diagram for Monolog\Formatter\NormalizerFormatter:

Public Member Functions
	__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...

Data Fields
const	SIMPLE_DATE = "Y-m-d H:i:s"

Protected Member Functions
	normalize ($data)
	normalizeException (Exception $e)
	toJson ($data, $ignoreErrors=false)

Protected Attributes
	$dateFormat

Private Member Functions
	throwEncodeError ($code, $data)
	Throws an exception according to a given code with a customized message. More...

Detailed Description

Normalizes incoming records to remove objects/resources so it's easier to dump to various targets.

Author

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

Definition at line 21 of file NormalizerFormatter.php.

Constructor & Destructor Documentation

__construct()

Monolog\Formatter\NormalizerFormatter::__construct

(

$dateFormat = null

)

Parameters

string

$dateFormat

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

Definition at line 30 of file NormalizerFormatter.php.

References Monolog\Formatter\NormalizerFormatter\$dateFormat.

    {
        $this->dateFormat = $dateFormat ?: static::SIMPLE_DATE;
        if (!function_exists('json_encode')) {
            throw new \RuntimeException('PHP\'s json extension is required to use Monolog\'s NormalizerFormatter');
        }
    }

Member Function Documentation

format()

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

References Monolog\Formatter\NormalizerFormatter\normalize().

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

    {
        return $this->normalize($record);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

formatBatch()

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

References $records, and Monolog\Formatter\NormalizerFormatter\format().

    {
        foreach ($records as $key => $record) {
            $records[$key] = $this->format($record);
        }

        return $records;
    }

Here is the call graph for this function:

normalize()

Monolog\Formatter\NormalizerFormatter::normalize (   $data )

protected

Definition at line 58 of file NormalizerFormatter.php.

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

Referenced by Monolog\Formatter\HtmlFormatter\convertToString(), Monolog\Formatter\NormalizerFormatter\format(), Monolog\Formatter\NormalizerFormatter\normalizeException(), and Monolog\Formatter\ScalarFormatter\normalizeValue().

    {
        if (null === $data || is_scalar($data)) {
            if (is_float($data)) {
                if (is_infinite($data)) {
                    return ($data > 0 ? '' : '-') . 'INF';
                }
                if (is_nan($data)) {
                    return 'NaN';
                }
            }

            return $data;
        }

        if (is_array($data) || $data instanceof \Traversable) {
            $normalized = array();

            $count = 1;
            foreach ($data as $key => $value) {
                if ($count++ >= 1000) {
                    $normalized['...'] = 'Over 1000 items, aborting normalization';
                    break;
                }
                $normalized[$key] = $this->normalize($value);
            }

            return $normalized;
        }

        if ($data instanceof \DateTime) {
            return $data->format($this->dateFormat);
        }

        if (is_object($data)) {
            if ($data instanceof Exception) {
                return $this->normalizeException($data);
            }

            // non-serializable objects that implement __toString stringified
            if (method_exists($data, '__toString') && !$data instanceof \JsonSerializable) {
                $value = (string) $data;
            } else {
                // the rest is json-serialized in some way
                $value = $this->toJson($data, true);
            }

            return sprintf("[object] (%s: %s)", get_class($data), $value);
        }

        if (is_resource($data)) {
            return '[resource]';
        }

        return '[unknown('.gettype($data).')]';
    }

Here is the call graph for this function:

Here is the caller graph for this function:

normalizeException()

Monolog\Formatter\NormalizerFormatter::normalizeException ( Exception  $e )

protected

Definition at line 115 of file NormalizerFormatter.php.

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

Referenced by Monolog\Formatter\NormalizerFormatter\normalize().

    {
        $data = array(
            'class' => get_class($e),
            'message' => $e->getMessage(),
            'code' => $e->getCode(),
            'file' => $e->getFile().':'.$e->getLine(),
        );

        $trace = $e->getTrace();
        foreach ($trace as $frame) {
            if (isset($frame['file'])) {
                $data['trace'][] = $frame['file'].':'.$frame['line'];
            } else {
                // We should again normalize the frames, because it might contain invalid items
                $data['trace'][] = $this->toJson($this->normalize($frame), true);
            }
        }

        if ($previous = $e->getPrevious()) {
            $data['previous'] = $this->normalizeException($previous);
        }

        return $data;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

throwEncodeError()

Monolog\Formatter\NormalizerFormatter::throwEncodeError (   $code,   $data  )

private

Throws an exception according to a given code with a customized message.

Parameters

int	$code	return code of json_last_error function
mixed	$data	data that was meant to be encoded

Exceptions

Definition at line 172 of file NormalizerFormatter.php.

References $code, and $data.

Referenced by Monolog\Formatter\NormalizerFormatter\toJson().

    {
        switch ($code) {
            case JSON_ERROR_DEPTH:
                $msg = 'Maximum stack depth exceeded';
                break;
            case JSON_ERROR_STATE_MISMATCH:
                $msg = 'Underflow or the modes mismatch';
                break;
            case JSON_ERROR_CTRL_CHAR:
                $msg = 'Unexpected control character found';
                break;
            case JSON_ERROR_UTF8:
                $msg = 'Malformed UTF-8 characters, possibly incorrectly encoded';
                break;
            default:
                $msg = 'Unknown error';
        }

        throw new \RuntimeException('JSON encoding failed: '.$msg.'. Encoding: '.var_export($data, true));
    }

Here is the caller graph for this function:

toJson()

Monolog\Formatter\NormalizerFormatter::toJson (   $data,   $ignoreErrors = false  )

protected

Definition at line 141 of file NormalizerFormatter.php.

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

Referenced by Monolog\Formatter\LineFormatter\convertToString(), Monolog\Formatter\WildfireFormatter\format(), Monolog\Formatter\GelfMessageFormatter\format(), Monolog\Formatter\LogstashFormatter\format(), Monolog\Formatter\NormalizerFormatter\normalize(), Monolog\Formatter\NormalizerFormatter\normalizeException(), and Monolog\Formatter\ScalarFormatter\normalizeValue().

    {
        // suppress json_encode errors since it's twitchy with some inputs
        if ($ignoreErrors) {
            if (version_compare(PHP_VERSION, '5.4.0', '>=')) {
                return @json_encode($data, JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE);
            }

            return @json_encode($data);
        }

        if (version_compare(PHP_VERSION, '5.4.0', '>=')) {
            $json = json_encode($data, JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE);
        } else {
            $json = json_encode($data);
        }

        if ($json === false) {
            $this->throwEncodeError(json_last_error(), $data);
        }

        return $json;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$dateFormat

Monolog\Formatter\NormalizerFormatter::$dateFormat

protected

Definition at line 25 of file NormalizerFormatter.php.

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

SIMPLE_DATE

const Monolog\Formatter\NormalizerFormatter::SIMPLE_DATE = "Y-m-d H:i:s"

Definition at line 23 of file NormalizerFormatter.php.

---

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

• Services/Logging/lib/vendor/monolog/monolog/src/Monolog/Formatter/NormalizerFormatter.php