PHP Color Output

https://github.com/jfcherng/php-color-output
Admin
A PHP library that allows you to easily add color and styles to your command-line output using ANSI...
Tokens:1,472
Snippets:5
Trust Score:9.6
License:MIT
Update:1 year ago
Show doc for...
Tokens:
Raw
### Installation with Composer

Source: https://github.com/jfcherng/php-color-output/blob/master/README.md

This snippet shows how to install the php-color-output library using Composer, the dependency manager for PHP.

```text
composer require jfcherng/php-color-output
```

--------------------------------

### PHP Example Usage

Source: https://github.com/jfcherng/php-color-output/blob/master/README.md

Demonstrates how to use the `CliColor::color` and `CliColor::noColor` functions in PHP to style command-line output. Includes examples of applying single and multiple colors, controlling color reset, and removing color codes.

```php
<?php

include __DIR__ . '/vendor/autoload.php';

use \Jfcherng\Utility\CliColor;

// colors in a string using a comma as the delimiter
echo CliColor::color('foo', 'f_light_cyan, b_yellow');  // "\033[1;36;43mfoo\033[0m"

echo PHP_EOL;

// colors in an array
echo CliColor::color('foo', ['f_white', 'b_magenta']); // "\033[1;37;45mfoo\033[0m"

echo PHP_EOL;

// do not auto reset color at the end of string
echo CliColor::color('foo', ['f_red', 'b_green', 'b', 'blk'], false); // "\033[31;42;1;5mfoo"

// manually add color reset
echo CliColor::color('', 'reset'); // "\033[0m"

echo PHP_EOL;

// remove all color codes from a string
echo CliColor::noColor("\033[31;42;5mfoo\033[0mbar"); // "foobar"

echo PHP_EOL;

```

--------------------------------

### PHP CLI Color Utility Functions

Source: https://github.com/jfcherng/php-color-output/blob/master/README.md

Documentation for the `CliColor` utility class in the php-color-output library. It includes methods for applying colors to strings and removing color codes.

```APIDOC
CliColor:
  color(string $str, string|array $colors = [], bool $reset = true): string
    Make a string colorful.
    Parameters:
      - str: the string to colorize.
      - colors: the color(s) to apply. Can be a comma-separated string or an array of color names.
      - reset: whether to automatically reset the color at the end of the string.
    Returns: the string with ANSI color codes applied.

  noColor(string $str): string
    Remove all colors from a string.
    Parameters:
      - str: the string to process.
    Returns: the string without any ANSI color codes.
```

--------------------------------

### Class Name and Namespace Change (v1 to v2)

Source: https://github.com/jfcherng/php-color-output/blob/master/UPGRADING_v2.md

In version 2 of the PHP Color Output library, the main class name and its namespace have been updated for better organization and consistency. The previous `Jfcherng\Color\Colorful` has been renamed to `Jfcherng\Utility\CliColor`.

```php
// v1
use Jfcherng\Color\Colorful;

// v2
use Jfcherng\Utility\CliColor;
```

--------------------------------

### Helper Function Name Change (v1 to v2)

Source: https://github.com/jfcherng/php-color-output/blob/master/UPGRADING_v2.md

The helper functions used for coloring and removing color from strings have also been renamed in version 2. The functions `str_color` and `str_nocolor` are now `str_cli_color` and `str_cli_nocolor`, respectively, to better reflect their purpose within the CLI context.

```php
// v1
$coloredString = str_color('Hello', 'red');
$plainString = str_nocolor($coloredString);

// v2
$coloredString = str_cli_color('Hello', 'red');
$plainString = str_cli_nocolor($coloredString);
```
Tokens:
Raw