SDK for PHP 3.x

InflateStream
in package
implements StreamInterface Uses StreamDecoratorTrait

FinalYes

Uses PHP's zlib.inflate filter to inflate zlib (HTTP deflate, RFC1950) or gzipped (RFC1952) content.

This stream decorator converts the provided stream to a PHP stream resource, then appends the zlib.inflate filter. The stream is then converted back to a Guzzle stream resource to be used as a Guzzle stream.

Tags
see
https://datatracker.ietf.org/doc/html/rfc1950
see
https://datatracker.ietf.org/doc/html/rfc1952
see
https://www.php.net/manual/en/filters.compression.php

Table of Contents

Interfaces

StreamInterface
Describes a data stream.

Methods

__call()  : mixed
Allow decorators to implement custom methods
__construct()  : mixed
__get()  : StreamInterface
Magic method used to create a new stream if streams are not added in the constructor of a decorator (e.g., LazyOpenStream).
__toString()  : string
close()  : void
detach()  : mixed
eof()  : bool
getContents()  : string
getMetadata()  : mixed
getSize()  : int|null
isReadable()  : bool
isSeekable()  : bool
isWritable()  : bool
read()  : string
rewind()  : void
seek()  : void
tell()  : int
write()  : int

Methods

__call()

Allow decorators to implement custom methods

public __call(string $method, array<string|int, mixed> $args) : mixed
Parameters
$method : string
$args : array<string|int, mixed>

__get()

Magic method used to create a new stream if streams are not added in the constructor of a decorator (e.g., LazyOpenStream).

public __get(string $name) : StreamInterface
Parameters
$name : string
Return values
StreamInterface

__toString()

public __toString() : string
Return values
string

close()

public close() : void

detach()

public detach() : mixed

eof()

public eof() : bool
Return values
bool

getContents()

public getContents() : string
Return values
string

getMetadata()

public getMetadata([mixed $key = null ]) : mixed
Parameters
$key : mixed = null

getSize()

public getSize() : int|null
Return values
int|null

isReadable()

public isReadable() : bool
Return values
bool

isSeekable()

public isSeekable() : bool
Return values
bool

isWritable()

public isWritable() : bool
Return values
bool

read()

public read(mixed $length) : string
Parameters
$length : mixed
Return values
string

rewind()

public rewind() : void

seek()

public seek(mixed $offset[, mixed $whence = SEEK_SET ]) : void
Parameters
$offset : mixed
$whence : mixed = SEEK_SET

tell()

public tell() : int
Return values
int

write()

public write(mixed $string) : int
Parameters
$string : mixed
Return values
int
On this page