diff options
author | Andreas Baumann <mail@andreasbaumann.cc> | 2019-11-17 20:45:02 +0100 |
---|---|---|
committer | Andreas Baumann <mail@andreasbaumann.cc> | 2019-11-17 20:45:02 +0100 |
commit | 8df3db566a3a937b45ebf11adb90d265e6f5e2d4 (patch) | |
tree | 4d541098d751d5a9acf8c12f6fb9f308ace066ac /vendor/guzzle/guzzle/src/Guzzle/Stream/StreamInterface.php | |
download | flyspray-8df3db566a3a937b45ebf11adb90d265e6f5e2d4.tar.xz |
initial checking of customized version 1.0rc9
Diffstat (limited to 'vendor/guzzle/guzzle/src/Guzzle/Stream/StreamInterface.php')
-rw-r--r-- | vendor/guzzle/guzzle/src/Guzzle/Stream/StreamInterface.php | 218 |
1 files changed, 218 insertions, 0 deletions
diff --git a/vendor/guzzle/guzzle/src/Guzzle/Stream/StreamInterface.php b/vendor/guzzle/guzzle/src/Guzzle/Stream/StreamInterface.php new file mode 100644 index 0000000..6d7dc37 --- /dev/null +++ b/vendor/guzzle/guzzle/src/Guzzle/Stream/StreamInterface.php @@ -0,0 +1,218 @@ +<?php + +namespace Guzzle\Stream; + +/** + * OO interface to PHP streams + */ +interface StreamInterface +{ + /** + * Convert the stream to a string if the stream is readable and the stream is seekable. + * + * @return string + */ + public function __toString(); + + /** + * Close the underlying stream + */ + public function close(); + + /** + * Get stream metadata + * + * @param string $key Specific metadata to retrieve + * + * @return array|mixed|null + */ + public function getMetaData($key = null); + + /** + * Get the stream resource + * + * @return resource + */ + public function getStream(); + + /** + * Set the stream that is wrapped by the object + * + * @param resource $stream Stream resource to wrap + * @param int $size Size of the stream in bytes. Only pass if the size cannot be obtained from the stream. + * + * @return self + */ + public function setStream($stream, $size = null); + + /** + * Detach the current stream resource + * + * @return self + */ + public function detachStream(); + + /** + * Get the stream wrapper type + * + * @return string + */ + public function getWrapper(); + + /** + * Wrapper specific data attached to this stream. + * + * @return array + */ + public function getWrapperData(); + + /** + * Get a label describing the underlying implementation of the stream + * + * @return string + */ + public function getStreamType(); + + /** + * Get the URI/filename associated with this stream + * + * @return string + */ + public function getUri(); + + /** + * Get the size of the stream if able + * + * @return int|bool + */ + public function getSize(); + + /** + * Check if the stream is readable + * + * @return bool + */ + public function isReadable(); + + /** + * Check if the stream is repeatable + * + * @return bool + */ + public function isRepeatable(); + + /** + * Check if the stream is writable + * + * @return bool + */ + public function isWritable(); + + /** + * Check if the stream has been consumed + * + * @return bool + */ + public function isConsumed(); + + /** + * Alias of isConsumed + * + * @return bool + */ + public function feof(); + + /** + * Check if the stream is a local stream vs a remote stream + * + * @return bool + */ + public function isLocal(); + + /** + * Check if the string is repeatable + * + * @return bool + */ + public function isSeekable(); + + /** + * Specify the size of the stream in bytes + * + * @param int $size Size of the stream contents in bytes + * + * @return self + */ + public function setSize($size); + + /** + * Seek to a position in the stream + * + * @param int $offset Stream offset + * @param int $whence Where the offset is applied + * + * @return bool Returns TRUE on success or FALSE on failure + * @link http://www.php.net/manual/en/function.fseek.php + */ + public function seek($offset, $whence = SEEK_SET); + + /** + * Read data from the stream + * + * @param int $length Up to length number of bytes read. + * + * @return string|bool Returns the data read from the stream or FALSE on failure or EOF + */ + public function read($length); + + /** + * 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 success or FALSE on failure. + */ + public function write($string); + + /** + * Returns the current position of the file read/write pointer + * + * @return int|bool Returns the position of the file pointer or false on error + */ + public function ftell(); + + /** + * Rewind to the beginning of the stream + * + * @return bool Returns true on success or false on failure + */ + public function rewind(); + + /** + * Read a line from the stream up to the maximum allowed buffer length + * + * @param int $maxLength Maximum buffer length + * + * @return string|bool + */ + public function readLine($maxLength = null); + + /** + * Set custom data on the stream + * + * @param string $key Key to set + * @param mixed $value Value to set + * + * @return self + */ + public function setCustomData($key, $value); + + /** + * Get custom data from the stream + * + * @param string $key Key to retrieve + * + * @return null|mixed + */ + public function getCustomData($key); +} |