Overview

Namespaces

  • Docta
    • MercadoLibre
      • Exception
      • OAuth2
        • Client
          • Test
  • GuzzleHttp
    • Cookie
    • Exception
    • Handler
    • Promise
      • Test
      • Tests
    • Psr7
    • Test
      • Handler
    • Tests
      • CookieJar
      • Event
      • Exception
      • Handler
      • Promise
      • Psr7
  • League
    • OAuth2
      • Client
        • Grant
          • Exception
        • Provider
          • Exception
        • Test
          • Grant
          • Provider
            • Exception
            • Fake
          • Token
          • Tool
        • Token
        • Tool
  • None
  • Psr
    • Http
      • Message

Classes

  • AppendStream
  • BufferStream
  • CachingStream
  • DroppingStream
  • FnStream
  • InflateStream
  • LazyOpenStream
  • LimitStream
  • MultipartStream
  • NoSeekStream
  • PumpStream
  • Request
  • Response
  • ServerRequest
  • Stream
  • StreamWrapper
  • UploadedFile
  • Uri
  • UriNormalizer
  • UriResolver

Traits

  • MessageTrait
  • StreamDecoratorTrait

Functions

  • build_query
  • copy_to_stream
  • copy_to_string
  • fread
  • hash
  • mimetype_from_extension
  • mimetype_from_filename
  • modify_request
  • normalize_header
  • parse_header
  • parse_query
  • parse_request
  • parse_response
  • readline
  • rewind_body
  • str
  • stream_for
  • try_fopen
  • uri_for
  • Overview
  • Namespace
  • Class
  • Download

Class BufferStream

Provides a buffer stream that can be written to to fill a buffer, and read from to remove bytes from the buffer.

This stream returns a "hwm" metadata value that tells upstream consumers what the configured high water mark of the stream is, or the maximum preferred size of the buffer.

GuzzleHttp\Psr7\BufferStream implements Psr\Http\Message\StreamInterface
Namespace: GuzzleHttp\Psr7
Located at src/BufferStream.php
Methods summary
public
# __construct( integer $hwm = 16384 )

Parameters

$hwm

High water mark, representing the preferred maximum buffer size. If the size of the buffer exceeds the high water mark, then calls to write will continue to succeed but will return false to inform writers to slow down until the buffer has been drained by reading from it.

public string
# __toString( )

Reads all data from the stream into a string, from the beginning to end.

Reads all data from the stream into a string, from the beginning to end.

This method MUST attempt to seek to the beginning of the stream before reading data and read the stream until the end is reached.

Warning: This could attempt to load a large amount of data into memory.

This method MUST NOT raise an exception in order to conform with PHP's string casting operations.

Returns

string

See

http://php.net/manual/en/language.oop5.magic.php#object.tostring

Implementation of

Psr\Http\Message\StreamInterface::__toString()
public string
# getContents( )

Returns the remaining contents in a string

Returns the remaining contents in a string

Returns

string

Throws

RuntimeException

if unable to read or an error occurs while reading.

Implementation of

Psr\Http\Message\StreamInterface::getContents()
public
# close( )

Closes the stream and any underlying resources.

Closes the stream and any underlying resources.

Implementation of

Psr\Http\Message\StreamInterface::close()
public resource|null
# detach( )

Separates any underlying resources from the stream.

Separates any underlying resources from the stream.

After the stream has been detached, the stream is in an unusable state.

Returns

resource|null
Underlying PHP stream, if any

Implementation of

Psr\Http\Message\StreamInterface::detach()
public integer|null
# getSize( )

Get the size of the stream if known.

Get the size of the stream if known.

Returns

integer|null
Returns the size in bytes if known, or null if unknown.

Implementation of

Psr\Http\Message\StreamInterface::getSize()
public boolean
# isReadable( )

Returns whether or not the stream is readable.

Returns whether or not the stream is readable.

Returns

boolean

Implementation of

Psr\Http\Message\StreamInterface::isReadable()
public boolean
# isWritable( )

Returns whether or not the stream is writable.

Returns whether or not the stream is writable.

Returns

boolean

Implementation of

Psr\Http\Message\StreamInterface::isWritable()
public boolean
# isSeekable( )

Returns whether or not the stream is seekable.

Returns whether or not the stream is seekable.

Returns

boolean

Implementation of

Psr\Http\Message\StreamInterface::isSeekable()
public
# rewind( )

Seek to the beginning of the stream.

Seek to the beginning of the stream.

If the stream is not seekable, this method will raise an exception; otherwise, it will perform a seek(0).

Throws

RuntimeException
on failure.

See

GuzzleHttp\Psr7\BufferStream::seek()

Link

http://www.php.net/manual/en/function.fseek.php

Implementation of

Psr\Http\Message\StreamInterface::rewind()
public
# seek( integer $offset, integer $whence = SEEK_SET )

Seek to a position in the stream.

Seek to a position in the stream.

Parameters

$offset
Stream offset
$whence

Specifies how the cursor position will be calculated based on the seek offset. Valid values are identical to the built-in PHP $whence values for fseek(). SEEK_SET: Set position equal to offset bytes SEEK_CUR: Set position to current location plus offset SEEK_END: Set position to end-of-stream plus offset.

Throws

RuntimeException
on failure.

Link

http://www.php.net/manual/en/function.fseek.php

Implementation of

Psr\Http\Message\StreamInterface::seek()
public boolean
# eof( )

Returns true if the stream is at the end of the stream.

Returns true if the stream is at the end of the stream.

Returns

boolean

Implementation of

Psr\Http\Message\StreamInterface::eof()
public integer
# tell( )

Returns the current position of the file read/write pointer

Returns the current position of the file read/write pointer

Returns

integer
Position of the file pointer

Throws

RuntimeException
on error.

Implementation of

Psr\Http\Message\StreamInterface::tell()
public string
# read( integer $length )

Reads data from the buffer.

Reads data from the buffer.

Parameters

$length

Read up to $length bytes from the object and return them. Fewer than $length bytes may be returned if underlying stream call returns fewer bytes.

Returns

string

Returns the data read from the stream, or an empty string if no bytes are available.

Throws

RuntimeException
if an error occurs.

Implementation of

Psr\Http\Message\StreamInterface::read()
public integer
# write( string $string )

Writes data to the buffer.

Writes data to the buffer.

Parameters

$string
The string that is to be written.

Returns

integer
Returns the number of bytes written to the stream.

Throws

RuntimeException
on failure.

Implementation of

Psr\Http\Message\StreamInterface::write()
public array|mixed|null
# getMetadata( string $key = null )

Get stream metadata as an associative array or retrieve a specific key.

Get stream metadata as an associative array or retrieve a specific key.

The keys returned are identical to the keys returned from PHP's stream_get_meta_data() function.

Parameters

$key
Specific metadata to retrieve.

Returns

array|mixed|null

Returns an associative array if no key is provided. Returns a specific key value if a key is provided and the value is found, or null if the key is not found.

Link

http://php.net/manual/en/function.stream-get-meta-data.php

Implementation of

Psr\Http\Message\StreamInterface::getMetadata()
MercadoLibre PHP SDK API documentation generated by ApiGen