corex/terminal

This package is abandoned and no longer maintained. No replacement package was suggested.

Classes and helpers for terminal (based in league/climate + a little more)

2.3.0 2020-05-02 20:09 UTC

Requires

• php: ^7.2
• corex/helpers: ^2.0
• league/climate: ^3.4

Requires (Dev)

• corex/debug: ^1.0
• phpunit/phpunit: ^7.5
• symfony/console: ^4.0 || ^5.0

MIT

• CoRex

README

This package is using package league/climate as base. A few basic static methods has been added for easy access.

It is possible to set Symfony output on Console::class.

Easy access to CLImate

CLImate can easily be reached through singleton method climate(). Documentation for CLImate can be found on https://climate.thephpleague.com/

$climate = Console::climate();
$climate->...

Static often used methods.

// Get width of terminal.
$width = Console::getTerminalWidth();

// Get height of terminal.
$height = Console::getTerminalHeight();

// Show error message(s).
Console::error($messages);

// Show simple message(s) with no styling.
Console::out($messages);

// Show info message(s).
Console::info($messages);

// Show shout message(s).
Console::shout($messages);

// Show warning message(s) in cyan.
Console::warning($messages);

// Show table with option to set new headers.
Console::table(array $rows, array $headers = []);

Additional static methods.

// Show separator (default length = 80. Can be changed through setLineLength*).
Console::separator($character = '-');

// Show header (title through ::info() followed by ::separator('=')).
Console::header($title);

// Show properties in a table with properties at the left.
Console::properties(array $properties, $separator = ':');

// Show list of words (same as implode($separator, $words)).
Console::words(array $words, $separator = ', ');

Credits

This package is heavily based on the awesome work of developers in team league (The League of Extraordinary Packages). All credits for the excellent work goes to them.