Magento 2 Documentation  2.3
Documentation for Magento 2 CMS v2.3 (December 2018)
Public Member Functions | Protected Member Functions | Static Protected Member Functions | Protected Attributes
Zend_Log_Writer_Abstract Class Reference
Inheritance diagram for Zend_Log_Writer_Abstract:
Zend_Log_FactoryInterface Zend_Log_Writer_Db Zend_Log_Writer_Mock Zend_Log_Writer_Null Zend_Log_Writer_Stream Zend_Log_Writer_Syslog Zend_Log_Writer_ZendMonitor

Public Member Functions

 addFilter ($filter)
 
 setFormatter (Zend_Log_Formatter_Interface $formatter)
 
 shutdown ()
 

Protected Member Functions

 _write ($event)
 

Static Protected Member Functions

static _parseConfig ($config)
 

Protected Attributes

 $_filters = array()
 
 $_formatter
 

Additional Inherited Members

- Static Public Member Functions inherited from Zend_Log_FactoryInterface
static factory ($config)
 

Detailed Description

Definition at line 34 of file Abstract.php.

Member Function Documentation

◆ _parseConfig()

static _parseConfig (   $config)
staticprotected

Validate and optionally convert the config to array

Parameters
array | Zend_Config$configZend_Config or Array
Returns
array
Exceptions
Zend_Log_Exception

Definition at line 126 of file Abstract.php.

127  {
128  if ($config instanceof Zend_Config) {
129  $config = $config->toArray();
130  }
131 
132  if (!is_array($config)) {
133  #require_once 'Zend/Log/Exception.php';
134  throw new Zend_Log_Exception(
135  'Configuration must be an array or instance of Zend_Config'
136  );
137  }
138 
139  return $config;
140  }
$config
Definition: fraud_order.php:17

◆ _write()

_write (   $event)
abstractprotected

Write a message to the log.

Parameters
array$eventlog data event
Returns
void

◆ addFilter()

addFilter (   $filter)

Add a filter specific to this writer.

Parameters
Zend_Log_Filter_Interface | int$filterFilter class or filter priority
Returns
Zend_Log_Writer_Abstract
Exceptions
Zend_Log_Exception
See also
Zend_Log_Exception

Definition at line 56 of file Abstract.php.

57  {
58  if (is_int($filter)) {
59  $filter = new Zend_Log_Filter_Priority($filter);
60  }
61 
62  if (!$filter instanceof Zend_Log_Filter_Interface) {
64  #require_once 'Zend/Log/Exception.php';
65  throw new Zend_Log_Exception('Invalid filter provided');
66  }
67 
68  $this->_filters[] = $filter;
69  return $this;
70  }

◆ setFormatter()

setFormatter ( Zend_Log_Formatter_Interface  $formatter)

Set a new formatter for this writer

Parameters
Zend_Log_Formatter_Interface$formatter
Returns
Zend_Log_Writer_Abstract

Definition at line 97 of file Abstract.php.

98  {
99  $this->_formatter = $formatter;
100  return $this;
101  }

◆ shutdown()

shutdown ( )

Perform shutdown activites such as closing open resources

Returns
void

Definition at line 108 of file Abstract.php.

109  {}

Field Documentation

◆ $_filters

$_filters = array()
protected

Definition at line 39 of file Abstract.php.

◆ $_formatter

$_formatter
protected

Definition at line 46 of file Abstract.php.


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