cakephp2-php8/lib/Cake/Console/ConsoleInput.php

83 lines
2 KiB
PHP
Raw Normal View History

2010-10-05 03:18:59 +00:00
<?php
/**
* ConsoleInput file.
*
2017-06-10 21:33:55 +00:00
* CakePHP(tm) : Rapid Development Framework (https://cakephp.org)
* Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
2010-10-05 03:18:59 +00:00
*
* Licensed under The MIT License
* For full copyright and license information, please see the LICENSE.txt
2010-10-05 03:18:59 +00:00
* Redistributions of files must retain the above copyright notice.
*
* @copyright Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
2017-06-10 21:33:55 +00:00
* @link https://cakephp.org CakePHP(tm) Project
* @package Cake.Console
2010-10-05 03:18:59 +00:00
* @since CakePHP(tm) v 2.0
* @license http://www.opensource.org/licenses/mit-license.php MIT License
2010-10-05 03:18:59 +00:00
*/
2010-10-05 03:18:59 +00:00
/**
2011-08-16 03:55:08 +00:00
* Object wrapper for interacting with stdin
2010-10-05 03:18:59 +00:00
*
* @package Cake.Console
2010-10-05 03:18:59 +00:00
*/
class ConsoleInput {
2010-10-05 03:18:59 +00:00
/**
* Input value.
*
* @var resource
*/
protected $_input;
2013-09-01 21:58:23 +00:00
/**
* 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.
*
* @var bool
*/
protected $_canReadline;
2010-10-05 03:18:59 +00:00
/**
* Constructor
*
* @param string $handle The location of the stream to use as input.
2010-10-05 03:18:59 +00:00
*/
public function __construct($handle = 'php://stdin') {
2014-04-29 12:19:33 +00:00
$this->_canReadline = extension_loaded('readline') && $handle === 'php://stdin' ? true : false;
$this->_input = fopen($handle, 'r');
2010-10-05 03:18:59 +00:00
}
/**
* Read a value from the stream
*
* @return mixed The value of the stream
*/
public function read() {
if ($this->_canReadline) {
$line = readline('');
if (!empty($line)) {
readline_add_history($line);
}
return $line;
}
2010-10-05 03:18:59 +00:00
return fgets($this->_input);
}
2013-02-02 13:39:16 +00:00
/**
* Checks if data is available on the stream
*
* @param int $timeout An optional time to wait for data
* @return bool True for data available, false otherwise
2013-02-02 13:39:16 +00:00
*/
public function dataAvailable($timeout = 0) {
$readFds = array($this->_input);
$readyFds = stream_select($readFds, $writeFds, $errorFds, $timeout);
return ($readyFds > 0);
}
}