W3cubDocs

/CakePHP 4.4

Class StubConsoleInput

Stub class used by the console integration harness.

This class enables input to be stubbed and have exceptions raised when no answer is available.

Namespace: Cake\Console\TestSuite

Property Summary

  • $_canReadline protected
    bool

    Can this instance use readline? Two conditions must be met:

    1. Readline support must be enabled.
    2. Handle we are attached to must be stdin. Allows rich editing with arrow keys and history when inputting a string.
  • $_input protected
    resource

    Input value.

  • $currentIndex protected
    int

    Current message index

  • $replies protected
    array<string>

    Reply values for ask() and askChoice()

Method Summary

Method Detail

__construct() public 

__construct(array<string> $replies)

Constructor

Parameters

array<string> $replies

A list of replies for read()

dataAvailable() public 

dataAvailable(int $timeout = 0): bool

Check if data is available on stdin

Parameters

int $timeout optional

An optional time to wait for data

Returns

bool

read() public 

read(): string

Read a reply

Returns

string

Property Detail

$_canReadline protected

Can this instance use readline? Two conditions must be met:

  1. Readline support must be enabled.
  2. Handle we are attached to must be stdin. Allows rich editing with arrow keys and history when inputting a string.

Type

bool

$_input protected

Input value.

Type

resource

$currentIndex protected

Current message index

Type

int

$replies protected

Reply values for ask() and askChoice()

Type

array<string>

© 2005–present The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
https://api.cakephp.org/4.4/class-Cake.Console.TestSuite.StubConsoleInput.html