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:  59:  60:  61:  62:  63:  64:  65:  66:  67:  68:  69:  70:  71:  72:  73:  74:  75:  76:  77:  78:  79:  80:  81:  82:  83:  84:  85:  86:  87:  88:  89:  90:  91:  92:  93:  94:  95:  96:  97:  98:  99: 100: 101: 102: 103: 104: 105: 106: 107: 108: 109: 110: 111: 112: 113: 114: 115: 116: 117: 118: 119: 120: 121: 122: 123: 124: 125: 126: 127: 128: 129: 130: 131: 132: 133: 134: 135: 136: 137: 138: 139: 140: 141: 142: 143: 144: 145: 146: 147: 148: 149: 

<?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.
 *
 * This class wraps an input stream and adds convenience functionality for
 * reading that stream.
 *
 * @since  1.0
 *
 * @author Bernhard Schussek <bschussek@gmail.com>
 */
class Input
{
    /**
     * @var InputStream
     */
    private $stream;

    /**
     * @var bool
     */
    private $interactive = true;

    /**
     * Creates an input for the given input stream.
     *
     * @param InputStream $stream The input stream.
     */
    public function __construct(InputStream $stream)
    {
        $this->stream = $stream;
    }

    /**
     * Reads the given amount of characters from the input stream.
     *
     * @param int    $length  The number of characters to read.
     * @param string $default The default to return if interaction is disabled.
     *
     * @return string The characters read from the input stream.
     *
     * @throws IOException If reading fails or if the input stream is closed.
     */
    public function read($length, $default = null)
    {
        if (!$this->interactive) {
            return $default;
        }

        return $this->stream->read($length);
    }

    /**
     * Reads a line from the input stream.
     *
     * @param string $default The default to return if interaction is disabled.
     * @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 input stream.
     *
     * @throws IOException If reading fails or if the input stream is closed.
     */
    public function readLine($default = null, $length = null)
    {
        if (!$this->interactive) {
            return $default;
        }

        return $this->stream->readLine($length);
    }

    /**
     * Closes the input.
     */
    public function close()
    {
        $this->stream->close();
    }

    /**
     * Returns whether the input is closed.
     *
     * @return bool Returns `true` if the input is closed and `false`
     *              otherwise.
     */
    public function isClosed()
    {
        return $this->stream->isClosed();
    }

    /**
     * Sets the underlying stream.
     *
     * @param InputStream $stream The input stream.
     */
    public function setStream(InputStream $stream)
    {
        $this->stream = $stream;
    }

    /**
     * Returns the underlying stream.
     *
     * @return InputStream The input stream.
     */
    public function getStream()
    {
        return $this->stream;
    }

    /**
     * Enables or disables interaction with the user.
     *
     * @param bool $interactive Whether the inputmay interact with the user. If
     *                          set to `false`, all calls to {@link read()} and
     *                          {@link readLine()} will immediately return the
     *                          default value.
     */
    public function setInteractive($interactive)
    {
        $this->interactive = (bool) $interactive;
    }

    /**
     * Returns whether the user may be asked for input.
     *
     * @return bool Returns `true` if the user may be asked for input and
     *              `false` otherwise.
     */
    public function isInteractive()
    {
        return $this->interactive;
    }
}