Comments on: PHP CLI Colors – PHP Class Command Line Colors (bash)

By: JR

JR — Wed, 26 Oct 2011 08:53:42 +0000

Hi Jesse,

I checked your static function and idea is nice, but it lacks a few things.

1. It’s working only with PHP >= 5.3.0
2. It throws a PHP Notice if background color is not set
3. You have to call some totally random static method if you don’t want any foreground color

Static and much more compatible with earlier PHP versions example could be following:


 
     	class ColorCLI {
                static $foreground_colors = array(
                        'black'        => '0;30', 'dark_gray'    => '1;30',
                        'blue'         => '0;34', 'light_blue'   => '1;34',
                        'green'        => '0;32', 'light_green'  => '1;32',
                        'cyan'         => '0;36', 'light_cyan'   => '1;36',
                        'red'          => '0;31', 'light_red'    => '1;31',
                        'purple'       => '0;35', 'light_purple' => '1;35',
                        'brown'        => '0;33', 'yellow'	 => '1;33',
                        'light_gray'   => '0;37', 'white'        => '1;37',
                );
 
                static $background_colors = array(
                        'black'        => '40', 'red'          => '41',
                        'green'        => '42', 'yellow'       => '43',
                        'blue'         => '44', 'magenta'      => '45',
                        'cyan'         => '46', 'light_gray'   => '47',
                );
 
                // Returns colored string
                public static function getColoredString($string, $foreground_color = null, $background_color = null) {
                        $colored_string = "";
 
                        // Check if given foreground color found
                        if ( isset(self::$foreground_colors[$foreground_color]) ) {
                                $colored_string .= "\033[" . self::$foreground_colors[$foreground_color] . "m";
                        }
                        // Check if given background color found
                        if ( isset(self::$background_colors[$background_color]) ) {
                                $colored_string .= "\033[" . self::$background_colors[$background_color] . "m";
                        }
 
                        // Add string and end coloring
                        $colored_string .=  $string . "\033[0m";
 
                        return $colored_string;
                }
 
                // Returns all foreground color names
                public static function getForegroundColors() {
                        return array_keys(self::$foreground_colors);
                }
 
                // Returns all background color names
                public static function getBackgroundColors() {
                        return array_keys(self::$background_colors);
                }
        }

Example usage:

echo ColorCLI::getColoredString('Test');
echo ColorCLI::getColoredString('Test', 'blue');
echo ColorCLI::getColoredString('Test', null, 'blue');
 
print_r(ColorCLI::getForegroundColors());
print_r(ColorCLI::getBackgroundColors());

By: Jesse Donat

Jesse Donat — Wed, 26 Oct 2011 03:37:01 +0000

I found your version a little over complicated so I simplified it and saved it as a Github Gist here – https://gist.github.com/1315354

There was no real need to require an instance as there are no local members being modified – so its purposely suited to just being accessed from the static state.

By: Ben Harris

Ben Harris — Tue, 07 Jun 2011 11:02:30 +0000

Thanks for this. Like @Scriptster, I’m going to use it for important debug messages/output. I’ve re-written it a bit to shorten the syntax, so to make the text red for example, I use

$c = new Colors();
$c->red(“I’m red”);
$c->green(“I’m green”);

Cheers,

Ben

By: David Ayvazyan

David Ayvazyan — Wed, 27 Oct 2010 15:18:42 +0000

BEST JOB !!!! Great thanks !!!!

By: Scriptster

Scriptster — Wed, 21 Jul 2010 18:45:28 +0000

Thank you for the tip! I admit it never occurred to me to color command line output but you got me thinking now! Many times you have to stare at multi-line outputs of some long running scripts and it’s oh so easy to miss an important line with some sort of an error or warning message in it. It would stand out so much more if it’s, say, red or black on yellow background. I think I’m going to give it a try now.
Thanks!

By: v-nessa.net » Post Archive » Command Line PHP: Part 3

v-nessa.net » Post Archive » Command Line PHP: Part 3 — Tue, 25 May 2010 14:39:09 +0000

[...] – Simple System Maintenance with PHP-CLI Command Line PHP (IBM) Running Daemons in PHP PHP Class for Coloring Command Line Output PHP Command Line Progress Bar Share and [...]

By: PHP Class for Coloring PHP Command Line (CLI) Scripts Output – PHP … | Coder Online

Wed, 13 Jan 2010 23:24:18 +0000

[...] View post: PHP Class for Coloring PHP Command Line (CLI) Scripts Output – PHP … [...]