Class ConsoleInput
Object wrapper for interacting with stdin
Package:
Cake\
Console
Copyright: Copyright (c) Cake Software Foundation, Inc. ( http://cakefoundation.org)
License: MIT License
Located at Cake/Console/ConsoleInput.php
Copyright: Copyright (c) Cake Software Foundation, Inc. ( http://cakefoundation.org)
License: MIT License
Located at Cake/Console/ConsoleInput.php
Method Detail
__constructsource public
__construct( string $handle 'php://stdin' )
Constructor
Parameters
-
string
$handle
optional 'php://stdin' - The location of the stream to use as input.
dataAvailablesource public
dataAvailable( integer $timeout 0 )
Checks if data is available on the stream
Parameters
-
integer
$timeout
optional 0 - An optional time to wait for data
Returns
boolean
True for data available, false otherwise
Properties summary
$_canReadlinesource
protected boolean
Can this instance use readline? Two conditions must be met:
- Readline support must be enabled.
- Handle we are attached to must be stdin.
Allows rich editing with arrow keys and history when inputting a string.
© 2005–2016 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.
http://api.cakephp.org/2.7/class-ConsoleInput.html