Overview
  • Namespace
  • Class

Namespaces

  • Http
    • Message
      • Authentication
      • Decorator
      • Encoding
        • Filter
      • Formatter
      • MessageFactory
      • StreamFactory
      • UriFactory

Classes

  • ChunkStream
  • CompressStream
  • DechunkStream
  • DecompressStream
  • DeflateStream
  • FilteredStream
  • GzipDecodeStream
  • GzipEncodeStream
  • InflateStream

Class FilteredStream

A filtered stream has a filter for filtering output and a filter for filtering input made to a underlying stream.

Http\Message\Encoding\FilteredStream implements Psr\Http\Message\StreamInterface uses Http\Message\Decorator\StreamDecorator

Direct known subclasses

Http\Message\Encoding\ChunkStream, Http\Message\Encoding\CompressStream, Http\Message\Encoding\DechunkStream, Http\Message\Encoding\DecompressStream, Http\Message\Encoding\DeflateStream, Http\Message\Encoding\GzipDecodeStream, Http\Message\Encoding\GzipEncodeStream, Http\Message\Encoding\InflateStream

Abstract
Namespace: Http\Message\Encoding
Author: Joel Wurtz joel.wurtz@gmail.com
Located at Encoding/FilteredStream.php

Methods summary

public
# __construct( Psr\Http\Message\StreamInterface $stream, mixed|null $readFilterOptions = null, mixed|null $writeFilterOptions = null )

Parameters

$stream
$readFilterOptions
$writeFilterOptions
public
# read( $length )
public
# eof( )
protected
# fill( )

Buffer is filled by reading underlying stream.

Buffer is filled by reading underlying stream.

Callback is reading once more even if the stream is ended. This allow to get last data in the PHP buffer otherwise this bug is present : https://bugs.php.net/bug.php?id=48725

public
# getContents( )
abstract public string
# getReadFilter( )

Returns the read filter name.

Returns the read filter name.

Returns

string
abstract public string
# getWriteFilter( )

Returns the write filter name.

Returns the write filter name.

Returns

string

Methods used from Http\Message\Decorator\StreamDecorator

__toString(), close(), detach(), getMetadata(), getSize(), isReadable(), isSeekable(), isWritable(), rewind(), seek(), tell(), write()

Constants summary

integer BUFFER_SIZE
# 65536

Properties summary

protected callable $readFilterCallback
#
protected resource $readFilter
#
protected callable $writeFilterCallback
#
protected resource $writeFilter
#
protected string $buffer

Internal buffer.

Internal buffer.

# ''

Properties used from Http\Message\Decorator\StreamDecorator

$stream

API documentation generated by ApiGen