Plop
A simple logging library for PHP
Plop\RecordInterface Interface Reference

Interface for a log record. More...

+ Inheritance diagram for Plop\RecordInterface:

Public Member Functions

 asArray ()
 
 getInterpolator ()
 
 getMessage ()
 
 setInterpolator (\Plop\InterpolatorInterface $interpolator)
 
- Public Member Functions inherited from ArrayAccess
 offsetExists ($offset)
 
 offsetGet ($offset)
 
 offsetSet ($offset, $value)
 
 offsetUnset ($offset)
 

Detailed Description

Interface for a log record.

The log record may be used like an (associative) array to add/remove/change its contents. You may also call the asArray() method to get a true array.

Definition at line 31 of file RecordInterface.php.

Member Function Documentation

Plop\RecordInterface::asArray ( )

The properties of this log record, as an associative array.

Return values
arrayAn associative array with the properties of this log record.

Implemented in Plop\Record.

Plop\RecordInterface::getInterpolator ( )

Return this record's message interpolator.

Return values
Plop::InterpolatorInterfaceMessage interpolator.

Implemented in Plop\Record.

Plop\RecordInterface::getMessage ( )

Return the message stored in this log record, after all interpolated variables have been replaced in it.

Return values
stringThe message stored in the log record.

Implemented in Plop\Record.

Plop\RecordInterface::setInterpolator ( \Plop\InterpolatorInterface  $interpolator)

Set the message interpolator for this record.

Parameters
Plop::InterpolatorInterface$interpolatorMessage interpolator to use.
Return values
Plop::RecordInterfaceThe record (ie. $this).

Implemented in Plop\Record.


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