ILIAS  release_5-1 Revision 5.0.0-5477-g43f3e3fab5
Monolog\Handler\ErrorLogHandler Class Reference

Stores to PHP error_log() handler. More...

+ Inheritance diagram for Monolog\Handler\ErrorLogHandler:
+ Collaboration diagram for Monolog\Handler\ErrorLogHandler:

Public Member Functions

 __construct ($messageType=self::OPERATING_SYSTEM, $level=Logger::DEBUG, $bubble=true, $expandNewlines=false)
 
- Public Member Functions inherited from Monolog\Handler\AbstractProcessingHandler
 handle (array $record)
 {Handles a record.All records may be passed to this method, and the handler should discard those that it does not want to handle.The return value of this function controls the bubbling process of the handler stack. Unless the bubbling is interrupted (by returning true), the Logger class will keep on calling further handlers in the stack with a given log record.
Parameters
array$recordThe record to handle
Returns
Boolean true means that this handler handled the record, and that bubbling is not permitted. false means the record was either not processed or that this handler allows bubbling.
} More...
 
- Public Member Functions inherited from Monolog\Handler\AbstractHandler
 __construct ($level=Logger::DEBUG, $bubble=true)
 
 isHandling (array $record)
 {Checks whether the given record will be handled by this handler.This is mostly done for performance reasons, to avoid calling processors for nothing.Handlers should still check the record levels within handle(), returning false in isHandling() is no guarantee that handle() will not be called, and isHandling() might not be called for a given record.
Parameters
array$recordPartial log record containing only a level key
Returns
Boolean
} More...
 
 handleBatch (array $records)
 {Handles a set of records at once.
Parameters
array$recordsThe records to handle (an array of record arrays)
} More...
 
 close ()
 Closes the handler. More...
 
 pushProcessor ($callback)
 {Adds a processor in the stack.
Parameters
callable$callback
Returns
self
} More...
 
 popProcessor ()
 {Removes the processor on top of the stack and returns it.
Returns
callable
} More...
 
 setFormatter (FormatterInterface $formatter)
 {Sets the formatter.
Parameters
FormatterInterface$formatter
Returns
self
} More...
 
 getFormatter ()
 {Gets the formatter.
Returns
FormatterInterface
} More...
 
 setLevel ($level)
 Sets minimum logging level at which this handler will be triggered. More...
 
 getLevel ()
 Gets minimum logging level at which this handler will be triggered. More...
 
 setBubble ($bubble)
 Sets the bubbling behavior. More...
 
 getBubble ()
 Gets the bubbling behavior. More...
 
 __destruct ()
 

Static Public Member Functions

static getAvailableTypes ()
 

Data Fields

const OPERATING_SYSTEM = 0
 
const SAPI = 4
 

Protected Member Functions

 getDefaultFormatter ()
 
 write (array $record)
 {} More...
 
- Protected Member Functions inherited from Monolog\Handler\AbstractProcessingHandler
 write (array $record)
 Writes the record down to the log of the implementing handler. More...
 
 processRecord (array $record)
 Processes a record. More...
 
- Protected Member Functions inherited from Monolog\Handler\AbstractHandler
 getDefaultFormatter ()
 Gets the default formatter. More...
 

Protected Attributes

 $messageType
 
 $expandNewlines
 
- Protected Attributes inherited from Monolog\Handler\AbstractHandler
 $level = Logger::DEBUG
 
 $bubble = true
 
 $formatter
 
 $processors = array()
 

Detailed Description

Stores to PHP error_log() handler.

Author
Elan Ruusamäe glen@.nosp@m.delf.nosp@m.i.ee

Definition at line 22 of file ErrorLogHandler.php.

Constructor & Destructor Documentation

◆ __construct()

Monolog\Handler\ErrorLogHandler::__construct (   $messageType = self::OPERATING_SYSTEM,
  $level = Logger::DEBUG,
  $bubble = true,
  $expandNewlines = false 
)
Parameters
integer$messageTypeSays where the error should go.
integer$levelThe minimum logging level at which this handler will be triggered
Boolean$bubbleWhether the messages that are handled can bubble up the stack or not
Boolean$expandNewlinesIf set to true, newlines in the message will be expanded to be take multiple log entries

Definition at line 36 of file ErrorLogHandler.php.

References Monolog\Handler\AbstractHandler\$bubble, Monolog\Handler\ErrorLogHandler\$expandNewlines, Monolog\Handler\AbstractHandler\$level, and Monolog\Handler\ErrorLogHandler\$messageType.

37  {
38  parent::__construct($level, $bubble);
39 
40  if (false === in_array($messageType, self::getAvailableTypes())) {
41  $message = sprintf('The given message type "%s" is not supported', print_r($messageType, true));
42  throw new \InvalidArgumentException($message);
43  }
44 
45  $this->messageType = $messageType;
46  $this->expandNewlines = $expandNewlines;
47  }

Member Function Documentation

◆ getAvailableTypes()

static Monolog\Handler\ErrorLogHandler::getAvailableTypes ( )
static
Returns
array With all available types

Definition at line 52 of file ErrorLogHandler.php.

53  {
54  return array(
55  self::OPERATING_SYSTEM,
56  self::SAPI,
57  );
58  }

◆ getDefaultFormatter()

Monolog\Handler\ErrorLogHandler::getDefaultFormatter ( )
protected

Definition at line 63 of file ErrorLogHandler.php.

64  {
65  return new LineFormatter('[%datetime%] %channel%.%level_name%: %message% %context% %extra%');
66  }

◆ write()

Monolog\Handler\ErrorLogHandler::write ( array  $record)
protected

{}

Definition at line 71 of file ErrorLogHandler.php.

References Monolog\Handler\error_log().

72  {
73  if ($this->expandNewlines) {
74  $lines = preg_split('{[\r\n]+}', (string) $record['formatted']);
75  foreach ($lines as $line) {
76  error_log($line, $this->messageType);
77  }
78  } else {
79  error_log((string) $record['formatted'], $this->messageType);
80  }
81  }
+ Here is the call graph for this function:

Field Documentation

◆ $expandNewlines

Monolog\Handler\ErrorLogHandler::$expandNewlines
protected

Definition at line 28 of file ErrorLogHandler.php.

Referenced by Monolog\Handler\ErrorLogHandler\__construct().

◆ $messageType

Monolog\Handler\ErrorLogHandler::$messageType
protected

Definition at line 27 of file ErrorLogHandler.php.

Referenced by Monolog\Handler\ErrorLogHandler\__construct().

◆ OPERATING_SYSTEM

const Monolog\Handler\ErrorLogHandler::OPERATING_SYSTEM = 0

◆ SAPI

const Monolog\Handler\ErrorLogHandler::SAPI = 4

Definition at line 25 of file ErrorLogHandler.php.


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