Stores to any stream resource. More...

Inheritance diagram for Monolog\Handler\StreamHandler:

Collaboration diagram for Monolog\Handler\StreamHandler:

Public Member Functions

__construct ($stream, $level=Logger::DEBUG, $bubble=true, $filePermission=null, $useLocking=false)

close ()

{Closes the handler.This will be called automatically when the object is destroyed} More...

Public Member Functions inherited from Monolog\Handler\AbstractProcessingHandler

handle (array $record)

{Handles a record.All records may be passed to this method, and the handler should discard those that it does not want to handle.The return value of this function controls the bubbling process of the handler stack. Unless the bubbling is interrupted (by returning true), the Logger class will keep on calling further handlers in the stack with a given log record.

Parameters

array $record The record to handle

Returns: Boolean 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.

} More...

Public Member Functions inherited from Monolog\Handler\AbstractHandler

__construct ($level=Logger::DEBUG, $bubble=true)

isHandling (array $record)

{Checks whether the given record will be handled by this handler.This is mostly done for performance reasons, to avoid calling processors for nothing.Handlers should still check the record levels within handle(), returning false in isHandling() is no guarantee that handle() will not be called, and isHandling() might not be called for a given record.

Parameters

array $record Partial log record containing only a level key

Returns: Boolean

} More...

handleBatch (array $records)

{Handles a set of records at once.

Parameters

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

} More...

close ()

Closes the handler. More...

pushProcessor ($callback)

{Adds a processor in the stack.

Parameters

callable $callback

Returns: self

} More...

popProcessor ()

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

Returns: callable

} More...

setFormatter (FormatterInterface $formatter)

{Sets the formatter.

Parameters

FormatterInterface $formatter

Returns: self

} More...

getFormatter ()

{Gets the formatter.

Returns: FormatterInterface

} More...

setLevel ($level)

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

getLevel ()

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

setBubble ($bubble)

Sets the bubbling behavior. More...

getBubble ()

Gets the bubbling behavior. More...

__destruct ()

isHandling (array $record)

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

handle (array $record)

Handles a record. More...

handleBatch (array $records)

Handles a set of records at once. More...

pushProcessor ($callback)

Adds a processor in the stack. More...

popProcessor ()

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

setFormatter (FormatterInterface $formatter)

Sets the formatter. More...

getFormatter ()

Gets the formatter. More...

Protected Member Functions

write (array $record)

{Writes the record down to the log of the implementing handler.

Parameters

array $record

Returns: void

} More...

Protected Member Functions inherited from Monolog\Handler\AbstractProcessingHandler

write (array $record)

Writes the record down to the log of the implementing handler. More...

processRecord (array $record)

Processes a record. More...

Protected Member Functions inherited from Monolog\Handler\AbstractHandler

getDefaultFormatter ()

Gets the default formatter. More...

Protected Attributes
	$stream

	$url

	$filePermission

	$useLocking

Protected Attributes inherited from Monolog\Handler\AbstractHandler
	$level = Logger::DEBUG

	$bubble = true

	$formatter

	$processors = array()

Private Member Functions
	customErrorHandler ($code, $msg)

	getDirFromStream ($stream)

Private Attributes
	$errorMessage

Detailed Description

Stores to any stream resource.

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

Author: Jordi Boggiano j.bog.nosp@m.gian.nosp@m.o@sel.nosp@m.d.be

Definition at line 23 of file StreamHandler.php.

Constructor & Destructor Documentation

◆ __construct()

Monolog\Handler\StreamHandler::__construct	(	$stream,
		$level = `Logger::DEBUG`,
		$bubble = `true`,
		$filePermission = `null`,
		$useLocking = `false`
	)

Parameters

resource \| string	$stream
integer	$level	The minimum logging level at which this handler will be triggered
Boolean	$bubble	Whether the messages that are handled can bubble up the stack or not
int \| null	$filePermission	Optional file permissions (default (0644) are only for owner read/write)
Boolean	$useLocking	Try to lock log file before doing any writes

Exceptions

Exception If a missing directory is not buildable

Exceptions

InvalidArgumentException If stream is not a resource or string

Definition at line 41 of file StreamHandler.php.

    {
        parent::__construct($level, $bubble);
        if (is_resource($stream)) {
            $this->stream = $stream;
        } elseif (is_string($stream)) {
            $dir = $this->getDirFromStream($stream);
            if (null !== $dir && !is_dir($dir)) {
                $this->errorMessage = null;
                set_error_handler(array($this, 'customErrorHandler'));
                $status = mkdir($dir, 0777, true);
                restore_error_handler();
                if (false === $status) {
                    throw new \UnexpectedValueException(sprintf('There is no existing directory at "%s" and its not buildable: '.$this->errorMessage, $dir));
                }
            }
            $this->url = $stream;
        } else {
            throw new \InvalidArgumentException('A stream must either be a resource or a string.');
        }
 
        $this->filePermission = $filePermission;
        $this->useLocking = $useLocking;
    }

