[ Index ]

PHP Cross Reference of phpBB-3.2.8-deutsch

title

Body

[close]

/vendor/guzzlehttp/streams/src/ -> StreamInterface.php (summary)

(no description)

File Size: 159 lines (5 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

StreamInterface:: (15 methods):
  __toString()
  close()
  detach()
  attach()
  getSize()
  tell()
  eof()
  isSeekable()
  seek()
  isWritable()
  write()
  isReadable()
  read()
  getContents()
  getMetadata()


Interface: StreamInterface  - X-Ref

Describes a stream instance.

__toString()   X-Ref
Attempts to seek to the beginning of the stream and reads all data into
a string until the end of the stream is reached.

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

return: string

close()   X-Ref
Closes the stream and any underlying resources.


detach()   X-Ref
Separates any underlying resources from the stream.

After the underlying resource has been detached, the stream object is in
an unusable state. If you wish to use a Stream object as a PHP stream
but keep the Stream object in a consistent state, use
{@see GuzzleHttp\Stream\GuzzleStreamWrapper::getResource}.

return: resource|null Returns the underlying PHP stream resource or null

attach($stream)   X-Ref
Replaces the underlying stream resource with the provided stream.

Use this method to replace the underlying stream with another; as an
example, in server-side code, if you decide to return a file, you
would replace the original content-oriented stream with the file
stream.

Any internal state such as caching of cursor position should be reset
when attach() is called, as the stream has changed.

param: resource $stream
return: void

getSize()   X-Ref
Get the size of the stream if known

return: int|null Returns the size in bytes if known, or null if unknown

tell()   X-Ref
Returns the current position of the file read/write pointer

return: int|bool Returns the position of the file pointer or false on error

eof()   X-Ref
Returns true if the stream is at the end of the stream.

return: bool

isSeekable()   X-Ref
Returns whether or not the stream is seekable

return: bool

seek($offset, $whence = SEEK_SET)   X-Ref
Seek to a position in the stream

param: int $offset Stream offset
param: int $whence Specifies how the cursor position will be calculated
return: bool Returns true on success or false on failure

isWritable()   X-Ref
Returns whether or not the stream is writable

return: bool

write($string)   X-Ref
Write data to the stream

param: string $string The string that is to be written.
return: int|bool Returns the number of bytes written to the stream on

isReadable()   X-Ref
Returns whether or not the stream is readable

return: bool

read($length)   X-Ref
Read data from the stream

param: int $length Read up to $length bytes from the object and return
return: string     Returns the data read from the stream.

getContents()   X-Ref
Returns the remaining contents of the stream as a string.

Note: this could potentially load a large amount of data into memory.

return: string

getMetadata($key = null)   X-Ref
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.

param: string $key Specific metadata to retrieve.
return: array|mixed|null Returns an associative array if no key is



Generated: Tue Apr 7 19:42:26 2020 Cross-referenced by PHPXref 0.7.1