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

Table of Contents

Properties

$bubble  : mixed
$filePermission  : mixed
$formatter  : FormatterInterface
$level  : mixed
$processors  : mixed
$stream  : mixed
$url  : mixed
$useLocking  : mixed
$dirCreated  : mixed
$errorMessage  : mixed

Methods

__construct()  : mixed
__destruct()  : mixed
close()  : mixed
Closes the handler.
getBubble()  : bool
Gets the bubbling behavior.
getFormatter()  : FormatterInterface
Gets the formatter.
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
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()  : mixed
Handles a set of records at once.
isHandling()  : bool
Checks whether the given record will be handled by this handler.
popProcessor()  : callable
Removes the processor on top of the stack and returns it.
pushProcessor()  : self
Adds a processor in the stack.
reset()  : mixed
setBubble()  : self
Sets the bubbling behavior.
setFormatter()  : self
Sets the formatter.
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.
streamWrite()  : mixed
Write to stream
write()  : void
Writes the record down to the log of the implementing handler
createDir()  : mixed
customErrorHandler()  : mixed
getDirFromStream()  : null|string

Properties

Methods

__construct()

public __construct(resource|string $stream[, int $level = Logger::DEBUG ][, bool $bubble = true ][, int|null $filePermission = null ][, bool $useLocking = false ]) : mixed
Parameters
$stream : resource|string
$level : int = 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

Tags
throws
Exception

If a missing directory is not buildable

throws
InvalidArgumentException

If stream is not a resource or string

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
Return values
int

getStream()

Return the currently active stream if it is open

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

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) : mixed
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

popProcessor()

Removes the processor on top of the stack and returns it.

public popProcessor() : callable
Return values
callable

pushProcessor()

Adds a processor in the stack.

public pushProcessor(mixed $callback) : self
Parameters
$callback : mixed
Return values
self

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(int|string $level) : self
Parameters
$level : int|string

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>
Return values
array<string|int, mixed>

streamWrite()

Write to stream

protected streamWrite(resource $stream, array<string|int, mixed> $record) : mixed
Parameters
$stream : resource
$record : array<string|int, mixed>

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>

customErrorHandler()

private customErrorHandler(mixed $code, mixed $msg) : mixed
Parameters
$code : mixed
$msg : mixed

getDirFromStream()

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

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results