Overview

Namespaces

  • Webmozart
    • Console
      • Adapter
      • Api
        • Application
        • Args
          • Format
        • Command
        • Config
        • Event
        • Formatter
        • IO
        • Resolver
      • Args
      • Config
      • Formatter
      • Handler
        • Help
      • IO
        • InputStream
        • OutputStream
      • Process
      • Resolver
      • UI
        • Alignment
        • Component
        • Help
        • Layout
        • Style
      • Util

Classes

  • Input
  • IO
  • Output

Interfaces

  • InputStream
  • OutputStream

Exceptions

  • IOException
  • Overview
  • Namespace
  • Class

Interface OutputStream

The console output stream.

Direct known implementers

Webmozart\Console\IO\OutputStream\BufferedOutputStream, Webmozart\Console\IO\OutputStream\NullOutputStream, Webmozart\Console\IO\OutputStream\StreamOutputStream

Indirect known implementers

Webmozart\Console\IO\OutputStream\ErrorOutputStream, Webmozart\Console\IO\OutputStream\StandardOutputStream
Namespace: Webmozart\Console\Api\IO
Author: Bernhard Schussek bschussek@gmail.com
Since: 1.0
Located at Api/IO/OutputStream.php
Methods summary
public
# write( string $string )

Writes a string to the stream.

Writes a string to the stream.

Parameters

$string
The string to write.

Throws

Webmozart\Console\Api\IO\IOException
If writing fails or if the stream is closed.
public
# flush( )

Flushes the stream and forces all pending text to be written out.

Flushes the stream and forces all pending text to be written out.

Throws

Webmozart\Console\Api\IO\IOException
If flushing fails or if the stream is closed.
public boolean
# supportsAnsi( )

Returns whether the stream supports ANSI format codes.

Returns whether the stream supports ANSI format codes.

Returns

boolean

Returns true if the stream supports ANSI format codes and false otherwise.

public
# close( )

Closes the stream.

Closes the stream.

public boolean
# isClosed( )

Returns whether the stream is closed.

Returns whether the stream is closed.

Returns

boolean
Returns true if the stream is closed.
Webmozart Console API API documentation generated by ApiGen