Webmozart\Console\Api\IO\OutputStream

Size/Duplication

Total Lines	38
Duplicated Lines	0 %

Importance

Changes	2
Bugs	0	Features	1

5 Methods

Rating	Name	Duplication	Size	Complexity
	write()	0	1	?
	flush()	0	1	?
	supportsAnsi()	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 output stream.
 *
 * @since  1.0
 *
 * @author Bernhard Schussek <bschussek@gmail.com>
 */
interface OutputStream
{
    /**
     * Writes a string to the stream.
     *
     * @param string $string The string to write.
     *
     * @throws IOException If writing fails or if the stream is closed.
     */
    public function write($string);

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.

    /**
     * Flushes the stream and forces all pending text to be written out.
     *
     * @throws IOException If flushing fails or if the stream is closed.
     */
    public function flush();

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 supports ANSI format codes.
     *
     * @return bool Returns `true` if the stream supports ANSI format codes and
     *              `false` otherwise.
     */
    public function supportsAnsi();

    /**
     * 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();
}