Menu

## StreamInterface
in

StreamInterface.php : 11

Describes a data stream.

Typically, an instance will wrap a PHP stream; this interface provides a wrapper around the most common operations, including serialization of the entire stream to a string.

### Table of Contents

__toString() : string
  Reads all data from the stream into a string, from the beginning to end.
close() : mixed
  Closes the stream and any underlying resources.
detach() : resource|null
  Separates any underlying resources from the stream.
eof() : bool
  Returns true if the stream is at the end of the stream.
getContents() : string
  Returns the remaining contents in a string.
getMetadata() : array<string|int, mixed>|mixed|null
  Get stream metadata as an associative array or retrieve a specific key.
getSize() : int|null
  Get the size of the stream if known.
isReadable() : bool
  Returns whether or not the stream is readable.
isSeekable() : bool
  Returns whether or not the stream is seekable.
isWritable() : bool
  Returns whether or not the stream is writable.
read() : string
  Read data from the stream.
rewind() : mixed
  Seek to the beginning of the stream.
seek() : mixed
  Seek to a position in the stream.
tell() : int
  Returns the current position of the file read/write pointer.
write() : int
  Write data to the stream.

### Methods

#### __toString()

StreamInterface.php : 28

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

`public __toString() : string`

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.

##### Tags

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

##### Return values

string —

#### close()

StreamInterface.php : 33

Closes the stream and any underlying resources.

`public close() : mixed`

##### Return values

mixed —

#### detach()

StreamInterface.php : 42

Separates any underlying resources from the stream.

`public detach() : resource|null`

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

##### Return values

resource|null —

Underlying PHP stream, if any

#### eof()

StreamInterface.php : 65

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

`public eof() : bool`

##### Return values

bool —

#### getContents()

StreamInterface.php : 153

Returns the remaining contents in a string.

`public getContents() : string`

reading.

##### Tags

throws
  RuntimeException

  if unable to read or an error occurs while

##### Return values

string —

#### getMetadata()

StreamInterface.php : 170

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

`public getMetadata([string $key = null ]) : array<string|int, mixed>|mixed|null`

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

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

##### Parameters

$key : string = null

  specific metadata to retrieve

##### Tags

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

##### Return values

array<string|int, mixed>|mixed|null —

Returns an associative array if no key is

#### getSize()

StreamInterface.php : 49

Get the size of the stream if known.

`public getSize() : int|null`

##### Return values

int|null —

returns the size in bytes if known, or null if unknown

#### isReadable()

StreamInterface.php : 127

Returns whether or not the stream is readable.

`public isReadable() : bool`

##### Return values

bool —

#### isSeekable()

StreamInterface.php : 72

Returns whether or not the stream is seekable.

`public isSeekable() : bool`

##### Return values

bool —

#### isWritable()

StreamInterface.php : 109

Returns whether or not the stream is writable.

`public isWritable() : bool`

##### Return values

bool —

#### read()

StreamInterface.php : 142

Read data from the stream.

`public read(int $length) : string`

them. Fewer than $length bytes may be returned if underlying stream call returns fewer bytes. if no bytes are available.

##### Parameters

$length : int

  Read up to $length bytes from the object and return

##### Tags

throws
  RuntimeException

  if an error occurs

##### Return values

string —

Returns the data read from the stream, or an empty string

#### rewind()

StreamInterface.php : 102

Seek to the beginning of the stream.

`public rewind() : mixed`

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

##### Tags

see
  http://www.php.net/manual/en/function.fseek.php
see
  seek()
throws
  RuntimeException

  on failure

##### Return values

mixed —

#### seek()

StreamInterface.php : 89

Seek to a position in the stream.

`public seek(int $offset[, int $whence = SEEK_SET ]) : mixed`

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.

##### Parameters

$offset : int

  Stream offset

$whence : int = SEEK_SET

  Specifies how the cursor position will be calculated

##### Tags

see
  http://www.php.net/manual/en/function.fseek.php
throws
  RuntimeException

  on failure

##### Return values

mixed —

#### tell()

StreamInterface.php : 58

Returns the current position of the file read/write pointer.

`public tell() : int`

##### Tags

throws
  RuntimeException

  on error

##### Return values

int —

Position of the file pointer

#### write()

StreamInterface.php : 120

Write data to the stream.

`public write(string $string) : int`

##### Parameters

$string : string

  the string that is to be written

##### Tags

throws
  RuntimeException

  on failure

##### Return values

int —

returns the number of bytes written to the stream

## Search results