ILIAS  release_5-2 Revision v5.2.25-18-g3f80b82851
Monolog\Handler\MailHandler Class Reference

Base class for all mail handlers. More...

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

Public Member Functions

 handleBatch (array $records)
 {Handles a set of records at once.
Parameters
array$recordsThe records to handle (an array of record arrays)
} More...
 
- 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 ()
 

Protected Member Functions

 send ($content, array $records)
 Send a mail with the given content. More...
 
 write (array $record)
 {} More...
 
 getHighestRecord (array $records)
 
- 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...
 

Additional Inherited Members

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

Detailed Description

Base class for all mail handlers.

Author
Gyula Sallai

Definition at line 19 of file MailHandler.php.

Member Function Documentation

◆ getHighestRecord()

Monolog\Handler\MailHandler::getHighestRecord ( array  $records)
protected

Definition at line 56 of file MailHandler.php.

Referenced by Monolog\Handler\NativeMailerHandler\send().

57  {
58  $highestRecord = null;
59  foreach ($records as $record) {
60  if ($highestRecord === null || $highestRecord['level'] < $record['level']) {
61  $highestRecord = $record;
62  }
63  }
64 
65  return $highestRecord;
66  }
$records
Definition: simple_test.php:22
+ Here is the caller graph for this function:

◆ handleBatch()

Monolog\Handler\MailHandler::handleBatch ( array  $records)

{Handles a set of records at once.

Parameters
array$recordsThe records to handle (an array of record arrays)
}

Implements Monolog\Handler\HandlerInterface.

Definition at line 24 of file MailHandler.php.

References $messages, $records, array, Monolog\Handler\AbstractHandler\getFormatter(), Monolog\Handler\AbstractProcessingHandler\processRecord(), and Monolog\Handler\MailHandler\send().

25  {
26  $messages = array();
27 
28  foreach ($records as $record) {
29  if ($record['level'] < $this->level) {
30  continue;
31  }
32  $messages[] = $this->processRecord($record);
33  }
34 
35  if (!empty($messages)) {
36  $this->send((string) $this->getFormatter()->formatBatch($messages), $messages);
37  }
38  }
$records
Definition: simple_test.php:22
send($content, array $records)
Send a mail with the given content.
getFormatter()
{Gets the formatter.FormatterInterface}
Create styles array
The data for the language used.
processRecord(array $record)
Processes a record.
$messages
Definition: en-x-test.php:7
+ Here is the call graph for this function:

◆ send()

Monolog\Handler\MailHandler::send (   $content,
array  $records 
)
abstractprotected

Send a mail with the given content.

Parameters
string$contentformatted email body to be sent
array$recordsthe array of log records that formed this content

Referenced by Monolog\Handler\MailHandler\handleBatch(), and Monolog\Handler\MailHandler\write().

+ Here is the caller graph for this function:

◆ write()

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

{}

Definition at line 51 of file MailHandler.php.

References array, and Monolog\Handler\MailHandler\send().

52  {
53  $this->send((string) $record['formatted'], array($record));
54  }
send($content, array $records)
Send a mail with the given content.
Create styles array
The data for the language used.
+ Here is the call graph for this function:

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