CakePHP
  • Documentation
    • Book
    • API
    • Videos
    • Reporting Security Issues
    • Privacy Policy
    • Logos & Trademarks
  • Business Solutions
  • Swag
  • Road Trip
  • Team
  • Community
    • Community
    • Get Involved
    • Issues (Github)
    • Bakery
    • Featured Resources
    • Training
    • Meetups
    • My CakePHP
    • CakeFest
    • Newsletter
    • Linkedin
    • YouTube
    • Facebook
    • Twitter
    • Mastodon
    • Help & Support
    • Forum
    • Stack Overflow
    • IRC
    • Slack
    • Paid Support
CakePHP

C CakePHP 3.10 Red Velvet API

  • Project:
    • CakePHP
      • CakePHP
      • Authentication
      • Authorization
      • Chronos
      • Elastic Search
      • Queue
  • Version:
    • 3.10
      • 5.2
      • 5.1
      • 5.0
      • 4.6
      • 4.5
      • 4.4
      • 4.3
      • 4.2
      • 4.1
      • 4.0
      • 3.10
      • 3.9
      • 3.8
      • 3.7
      • 3.6
      • 3.5
      • 3.4
      • 3.3
      • 3.2
      • 3.1
      • 3.0
      • 2.10
      • 2.9
      • 2.8
      • 2.7
      • 2.6
      • 2.5
      • 2.4
      • 2.3
      • 2.2
      • 2.1
      • 2.0
      • 1.3
      • 1.2

Namespaces

  • Global
  • Cake
    • Auth
    • Cache
    • Collection
    • Command
    • Console
      • Exception
    • Controller
    • Core
    • Database
    • Datasource
    • Error
    • Event
    • Filesystem
    • Form
    • Http
    • I18n
    • Log
    • Mailer
    • Network
    • ORM
    • Routing
    • Shell
    • TestSuite
    • Utility
    • Validation
    • View

Class ConsoleInput

Object wrapper for interacting with stdin

Namespace: Cake\Console

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.

Method Summary

  • __construct() public

    Constructor

  • dataAvailable() public

    Check if data is available on stdin

  • read() public

    Read a value from the stream

Method Detail

__construct() ¶ public

__construct(string $handle = 'php://stdin')

Constructor

Parameters
string $handle optional

The location of the stream to use as input.

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|false

Read a value from the stream

Returns
string|false

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
OpenHub
Pingping
Linode
  • Business Solutions
  • Showcase
  • Documentation
  • Book
  • API
  • Videos
  • Reporting Security Issues
  • Privacy Policy
  • Logos & Trademarks
  • Community
  • Get Involved
  • Issues (Github)
  • Bakery
  • Featured Resources
  • Training
  • Meetups
  • My CakePHP
  • CakeFest
  • Newsletter
  • Linkedin
  • YouTube
  • Facebook
  • Twitter
  • Mastodon
  • Help & Support
  • Forum
  • Stack Overflow
  • IRC
  • Slack
  • Paid Support

Generated using CakePHP API Docs