romanato/php-coloringo-cli

Colors and styles for PHP CLI output.

1.0 2020-04-08 22:09 UTC

Requires

• php: ^7.2

MIT

• Roman

README

Colors and styles for PHP CLI output.

Installation

composer require romanato/php-coloringo-cli

Usage

// Create new instance
$console = new Romanato\ColoringoCLI\Coloringo;

// Set output
print $console->out('100% Awesomeness');

// Set inline output (without new line)
print $console->inline('100% Awesomeness');

// Set color
print $console->out('Text of this message is red.', 'red');

Advanced usage

// Set other attributes
print $console->out('A lot of attributes!', [
    'color' => 'magenta',
    'background' => 'blue',
    'style' => 'underline'
]);

// Merge more outputs inside one print
print(
    $console->out('This is first line', 'red')
    .$console->inline('This is second line.', [
        'color' => 'yellow',
        'style' => 'bold'
    ])
    .$console->out(' Still second line but gonna make another line.', 'green')
);

Attributes

Available attributes are: color, background, style

Available colors (and backgrounds):

• default
• white
• black
• red
• green
• yellow
• blue
• magenta
• cyan
• light_grey
• dark_grey
• light_red
• light_green
• light_yellow
• light_blue
• light_magenta
• light_cyan

Available styles:

• bold
• dim
• underline
• blink
• reverse
• hidden

Methods

out(string $message [, string|array $attributes])

This method makes an output into CLI with a new line at the end.

print $console->out($output, $attributes);

inline(string $message [, string|array $attributes])

This method makes an output into CLI without a new line at the end.

print $console->inline($output, $attributes);

newLine()

This method creates a new line.

print $console->newLine();

isSupported()

Checks if the php script is running via CLI.

print $console->isSupported();

Properties

Properties of the class are basically the configuration of all colors and styles. You can see all available attributes and their values.

color

Shows all supported (foreground) colors.

print $console->color;

background

Shows all supported (background) colors.

print $console->background;

style

Shows all supported styles.

print $console->style;

attributes

Shows all supported attributes.

print $console->attributes;

Customization

You can set your own colors and styles very easily by editing: Coloringo.php class.

class Coloringo
{
    public $color = [
        '...' => '..',
        'customColor' => 'code'
    ];

    public $background = [
        '...' => '..',
        'customBackground' => 'code'
    ];

    public $styles = [
        '...' => '..',
        'customStyle' => 'code'
    ];
}