References Monolog\Handler\AbstractHandler\$bubble, Monolog\Handler\StreamHandler\$filePermission, Monolog\Handler\AbstractHandler\$level, Monolog\Handler\StreamHandler\$stream, Monolog\Handler\StreamHandler\$useLocking, and Monolog\Handler\StreamHandler\getDirFromStream().

Here is the call graph for this function:

Member Function Documentation

◆ close()

Monolog\Handler\StreamHandler::close ( )

{Closes the handler.This will be called automatically when the object is destroyed}

Reimplemented from Monolog\Handler\AbstractHandler.

Reimplemented in Monolog\Handler\RotatingFileHandler.

Definition at line 69 of file StreamHandler.php.

    {
        if (is_resource($this->stream)) {
            fclose($this->stream);
        }
        $this->stream = null;
    }

◆ customErrorHandler()

Monolog\Handler\StreamHandler::customErrorHandler	(	$code,
		$msg
	)

private

Definition at line 111 of file StreamHandler.php.

    {
        $this->errorMessage = preg_replace('{^(fopen|mkdir)\‍(.*?\‍): }', '', $msg);
    }

◆ getDirFromStream()

Monolog\Handler\StreamHandler::getDirFromStream ( $stream )

private

Parameters

string $stream

Returns: null|string

Definition at line 121 of file StreamHandler.php.

    {
        $pos = strpos($stream, '://');
        if ($pos === false) {
            return dirname($stream);
        }
 
        if ('file://' === substr($stream, 0, 7)) {
            return dirname(substr($stream, 7));
        }
 
        return;
    }

References Monolog\Handler\StreamHandler\$stream.

Referenced by Monolog\Handler\StreamHandler\__construct().

Here is the caller graph for this function:

◆ write()

Monolog\Handler\StreamHandler::write ( array $record )

protected

{Writes the record down to the log of the implementing handler.

Parameters

array $record

Returns: void

}

Reimplemented from Monolog\Handler\AbstractProcessingHandler.

Reimplemented in Monolog\Handler\RotatingFileHandler.

Definition at line 80 of file StreamHandler.php.

    {
        if (!is_resource($this->stream)) {
            if (!$this->url) {
                throw new \LogicException('Missing stream url, the stream can not be opened. This may be caused by a premature call to close().');
            }
            $this->errorMessage = null;
            set_error_handler(array($this, 'customErrorHandler'));
            $this->stream = fopen($this->url, 'a');
            if ($this->filePermission !== null) {
                @chmod($this->url, $this->filePermission);
            }
            restore_error_handler();
            if (!is_resource($this->stream)) {
                $this->stream = null;
                throw new \UnexpectedValueException(sprintf('The stream or file "%s" could not be opened: '.$this->errorMessage, $this->url));
            }
        }
 
        if ($this->useLocking) {
            // ignoring errors here, there's not much we can do about them
            flock($this->stream, LOCK_EX);
        }
 
        fwrite($this->stream, (string) $record['formatted']);
 
        if ($this->useLocking) {
            flock($this->stream, LOCK_UN);
        }
    }

Field Documentation

◆ $errorMessage

Monolog\Handler\StreamHandler::$errorMessage

private

Definition at line 27 of file StreamHandler.php.

◆ $filePermission

Monolog\Handler\StreamHandler::$filePermission

protected

Definition at line 28 of file StreamHandler.php.

Referenced by Monolog\Handler\RotatingFileHandler\__construct(), and Monolog\Handler\StreamHandler\__construct().

◆ $stream

Monolog\Handler\StreamHandler::$stream

protected

Definition at line 25 of file StreamHandler.php.

Referenced by Monolog\Handler\StreamHandler\__construct(), and Monolog\Handler\StreamHandler\getDirFromStream().

◆ $url

Monolog\Handler\StreamHandler::$url

protected

Definition at line 26 of file StreamHandler.php.

◆ $useLocking

Monolog\Handler\StreamHandler::$useLocking

protected

Definition at line 29 of file StreamHandler.php.

Referenced by Monolog\Handler\RotatingFileHandler\__construct(), and Monolog\Handler\StreamHandler\__construct().

The documentation for this class was generated from the following file:

Services/Logging/lib/vendor/monolog/monolog/src/Monolog/Handler/StreamHandler.php

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ close()

◆ customErrorHandler()

◆ getDirFromStream()

◆ write()

Field Documentation

◆ $errorMessage

◆ $filePermission

◆ $stream

◆ $url

◆ $useLocking