Documentation

Console
in package

FinalYes

Table of Contents

Constants

STDERR  = 2
STDIN  = 0
STDOUT  = 1

Methods

getNumberOfColumns()  : int
Returns the number of columns of the terminal.
hasColorSupport()  : bool
Returns true if STDOUT supports colorization.
isInteractive()  : bool
Returns if the file descriptor is an interactive terminal or not.
getNumberOfColumnsInteractive()  : int
getNumberOfColumnsWindows()  : int
isWindows()  : bool

Constants

Methods

getNumberOfColumns()

Returns the number of columns of the terminal.

public getNumberOfColumns() : int
Tags
codeCoverageIgnore
Return values
int

hasColorSupport()

Returns true if STDOUT supports colorization.

public hasColorSupport() : bool

This code has been copied and adapted from Symfony\Component\Console\Output\StreamOutput.

Return values
bool

isInteractive()

Returns if the file descriptor is an interactive terminal or not.

public isInteractive([int|resource $fileDescriptor = self::STDOUT ]) : bool

Normally, we want to use a resource as a parameter, yet sadly it's not always available, eg when running code in interactive console (php -a), STDIN/STDOUT/STDERR constants are not defined.

Parameters
$fileDescriptor : int|resource = self::STDOUT
Return values
bool

getNumberOfColumnsInteractive()

private getNumberOfColumnsInteractive() : int
Tags
codeCoverageIgnore
Return values
int

getNumberOfColumnsWindows()

private getNumberOfColumnsWindows() : int
Tags
codeCoverageIgnore
Return values
int

isWindows()

private isWindows() : bool
Return values
bool

        
On this page

Search results