Documentation

StreamHandler extends AbstractProcessingHandler
in package

Stores to any stream resource

Can be used to store into php://stderr, remote and local files, etc.

Tags
author

Jordi Boggiano j.boggiano@seld.be

phpstan-import-type

FormattedRecord from AbstractProcessingHandler

Table of Contents

Constants

DEFAULT_CHUNK_SIZE  = 10 * 1024 * 1024
MAX_CHUNK_SIZE  = 2147483647

Properties

$bubble  : bool
$fileOpenMode  : string
$filePermission  : int|null
$formatter  : FormatterInterface|null
$level  : int
$processors  : array<string|int, callable>
$stream  : resource|null
$streamChunkSize  : int
$url  : string|null
$useLocking  : bool
$dirCreated  : true|null
$errorMessage  : string|null
$retrying  : bool

Methods

__construct()  : mixed
__destruct()  : mixed
__sleep()  : mixed
close()  : void
Closes the handler.
getBubble()  : bool
Gets the bubbling behavior.
getFormatter()  : FormatterInterface
{@inheritDoc}
getLevel()  : int
Gets minimum logging level at which this handler will be triggered.
getStream()  : resource|null
Return the currently active stream if it is open
getStreamChunkSize()  : int
getUrl()  : string|null
Return the stream URL if it was configured with a URL and not an active resource
handle()  : bool
Handles a record.
handleBatch()  : void
Handles a set of records at once.
isHandling()  : bool
Checks whether the given record will be handled by this handler.
popProcessor()  : callable
{@inheritDoc}
pushProcessor()  : HandlerInterface
{@inheritDoc}
reset()  : void
setBubble()  : self
Sets the bubbling behavior.
setFormatter()  : HandlerInterface
{@inheritDoc}
setLevel()  : self
Sets minimum logging level at which this handler will be triggered.
getDefaultFormatter()  : FormatterInterface
Gets the default formatter.
processRecord()  : array<string|int, mixed>
Processes a record.
resetProcessors()  : void
streamWrite()  : void
Write to stream
write()  : void
Writes the record down to the log of the implementing handler
createDir()  : void
customErrorHandler()  : bool
getDirFromStream()  : string|null

Constants

DEFAULT_CHUNK_SIZE

protected mixed DEFAULT_CHUNK_SIZE = 10 * 1024 * 1024
Tags
const

int 10MB

MAX_CHUNK_SIZE

protected mixed MAX_CHUNK_SIZE = 2147483647
Tags
const

int

Properties

$level

protected int $level = \Monolog\Logger::DEBUG
Tags
phpstan-var

Level

$processors

protected array<string|int, callable> $processors = []
Tags
phpstan-var

array<ProcessorInterface|callable(Record): Record>

Methods

__construct()

public __construct(resource|string $stream[, mixed $level = Logger::DEBUG ][, bool $bubble = true ][, int|null $filePermission = null ][, bool $useLocking = false ][, string $fileOpenMode = 'a' ]) : mixed
Parameters
$stream : resource|string

If a missing path can't be created, an UnexpectedValueException will be thrown on first write

$level : mixed = Logger::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

$filePermission : int|null = null

Optional file permissions (default (0644) are only for owner read/write)

$useLocking : bool = false

Try to lock log file before doing any writes

$fileOpenMode : string = 'a'

The fopen() mode used when opening a file, if $stream is a file path

Tags
throws
InvalidArgumentException

If stream is not a resource or string

__destruct()

public __destruct() : mixed

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() : int
Tags
phpstan-return

Level

Return values
int

getStream()

Return the currently active stream if it is open

public getStream() : resource|null
Return values
resource|null

getStreamChunkSize()

public getStreamChunkSize() : int
Return values
int

getUrl()

Return the stream URL if it was configured with a URL and not an active resource

public getUrl() : string|null
Return values
string|null

handle()

Handles a record.

public handle(array<string|int, mixed> $record) : bool
Parameters
$record : array<string|int, mixed>

The record to handle

Return values
bool —

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.

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 (an array of record arrays)

isHandling()

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

public isHandling(array<string|int, mixed> $record) : bool
Parameters
$record : array<string|int, mixed>

Partial log record containing only a level key

Return values
bool

setBubble()

Sets the bubbling behavior.

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

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

Return values
self

setLevel()

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

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

Level or level name

Return values
self

processRecord()

Processes a record.

protected processRecord(array<string|int, mixed> $record) : array<string|int, mixed>
Parameters
$record : array<string|int, mixed>
Tags
phpstan-param

Record $record

phpstan-return

Record

Return values
array<string|int, mixed>

streamWrite()

Write to stream

protected streamWrite(resource $stream, array<string|int, mixed> $record) : void
Parameters
$stream : resource
$record : array<string|int, mixed>
Tags
phpstan-param

FormattedRecord $record

write()

Writes the record down to the log of the implementing handler

protected write(array<string|int, mixed> $record) : void
Parameters
$record : array<string|int, mixed>

createDir()

private createDir(string $url) : void
Parameters
$url : string

customErrorHandler()

private customErrorHandler(int $code, string $msg) : bool
Parameters
$code : int
$msg : string
Return values
bool

getDirFromStream()

private getDirFromStream(string $stream) : string|null
Parameters
$stream : string
Return values
string|null 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results