Webmozart\Console\Api\IO\InputStream

Size/Duplication

Total Lines	37
Duplicated Lines	0 %

Importance

Changes	2
Bugs	0	Features	1

4 Methods

Rating	Name	Duplication	Size	Complexity
	read()	0	1	?
	readLine()	0	1	?
	close()	0	1	?
	isClosed()	0	1	?

<?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`,

Should the type for parameter $length not be integer|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();

For interfaces and abstract methods it is generally a good practice to add a @return annotation even if it is just @return void or @return null, so that implementors know what to do in the overridden method.

    /**
     * Returns whether the stream is closed.
     *
     * @return bool Returns `true` if the stream is closed.
     */
    public function isClosed();
}