Documentation

AbstractHandler extends Handler
in package
implements ResettableInterface

AbstractYes

Base Handler class providing basic level/bubble support

Tags
author

Jordi Boggiano j.boggiano@seld.be

Table of Contents

Interfaces

ResettableInterface
Handler or Processor implementing this interface will be reset when Logger::reset() is called.

Properties

$bubble  : bool
$level  : Level

Methods

__construct()  : mixed
__destruct()  : mixed
__sleep()  : mixed
close()  : void
Closes the handler.
getBubble()  : bool
Gets the bubbling behavior.
getLevel()  : Level
Gets minimum logging level at which this handler will be triggered.
handleBatch()  : void
Handles a set of records at once.
isHandling()  : bool
Checks whether the given record will be handled by this handler.
reset()  : void
setBubble()  : $this
Sets the bubbling behavior.
setLevel()  : $this
Sets minimum logging level at which this handler will be triggered.

Properties

Methods

__construct()

public __construct([int|string|Level|LogLevel::* $level = Level::Debug ][, bool $bubble = true ]) : mixed
Parameters
$level : int|string|Level|LogLevel::* = Level::Debug

The minimum logging level at which this handler will be triggered

$bubble : bool = true

Whether the messages that are handled can bubble up the stack or not

Tags
phpstan-param

value-ofLevel::VALUES|value-ofLevel::NAMES|Level|LogLevel::* $level

__destruct()

public __destruct() : mixed

close()

Closes the handler.

public close() : void
Tags
inheritDoc

getBubble()

Gets the bubbling behavior.

public getBubble() : bool
Return values
bool

true means that this handler allows bubbling. false means that bubbling is not permitted.

getLevel()

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

public getLevel() : Level
Return values
Level

handleBatch()

Handles a set of records at once.

public handleBatch(array<string|int, mixed> $records) : void
Parameters
$records : array<string|int, mixed>

The records to handle

Tags
inheritDoc

isHandling()

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

public isHandling(LogRecord $record) : bool
Parameters
$record : LogRecord

Partial log record having only a level initialized

Tags
inheritDoc
Return values
bool

setBubble()

Sets the bubbling behavior.

public setBubble(bool $bubble) : $this
Parameters
$bubble : bool

true means that this handler allows bubbling. false means that bubbling is not permitted.

Return values
$this

setLevel()

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

public setLevel(Level|LogLevel::* $level) : $this
Parameters
$level : Level|LogLevel::*

Level or level name

Tags
phpstan-param

value-ofLevel::VALUES|value-ofLevel::NAMES|Level|LogLevel::* $level

Return values
$this

        
On this page

Search results