46 lines
814 B
YAML
46 lines
814 B
YAML
|
name: StreamableInputInterface
|
||
|
|
class_comment: null
|
||
|
|
dependencies: []
|
||
|
|
properties: []
|
||
|
|
methods:
|
||
|
|
- name: setStream
|
||
|
|
visibility: public
|
||
|
|
parameters:
|
||
|
|
- name: stream
|
||
|
|
comment: '# * StreamableInputInterface is the interface implemented by all input
|
||
|
|
classes
|
||
|
|
|
||
|
|
# * that have an input stream.
|
||
|
|
|
||
|
|
# *
|
||
|
|
|
||
|
|
# * @author Robin Chalas <robin.chalas@gmail.com>
|
||
|
|
|
||
|
|
# */
|
||
|
|
|
||
|
|
# interface StreamableInputInterface extends InputInterface
|
||
|
|
|
||
|
|
# {
|
||
|
|
|
||
|
|
# /**
|
||
|
|
|
||
|
|
# * Sets the input stream to read from when interacting with the user.
|
||
|
|
|
||
|
|
# *
|
||
|
|
|
||
|
|
# * This is mainly useful for testing purpose.
|
||
|
|
|
||
|
|
# *
|
||
|
|
|
||
|
|
# * @param resource $stream The input stream'
|
||
|
|
- name: getStream
|
||
|
|
visibility: public
|
||
|
|
parameters: []
|
||
|
|
comment: '# * Returns the input stream.
|
||
|
|
|
||
|
|
# *
|
||
|
|
|
||
|
|
# * @return resource|null'
|
||
|
|
traits: []
|
||
|
|
interfaces: []
|