Converts Guzzle streams into PHP stream resources. More...

Collaboration diagram for GuzzleHttp\Psr7\StreamWrapper:

Public Member Functions
	stream_open ($path, $mode, $options, &$opened_path)

	stream_read ($count)

	stream_write ($data)

	stream_tell ()

	stream_eof ()

	stream_seek ($offset, $whence)

	stream_stat ()

Static Public Member Functions
static	getResource (StreamInterface $stream)
	Returns a resource representing the stream. More...

static	register ()
	Registers the stream wrapper if needed. More...

Data Fields
	$context

Private Attributes
	$stream

	$mode

Detailed Description

Converts Guzzle streams into PHP stream resources.

Definition at line 9 of file StreamWrapper.php.

Member Function Documentation

◆ getResource()

static GuzzleHttp\Psr7\StreamWrapper::getResource ( StreamInterface $stream )

static

Returns a resource representing the stream.

Parameters

StreamInterface $stream The stream to get a resource for

Returns: resource

Exceptions

InvalidArgumentException if stream is not readable or writable

Definition at line 28 of file StreamWrapper.php.

    {
        self::register();
 
        if ($stream->isReadable()) {
            $mode = $stream->isWritable() ? 'r+' : 'r';
        } elseif ($stream->isWritable()) {
            $mode = 'w';
        } else {
            throw new \InvalidArgumentException('The stream must be readable, '
                . 'writable, or both.');
        }
 
        return fopen('guzzle://stream', $mode, null, stream_context_create([
            'guzzle' => ['stream' => $stream]
        ]));
    }

References GuzzleHttp\Psr7\StreamWrapper\$mode, GuzzleHttp\Psr7\StreamWrapper\$stream, and GuzzleHttp\Psr7\StreamWrapper\register().

Referenced by GuzzleHttp\Psr7\InflateStream\__construct().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ register()

static GuzzleHttp\Psr7\StreamWrapper::register ( )

static

Registers the stream wrapper if needed.

Definition at line 49 of file StreamWrapper.php.

    {
        if (!in_array('guzzle', stream_get_wrappers())) {
            stream_wrapper_register('guzzle', __CLASS__);
        }
    }

Referenced by GuzzleHttp\Psr7\StreamWrapper\getResource().

Here is the caller graph for this function:

◆ stream_eof()

GuzzleHttp\Psr7\StreamWrapper::stream_eof ( )

Definition at line 85 of file StreamWrapper.php.

    {
        return $this->stream->eof();
    }

◆ stream_open()

GuzzleHttp\Psr7\StreamWrapper::stream_open	(		$path,
			$mode,
			$options,
		&	$opened_path
	)

Definition at line 56 of file StreamWrapper.php.

    {
        $options = stream_context_get_options($this->context);
 
        if (!isset($options['guzzle']['stream'])) {
            return false;
        }
 
        $this->mode = $mode;
        $this->stream = $options['guzzle']['stream'];
 
        return true;
    }

References GuzzleHttp\Psr7\StreamWrapper\$mode, and $options.

◆ stream_read()

GuzzleHttp\Psr7\StreamWrapper::stream_read ( $count )

Definition at line 70 of file StreamWrapper.php.

    {
        return $this->stream->read($count);
    }

◆ stream_seek()

GuzzleHttp\Psr7\StreamWrapper::stream_seek	(	$offset,
		$whence
	)

Definition at line 90 of file StreamWrapper.php.

    {
        $this->stream->seek($offset, $whence);
 
        return true;
    }

◆ stream_stat()

GuzzleHttp\Psr7\StreamWrapper::stream_stat ( )

Definition at line 97 of file StreamWrapper.php.

    {
        static $modeMap = [
            'r'  => 33060,
            'r+' => 33206,
            'w'  => 33188
        ];
 
        return [
            'dev'     => 0,
            'ino'     => 0,
            'mode'    => $modeMap[$this->mode],
            'nlink'   => 0,
            'uid'     => 0,
            'gid'     => 0,
            'rdev'    => 0,
            'size'    => $this->stream->getSize() ?: 0,
            'atime'   => 0,
            'mtime'   => 0,
            'ctime'   => 0,
            'blksize' => 0,
            'blocks'  => 0
        ];
    }

References GuzzleHttp\Psr7\StreamWrapper\$mode.

◆ stream_tell()

GuzzleHttp\Psr7\StreamWrapper::stream_tell ( )

Definition at line 80 of file StreamWrapper.php.

    {
        return $this->stream->tell();
    }

◆ stream_write()

GuzzleHttp\Psr7\StreamWrapper::stream_write ( $data )

Definition at line 75 of file StreamWrapper.php.

    {
        return (int) $this->stream->write($data);
    }

References $data.

Field Documentation

◆ $context

GuzzleHttp\Psr7\StreamWrapper::$context

Definition at line 12 of file StreamWrapper.php.

◆ $mode

GuzzleHttp\Psr7\StreamWrapper::$mode

private

Definition at line 18 of file StreamWrapper.php.

Referenced by GuzzleHttp\Psr7\StreamWrapper\getResource(), GuzzleHttp\Psr7\StreamWrapper\stream_open(), and GuzzleHttp\Psr7\StreamWrapper\stream_stat().

◆ $stream

GuzzleHttp\Psr7\StreamWrapper::$stream