File Manager

Edit File: CliColor.php

<?php

declare(strict_types=1);

namespace Jfcherng\Utility;

/**
 * Make your PHP command-line application colorful.
 *
 * @see https://en.wikipedia.org/wiki/ANSI_escape_code
 *
 * @author Jack Cherng <jfcherng@gmail.com>
 */
final class CliColor
{
    const COLOR_BEGIN = "\033[";
    const COLOR_END = 'm';

const COLOR_BEGIN_REGEX = "\033\\[";
    const COLOR_END_REGEX = 'm';

/**
     * @var array the color map
     */
    private static $colorMap = [
        // background
        'b_black' => '40',
        'b_blue' => '44',
        'b_cyan' => '46',
        'b_green' => '42',
        'b_light_gray' => '47',
        'b_magenta' => '45',
        'b_red' => '41',
        'b_yellow' => '43',

// foreground
        'f_black' => '30',
        'f_blue' => '34',
        'f_brown' => '33',
        'f_cyan' => '36',
        'f_green' => '32',
        'f_light_gray' => '37',
        'f_normal' => '39',
        'f_purple' => '35',
        'f_red' => '31',

// compound
        'f_dark_gray' => '1;30',
        'f_light_blue' => '1;34',
        'f_light_cyan' => '1;36',
        'f_light_green' => '1;32',
        'f_light_purple' => '1;35',
        'f_light_red' => '1;31',
        'f_white' => '1;37',
        'f_yellow' => '1;33',

// special
        'blink' => '5',
        'bold' => '1',
        'dim' => '2',
        'hidden' => '8',
        'reset' => '0',
        'reverse' => '7',
        'underline' => '4',

// alias
        'b' => 'bold',
        'blk' => 'blink',
        'h' => 'hidden',
        'rev' => 'reverse',
        'rst' => 'reset',
        'u' => 'underline',

// regex for color codes
        'regex_any' => '(?:[0-9]++;?)++',
    ];

/**
     * Get the color map.
     *
     * @return array the color map
     */
    public static function getColorMap(): array
    {
        return self::$colorMap;
    }

/**
     * Make a string colorful.
     *
     * @param string          $str    the string
     * @param string|string[] $colors the colors
     * @param bool            $reset  reset color at the end of the string?
     *
     * @return string the colored string
     */
    public static function color(string $str, $colors = [], bool $reset = true): string
    {
        // always convert $colors into an array
        if (\is_string($colors)) {
            $colors = \explode(',', $colors);
        }

$colored = self::getColorCode($colors) . $str;

if ($reset) {
            $colored .= self::getColorCode(['reset']);
        }

return self::simplifyColoredString($colored);
    }

/**
     * Remove all colors from a string.
     *
     * @param string $str the string
     *
     * @return string the string without colors
     */
    public static function noColor(string $str): string
    {
        return \preg_replace(
            '~' . self::getColorCode(['regex_any'], true) . '~uS',
            '',
            $str
        );
    }

/**
     * Get the color code from given colors.
     *
     * @param array $colors      the colors
     * @param bool  $returnRegex return as an regex segment
     *
     * @return string the color code
     */
    private static function getColorCode(array $colors, bool $returnRegex = false): string
    {
        $colors = self::sanitizeColors($colors);

if (empty($colors)) {
            return '';
        }

// convert color into color code
        $colorCodes = \array_map(
            function (string $color): string {
                // resolve color alias
                while (isset(self::$colorMap[$color])) {
                    $color = self::$colorMap[$color];
                }

return $color;
            },
            $colors
        );

$closures = $returnRegex
            ? [self::COLOR_BEGIN_REGEX, self::COLOR_END_REGEX]
            : [self::COLOR_BEGIN, self::COLOR_END];

return $closures[0] . \implode(';', $colorCodes) . $closures[1];
    }

/**
     * Sanitize colors.
     *
     * @param array $colors the colors
     *
     * @return array the sanitized colors
     */
    private static function sanitizeColors(array $colors): array
    {
        return self::listUnique(\array_filter(
            \array_map('trim', $colors),
            function (string $color): bool {
                return isset(self::$colorMap[$color]);
            }
        ));
    }

/**
     * Simplify the colored string.
     *
     * @param string $str the colored string
     *
     * @return string the simplified colored string
     */
    private static function simplifyColoredString(string $str): string
    {
        // replace multiple consecutive resets with a single reset
        $str = \preg_replace(
            '~(' . self::getColorCode(['reset'], true) . '){2,}~uS',
            '$1',
            $str
        );

// remove colors for an emtpy string
        $str = \preg_replace(
            (
                '~' .
                    '(' . self::getColorCode(['regex_any'], true) . ')' .
                    '(' . self::getColorCode(['reset'], true) . ')' .
                '~uS'
            ),
            '$2',
            $str
        );

return $str;
    }

/**
     * The fastest array_unique() implementation for a non-associative array AFAIK.
     *
     * @see https://stackoverflow.com/questions/8321620/array-unique-vs-array-flip
     *
     * @param array $array the array
     */
    private static function listUnique(array $array): array
    {
        return \array_keys(\array_count_values($array));
    }
}

Back