Zend_Log_Writer_Stream Class Reference

Inheritance diagram for Zend_Log_Writer_Stream:

Public Member Functions
	__construct ($streamOrUrl, $mode=null)
	shutdown ()
Public Member Functions inherited from Zend_Log_Writer_Abstract
	addFilter ($filter)
	setFormatter (Zend_Log_Formatter_Interface $formatter)
	shutdown ()

Static Public Member Functions
static	factory ($config)

Protected Member Functions
	_write ($event)
Protected Member Functions inherited from Zend_Log_Writer_Abstract
	_write ($event)

Protected Attributes
	$_stream = null
Protected Attributes inherited from Zend_Log_Writer_Abstract
	$_filters = array()
	$_formatter

Additional Inherited Members
Static Protected Member Functions inherited from Zend_Log_Writer_Abstract
static	_parseConfig ($config)

Detailed Description

Definition at line 37 of file Stream.php.

Constructor & Destructor Documentation

__construct()

__construct	(		$streamOrUrl,
			$mode = null
	)

Class Constructor

Parameters

array | string | resource	$streamOrUrl	Stream or URL to open as a stream
string | null	$mode	Mode, only applicable if a URL is given

Returns

void

Exceptions

Zend_Log_Exception

Definition at line 54 of file Stream.php.

    {
        // Setting the default
        if (null === $mode) {
            $mode = 'a';
        }

        if (is_resource($streamOrUrl)) {
            if (get_resource_type($streamOrUrl) != 'stream') {
                #require_once 'Zend/Log/Exception.php';
                throw new Zend_Log_Exception('Resource is not a stream');
            }

            if ($mode != 'a') {
                #require_once 'Zend/Log/Exception.php';
                throw new Zend_Log_Exception('Mode cannot be changed on existing streams');
            }

            $this->_stream = $streamOrUrl;
        } else {
            if (is_array($streamOrUrl) && isset($streamOrUrl['stream'])) {
                $streamOrUrl = $streamOrUrl['stream'];
            }

            if (! $this->_stream = @fopen($streamOrUrl, $mode, false)) {
                #require_once 'Zend/Log/Exception.php';
                $msg = "\"$streamOrUrl\" cannot be opened with mode \"$mode\"";
                throw new Zend_Log_Exception($msg);
            }
        }

        $this->_formatter = new Zend_Log_Formatter_Simple();
    }

Member Function Documentation

_write()

_write (   $event )

protected

Write a message to the log.

Parameters

array

$event

event data

Returns

void

Exceptions

Zend_Log_Exception

Definition at line 129 of file Stream.php.

    {
        $line = $this->_formatter->format($event);

        if (false === @fwrite($this->_stream, $line)) {
            #require_once 'Zend/Log/Exception.php';
            throw new Zend_Log_Exception("Unable to write to stream");
        }
    }

factory()

static factory (   $config )

static

Create a new instance of Zend_Log_Writer_Stream

Parameters

array | Zend_Config

$config

Returns

Zend_Log_Writer_Stream

Implements Zend_Log_FactoryInterface.

Definition at line 94 of file Stream.php.

    {
        $config = self::_parseConfig($config);
        $config = array_merge(array(
            'stream' => null,
            'mode'   => null,
        ), $config);

        $streamOrUrl = isset($config['url']) ? $config['url'] : $config['stream'];

        return new self(
            $streamOrUrl,
            $config['mode']
        );
    }

shutdown()

shutdown

(

)

Close the stream resource.

Returns

void

Definition at line 115 of file Stream.php.

    {
        if (is_resource($this->_stream)) {
            fclose($this->_stream);
        }
    }

Field Documentation

$_stream

$_stream = null

protected

Definition at line 44 of file Stream.php.

---

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

• vendor/magento/zendframework1/library/Zend/Log/Writer/Stream.php