← All changes
|
vendor_prefixed/psr/http-message/src/StreamInterface.php
+15
-15
18.0
→
trunk
View file →
| @@ -24,15 +24,15 @@ | ||
| 24 | 24 | * |
| 25 | 25 | * @see http://php.net/manual/en/language.oop5.magic.php#object.tostring |
| 26 | 26 | * @return string |
| 27 | 27 | */ |
| 28 | - public function __toString(); | |
| 28 | + public function __toString() : string; | |
| 29 | 29 | /** |
| 30 | 30 | * Closes the stream and any underlying resources. |
| 31 | 31 | * |
| 32 | 32 | * @return void |
| 33 | 33 | */ |
| 34 | - public function close(); | |
| 34 | + public function close() : void; | |
| 35 | 35 | /** |
| 36 | 36 | * Separates any underlying resources from the stream. |
| 37 | 37 | * |
| 38 | 38 | * After the stream has been detached, the stream is in an unusable state. |
| @@ -44,9 +44,9 @@ | ||
| 44 | 44 | * Get the size of the stream if known. |
| 45 | 45 | * |
| 46 | 46 | * @return int|null Returns the size in bytes if known, or null if unknown. |
| 47 | 47 | */ |
| 48 | - public function getSize(); | |
| 48 | + public function getSize() : ?int; | |
| 49 | 49 | /** |
| 50 | 50 | * Returns the current position of the file read/write pointer |
| 51 | 51 | * |
| 52 | 52 | * @return int Position of the file pointer |
| @@ -51,21 +51,21 @@ | ||
| 51 | 51 | * |
| 52 | 52 | * @return int Position of the file pointer |
| 53 | 53 | * @throws \RuntimeException on error. |
| 54 | 54 | */ |
| 55 | - public function tell(); | |
| 55 | + public function tell() : int; | |
| 56 | 56 | /** |
| 57 | 57 | * Returns true if the stream is at the end of the stream. |
| 58 | 58 | * |
| 59 | 59 | * @return bool |
| 60 | 60 | */ |
| 61 | - public function eof(); | |
| 61 | + public function eof() : bool; | |
| 62 | 62 | /** |
| 63 | 63 | * Returns whether or not the stream is seekable. |
| 64 | 64 | * |
| 65 | 65 | * @return bool |
| 66 | 66 | */ |
| 67 | - public function isSeekable(); | |
| 67 | + public function isSeekable() : bool; | |
| 68 | 68 | /** |
| 69 | 69 | * Seek to a position in the stream. |
| 70 | 70 | * |
| 71 | 71 | * @link http://www.php.net/manual/en/function.fseek.php |
| @@ -76,9 +76,9 @@ | ||
| 76 | 76 | * offset bytes SEEK_CUR: Set position to current location plus offset |
| 77 | 77 | * SEEK_END: Set position to end-of-stream plus offset. |
| 78 | 78 | * @throws \RuntimeException on failure. |
| 79 | 79 | */ |
| 80 | - public function seek($offset, $whence = \SEEK_SET); | |
| 80 | + public function seek(int $offset, int $whence = \SEEK_SET) : void; | |
| 81 | 81 | /** |
| 82 | 82 | * Seek to the beginning of the stream. |
| 83 | 83 | * |
| 84 | 84 | * If the stream is not seekable, this method will raise an exception; |
| @@ -87,15 +87,15 @@ | ||
| 87 | 87 | * @see seek() |
| 88 | 88 | * @link http://www.php.net/manual/en/function.fseek.php |
| 89 | 89 | * @throws \RuntimeException on failure. |
| 90 | 90 | */ |
| 91 | - public function rewind(); | |
| 91 | + public function rewind() : void; | |
| 92 | 92 | /** |
| 93 | 93 | * Returns whether or not the stream is writable. |
| 94 | 94 | * |
| 95 | 95 | * @return bool |
| 96 | 96 | */ |
| 97 | - public function isWritable(); | |
| 97 | + public function isWritable() : bool; | |
| 98 | 98 | /** |
| 99 | 99 | * Write data to the stream. |
| 100 | 100 | * |
| 101 | 101 | * @param string $string The string that is to be written. |
| @@ -101,15 +101,15 @@ | ||
| 101 | 101 | * @param string $string The string that is to be written. |
| 102 | 102 | * @return int Returns the number of bytes written to the stream. |
| 103 | 103 | * @throws \RuntimeException on failure. |
| 104 | 104 | */ |
| 105 | - public function write($string); | |
| 105 | + public function write(string $string) : int; | |
| 106 | 106 | /** |
| 107 | 107 | * Returns whether or not the stream is readable. |
| 108 | 108 | * |
| 109 | 109 | * @return bool |
| 110 | 110 | */ |
| 111 | - public function isReadable(); | |
| 111 | + public function isReadable() : bool; | |
| 112 | 112 | /** |
| 113 | 113 | * Read data from the stream. |
| 114 | 114 | * |
| 115 | 115 | * @param int $length Read up to $length bytes from the object and return |
| @@ -118,9 +118,9 @@ | ||
| 118 | 118 | * @return string Returns the data read from the stream, or an empty string |
| 119 | 119 | * if no bytes are available. |
| 120 | 120 | * @throws \RuntimeException if an error occurs. |
| 121 | 121 | */ |
| 122 | - public function read($length); | |
| 122 | + public function read(int $length) : string; | |
| 123 | 123 | /** |
| 124 | 124 | * Returns the remaining contents in a string |
| 125 | 125 | * |
| 126 | 126 | * @return string |
| @@ -126,9 +126,9 @@ | ||
| 126 | 126 | * @return string |
| 127 | 127 | * @throws \RuntimeException if unable to read or an error occurs while |
| 128 | 128 | * reading. |
| 129 | 129 | */ |
| 130 | - public function getContents(); | |
| 130 | + public function getContents() : string; | |
| 131 | 131 | /** |
| 132 | 132 | * Get stream metadata as an associative array or retrieve a specific key. |
| 133 | 133 | * |
| 134 | 134 | * The keys returned are identical to the keys returned from PHP's |
| @@ -134,11 +134,11 @@ | ||
| 134 | 134 | * The keys returned are identical to the keys returned from PHP's |
| 135 | 135 | * stream_get_meta_data() function. |
| 136 | 136 | * |
| 137 | 137 | * @link http://php.net/manual/en/function.stream-get-meta-data.php |
| 138 | - * @param string $key Specific metadata to retrieve. | |
| 138 | + * @param string|null $key Specific metadata to retrieve. | |
| 139 | 139 | * @return array|mixed|null Returns an associative array if no key is |
| 140 | 140 | * provided. Returns a specific key value if a key is provided and the |
| 141 | 141 | * value is found, or null if the key is not found. |
| 142 | 142 | */ |
| 143 | - public function getMetadata($key = null); | |
| 143 | + public function getMetadata(?string $key = null); | |
| 144 | 144 | } |