Zend_Log_Formatter_Simple Class Reference

Inheritance diagram for Zend_Log_Formatter_Simple:

Public Member Functions
	__construct ($format=null)
	format ($event)

Static Public Member Functions
static	factory ($options)

Data Fields
const	DEFAULT_FORMAT = '%timestamp% %priorityName% (%priority%): %message%'

Protected Attributes
	$_format

Detailed Description

Definition at line 34 of file Simple.php.

Constructor & Destructor Documentation

__construct()

__construct

(

$format = null

)

Class constructor

Parameters

null | string

$format

Format specifier for log messages

Returns

void

Exceptions

Zend_Log_Exception

Definition at line 50 of file Simple.php.

    {
        if ($format === null) {
            $format = self::DEFAULT_FORMAT . PHP_EOL;
        }

        if (!is_string($format)) {
            #require_once 'Zend/Log/Exception.php';
            throw new Zend_Log_Exception('Format must be a string');
        }

        $this->_format = $format;
    }

Member Function Documentation

factory()

static factory (   $options )

static

Factory for Zend_Log_Formatter_Simple classe

Parameters

array | Zend_Config

$options

Returns

Zend_Log_Formatter_Simple

Implements Zend_Log_FactoryInterface.

Definition at line 70 of file Simple.php.

    {
        $format = null;
        if (null !== $options) {
            if ($options instanceof Zend_Config) {
                $options = $options->toArray();
            }

            if (array_key_exists('format', $options)) {
                $format = $options['format'];
            }
        }

        return new self($format);
    }

format()

format

(

$event

)

Formats data into a single line to be written by the writer.

Parameters

array

$event

event data

Returns

string formatted line to write to the log

Implements Zend_Log_Formatter_Interface.

Definition at line 92 of file Simple.php.

    {
        $output = $this->_format;

        foreach ($event as $name => $value) {
            if ((is_object($value) && !method_exists($value,'__toString'))
                || is_array($value)
            ) {
                $value = gettype($value);
            }

            $output = str_replace("%$name%", $value, $output);
        }

        return $output;
    }

Field Documentation

$_format

$_format

protected

Definition at line 39 of file Simple.php.

DEFAULT_FORMAT

const DEFAULT_FORMAT = '%timestamp% %priorityName% (%priority%): %message%'

Definition at line 41 of file Simple.php.

---

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

• vendor/magento/zendframework1/library/Zend/Log/Formatter/Simple.php