1: 2: 3: 4: 5: 6: 7: 8: 9: 10: 11: 12: 13: 14: 15: 16: 17: 18: 19: 20: 21: 22: 23: 24: 25: 26: 27: 28: 29: 30: 31: 32: 33: 34: 35: 36: 37: 38: 39: 40: 41: 42: 43: 44: 45: 46: 47: 48: 49: 50: 51: 52: 53: 54: 55: 56: 57: 58:
<?php
/*
* This file is part of the webmozart/console package.
*
* (c) Bernhard Schussek <bschussek@gmail.com>
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace Webmozart\Console\Api\IO;
/**
* The console input stream.
*
* @since 1.0
*
* @author Bernhard Schussek <bschussek@gmail.com>
*/
interface InputStream
{
/**
* Reads the given amount of characters from the stream.
*
* @param int $length The number of characters to read.
*
* @return string The characters read from the stream.
*
* @throws IOException If reading fails or if the stream is closed.
*/
public function read($length);
/**
* Reads a line from the stream.
*
* @param int $length The maximum number of characters to read. If `null`,
* all characters up to the first newline are returned.
*
* @return string The characters read from the stream.
*
* @throws IOException If reading fails or if the stream is closed.
*/
public function readLine($length = null);
/**
* Closes the stream.
*/
public function close();
/**
* Returns whether the stream is closed.
*
* @return bool Returns `true` if the stream is closed.
*/
public function isClosed();
}