Monolog\Formatter\MongoDBFormatter Class Reference

Formats a record for use with the MongoDBHandler. More...

Inheritance diagram for Monolog\Formatter\MongoDBFormatter:

Collaboration diagram for Monolog\Formatter\MongoDBFormatter:

Public Member Functions
	__construct ($maxNestingLevel=3, $exceptionTraceAsString=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. Parameters array $records A set of records to format Returns mixed The formatted set of records More...

Protected Member Functions
	formatArray (array $record, $nestingLevel=0)
	formatObject ($value, $nestingLevel)
	formatException (\Exception $exception, $nestingLevel)
	formatDate (\DateTime $value, $nestingLevel)

Private Attributes
	$exceptionTraceAsString
	$maxNestingLevel

Detailed Description

Formats a record for use with the MongoDBHandler.

Author

Florian Plattner me@fl.nosp@m.oria.nosp@m.nplat.nosp@m.tner.nosp@m..de

Definition at line 21 of file MongoDBFormatter.php.

Constructor & Destructor Documentation

__construct()

Monolog\Formatter\MongoDBFormatter::__construct	(		$maxNestingLevel = 3,
			$exceptionTraceAsString = true
	)

Parameters

int	$maxNestingLevel	0 means infinite nesting, the $record itself is level 1, $record['context'] is 2
bool	$exceptionTraceAsString	set to false to log exception traces as a sub documents instead of strings

Definition at line 30 of file MongoDBFormatter.php.

References Monolog\Formatter\MongoDBFormatter\$exceptionTraceAsString, and Monolog\Formatter\MongoDBFormatter\$maxNestingLevel.

    {
        $this->maxNestingLevel = max($maxNestingLevel, 0);
        $this->exceptionTraceAsString = (bool) $exceptionTraceAsString;
    }

Member Function Documentation

format()

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

References Monolog\Formatter\MongoDBFormatter\formatArray().

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

formatArray()

Monolog\Formatter\MongoDBFormatter::formatArray ( array  $record,   $nestingLevel = 0  )

protected

Definition at line 56 of file MongoDBFormatter.php.

References $name, Monolog\Formatter\MongoDBFormatter\formatDate(), Monolog\Formatter\MongoDBFormatter\formatException(), and Monolog\Formatter\MongoDBFormatter\formatObject().

Referenced by Monolog\Formatter\MongoDBFormatter\format(), Monolog\Formatter\MongoDBFormatter\formatException(), and Monolog\Formatter\MongoDBFormatter\formatObject().

    {
        if ($this->maxNestingLevel == 0 || $nestingLevel <= $this->maxNestingLevel) {
            foreach ($record as $name => $value) {
                if ($value instanceof \DateTime) {
                    $record[$name] = $this->formatDate($value, $nestingLevel + 1);
                } elseif ($value instanceof \Exception) {
                    $record[$name] = $this->formatException($value, $nestingLevel + 1);
                } elseif (is_array($value)) {
                    $record[$name] = $this->formatArray($value, $nestingLevel + 1);
                } elseif (is_object($value)) {
                    $record[$name] = $this->formatObject($value, $nestingLevel + 1);
                }
            }
        } else {
            $record = '[...]';
        }

        return $record;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

formatBatch()

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

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

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

        return $records;
    }

Here is the call graph for this function:

formatDate()

Monolog\Formatter\MongoDBFormatter::formatDate ( \DateTime  $value,   $nestingLevel  )

protected

Definition at line 103 of file MongoDBFormatter.php.

Referenced by Monolog\Formatter\MongoDBFormatter\formatArray().

    {
        return new \MongoDate($value->getTimestamp());
    }

Here is the caller graph for this function:

formatException()

Monolog\Formatter\MongoDBFormatter::formatException ( \Exception  $exception,   $nestingLevel  )

protected

Definition at line 85 of file MongoDBFormatter.php.

References Monolog\Formatter\MongoDBFormatter\formatArray(), and Monolog\Utils\getClass().

Referenced by Monolog\Formatter\MongoDBFormatter\formatArray().

    {
        $formattedException = array(
            'class' => Utils::getClass($exception),
            'message' => $exception->getMessage(),
            'code' => $exception->getCode(),
            'file' => $exception->getFile() . ':' . $exception->getLine(),
        );

        if ($this->exceptionTraceAsString === true) {
            $formattedException['trace'] = $exception->getTraceAsString();
        } else {
            $formattedException['trace'] = $exception->getTrace();
        }

        return $this->formatArray($formattedException, $nestingLevel);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

formatObject()

Monolog\Formatter\MongoDBFormatter::formatObject (   $value,   $nestingLevel  )

protected

Definition at line 77 of file MongoDBFormatter.php.

References Monolog\Formatter\MongoDBFormatter\formatArray(), and Monolog\Utils\getClass().

Referenced by Monolog\Formatter\MongoDBFormatter\formatArray().

    {
        $objectVars = get_object_vars($value);
        $objectVars['class'] = Utils::getClass($value);

        return $this->formatArray($objectVars, $nestingLevel);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$exceptionTraceAsString

Monolog\Formatter\MongoDBFormatter::$exceptionTraceAsString

private

Definition at line 23 of file MongoDBFormatter.php.

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

$maxNestingLevel

Monolog\Formatter\MongoDBFormatter::$maxNestingLevel

private

Definition at line 24 of file MongoDBFormatter.php.

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

---

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

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