alecrabbit/php-console-colour

Helps to do colored console output.

0.10.1 2021-07-30 08:19 UTC

Requires

• php: >=7.2
• alecrabbit/php-cli-tools: ^0.6

Requires (Dev)

• alecrabbit/php-helpers: ^0.8
• nunomaduro/collision: ^4.2
• phpunit/phpunit: ^8.5
• symfony/var-dumper: ^5.0

MIT

• console
• output
• color
• terminal
• ansi
• colour
• width
• height

README

Installation

composer require alecrabbit/php-console-colour

Themes::class

Usage

$themes = new Themes();
echo $themes->red('This text is red.') . PHP_EOL;
echo $themes->underlinedBold('This text is underlined and bold.') . PHP_EOL;

Basically methods of this class just applying corresponding escape sequences to $text

// "\033[2;3mThis text is dark and italic.\033[0m"
$colorized = $themes->darkItalic('This text is dark and italic.')

Methods

Note: not all methods could be listed.

/**
 * @method comment(string $text)
 * @method error(string $text)
 * @method info(string $text)
 *
 * @method yellow(string $text)
 * @method red(string $text)
 * @method green(string $text)
 * @method cyan(string $text)
 * @method magenta(string $text)
 *
 * @method italic(string $text)
 * @method bold(string $text)
 * @method dark(string $text)
 * @method darkItalic(string $text)
 * @method white(string $text)
 * @method whiteBold(string $text)
 * @method underlined(string $text)
 * @method underlinedBold(string $text)
 * @method underlinedItalic(string $text)
 */

Note: new methods will be added. Pull requests are welcomed.

Define your own themes

• Themes::class How to extend?

ConsoleColor::class

// TODO

XTerm 256 Colors Table

• xterm-colors.php

Examples

• using_themes_class.php

• colour.php

Note: actual colors depend on your terminal color scheme

Links

• xterm-256-color Chart
• 256 COLORS - CHEAT SHEET
• XVilka/TrueColour.md
• inspired by JakubOnderka/PHP-Console-Color