GenerationErrorsHandler.md

BumbleDocGen / Technical description of the project / Class map / GenerationErrorsHandler

---

GenerationErrorsHandler class:

namespace BumbleDocGen\Core\Logger\Handler;

final class GenerationErrorsHandler extends \Monolog\Handler\AbstractProcessingHandler

Base Handler class providing the Handler structure, including processors and formatters

Initialization methods:

1. __construct

Methods:

1. __destruct
2. __sleep
3. addRecords
4. close - Closes the handler.
5. getBubble - Gets the bubbling behavior.
6. getFormatter - {@inheritDoc}
7. getLevel - Gets minimum logging level at which this handler will be triggered.
8. getRecords
9. handle - Handles a record.
10. handleBatch - Handles a set of records at once.
11. isHandling - Checks whether the given record will be handled by this handler.
12. popProcessor - {@inheritDoc}
13. pushProcessor - {@inheritDoc}
14. reset
15. setBubble - Sets the bubbling behavior.
16. setFormatter - {@inheritDoc}
17. setLevel - Sets minimum logging level at which this handler will be triggered.

Method details:

• # __construct | source code

public function __construct(\BumbleDocGen\Core\Renderer\Context\RendererContext $rendererContext, int|string $level = \Monolog\Logger::WARNING, bool $bubble = true);

Parameters:

Name	Type	Description
$rendererContext	\BumbleDocGen\Core\Renderer\Context\RendererContext	-
$level	int | string	The minimum logging level at which this handler will be triggered
$bubble	bool	Whether the messages that are handled can bubble up the stack or not

---

• # __destruct | source code

// Implemented in Monolog\Handler\Handler

public function __destruct(): mixed;

Parameters: not specified

Return value: mixed

---

• # __sleep | source code

// Implemented in Monolog\Handler\Handler

public function __sleep(): mixed;

Parameters: not specified

Return value: mixed

---

• # addRecords | source code

public function addRecords(array $records): void;

Parameters:

Name	Type	Description
$records	array	-

Return value: void

---

• # close | source code

// Implemented in Monolog\Handler\Handler

public function close(): void;

Closes the handler.

Parameters: not specified

Return value: void

---

• # getBubble | source code

// Implemented in Monolog\Handler\AbstractHandler

public function getBubble(): bool;

Gets the bubbling behavior.

Parameters: not specified

Return value: bool

---

• # getFormatter | source code

// Implemented in Monolog\Handler\FormattableHandlerTrait

public function getFormatter(): \Monolog\Formatter\FormatterInterface;

{@inheritDoc}

Parameters: not specified

Return value: \Monolog\Formatter\FormatterInterface

---

• # getLevel | source code

// Implemented in Monolog\Handler\AbstractHandler

public function getLevel(): int;

Gets minimum logging level at which this handler will be triggered.

Parameters: not specified

Return value: int

---

• # getRecords | source code

public function getRecords(): array;

Parameters: not specified

Return value: array

---

• # handle | source code

// Implemented in Monolog\Handler\AbstractProcessingHandler

public function handle(array $record): bool;

Handles a record.

Parameters:

Name	Type	Description
$record	array	The record to handle

Return value: bool

---

• # handleBatch | source code

// Implemented in Monolog\Handler\Handler

public function handleBatch(array $records): void;

Handles a set of records at once.

Parameters:

Name	Type	Description
$records	array	The records to handle (an array of record arrays)

Return value: void

---

• # isHandling | source code

// Implemented in Monolog\Handler\AbstractHandler

public function isHandling(array $record): bool;

Checks whether the given record will be handled by this handler.

Parameters:

Name	Type	Description
$record	array	Partial log record containing only a level key

Return value: bool

---

• # popProcessor | source code

// Implemented in Monolog\Handler\ProcessableHandlerTrait

public function popProcessor(): callable;

{@inheritDoc}

Parameters: not specified

Return value: callable

---

• # pushProcessor | source code

// Implemented in Monolog\Handler\ProcessableHandlerTrait

public function pushProcessor(callable $callback): \Monolog\Handler\HandlerInterface;

{@inheritDoc}

Parameters:

Name	Type	Description
$callback	callable	-

Return value: \Monolog\Handler\HandlerInterface

---

• # reset | source code

// Implemented in Monolog\Handler\AbstractProcessingHandler

public function reset(): void;

Parameters: not specified

Return value: void

---

• # setBubble | source code

// Implemented in Monolog\Handler\AbstractHandler

public function setBubble(bool $bubble): self;

Sets the bubbling behavior.

Parameters:

Name	Type	Description
$bubble	bool	true means that this handler allows bubbling. false means that bubbling is not permitted.

Return value: self

---

• # setFormatter | source code

// Implemented in Monolog\Handler\FormattableHandlerTrait

public function setFormatter(\Monolog\Formatter\FormatterInterface $formatter): \Monolog\Handler\HandlerInterface;

{@inheritDoc}

Parameters:

Name	Type	Description
$formatter	\Monolog\Formatter\FormatterInterface	-

Return value: \Monolog\Handler\HandlerInterface

---

• # setLevel | source code

// Implemented in Monolog\Handler\AbstractHandler

public function setLevel(\Monolog\Handler\Level|\Monolog\Handler\LevelName|\Psr\Log\LogLevel::* $level): self;

Sets minimum logging level at which this handler will be triggered.

Parameters:

Name	Type	Description
$level	\Monolog\Handler\Level | \Monolog\Handler\LevelName | \Psr\Log\LogLevel::*	Level or level name

Return value: self

---