Menu

## StreamHandler extends AbstractProcessingHandler
in package

StreamHandler.php : 24

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

$bubble : mixed
$filePermission : mixed
$formatter : FormatterInterface
$level : mixed
$processors : mixed
$stream : mixed
$url : mixed
$useLocking : mixed
$dirCreated : mixed
$errorMessage : mixed
__construct() : mixed
__destruct() : mixed
close() : mixed
  {@inheritdoc}
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() : mixed
  {@inheritdoc}
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

#### $bubble

AbstractHandler.php : 27
`protected mixed $bubble = true`

#### $filePermission

StreamHandler.php : 29
`protected mixed $filePermission`

#### $formatter

AbstractHandler.php : 32
`protected FormatterInterface $formatter`

#### $level

AbstractHandler.php : 26
`protected mixed $level = MonologLogger::DEBUG`

#### $processors

AbstractHandler.php : 33
`protected mixed $processors = array()`

#### $stream

StreamHandler.php : 26
`protected mixed $stream`

#### $url

StreamHandler.php : 27
`protected mixed $url`

#### $useLocking

StreamHandler.php : 30
`protected mixed $useLocking`

#### $dirCreated

StreamHandler.php : 31
`private mixed $dirCreated`

#### $errorMessage

StreamHandler.php : 28
`private mixed $errorMessage`

### Methods

#### __construct()

StreamHandler.php : 43
`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

##### Return values

mixed —

#### __destruct()

AbstractHandler.php : 167
`public __destruct() : mixed`

##### Return values

mixed —

#### close()

StreamHandler.php : 61

{@inheritdoc}

`public close() : mixed`

##### Return values

mixed —

#### getBubble()

AbstractHandler.php : 162

Gets the bubbling behavior.

`public getBubble() : bool`

##### Return values

bool —

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

#### getFormatter()

AbstractHandler.php : 110

Gets the formatter.

`public getFormatter() : FormatterInterface`

##### Return values

FormatterInterface —

#### getLevel()

AbstractHandler.php : 137

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

`public getLevel() : int`

##### Return values

int —

#### getStream()

StreamHandler.php : 75

Return the currently active stream if it is open

`public getStream() : resource|null`

##### Return values

resource|null —

#### getUrl()

StreamHandler.php : 85

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()

AbstractProcessingHandler.php : 29

{@inheritdoc}

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

##### Parameters

$record : array<string|int, mixed>

##### Return values

mixed —

#### handleBatch()

AbstractHandler.php : 56

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)

##### Return values

mixed —

#### isHandling()

AbstractHandler.php : 48

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()

AbstractHandler.php : 88

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

`public popProcessor() : callable`

##### Return values

callable —

#### pushProcessor()

AbstractHandler.php : 75

Adds a processor in the stack.

`public pushProcessor(mixed $callback) : self`

##### Parameters

$callback : mixed

##### Return values

self —

#### reset()

AbstractHandler.php : 178
`public reset() : mixed`

##### Return values

mixed —

#### setBubble()

AbstractHandler.php : 149

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 —

#### setFormatter()

AbstractHandler.php : 100

Sets the formatter.

`public setFormatter(FormatterInterface $formatter) : self`

##### Parameters

$formatter : FormatterInterface

##### Return values

self —

#### setLevel()

AbstractHandler.php : 125

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 —

#### getDefaultFormatter()

AbstractHandler.php : 192

Gets the default formatter.

`protected getDefaultFormatter() : FormatterInterface`

##### Return values

FormatterInterface —

#### processRecord()

AbstractProcessingHandler.php : 58

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()

StreamHandler.php : 131

Write to stream

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

##### Parameters

$stream : resource
$record : array<string|int, mixed>

##### Return values

mixed —

#### write()

StreamHandler.php : 93

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>

##### Return values

void —

#### createDir()

StreamHandler.php : 160
`private createDir() : mixed`

##### Return values

mixed —

#### customErrorHandler()

StreamHandler.php : 136
`private customErrorHandler(mixed $code, mixed $msg) : mixed`

##### Parameters

$code : mixed
$msg : mixed

##### Return values

mixed —

#### getDirFromStream()

StreamHandler.php : 146
`private getDirFromStream(string $stream) : null|string`

##### Parameters

$stream : string

##### Return values

null|string —

## Search results