PHPackages                             krypt0nn/colorizer - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [CLI & Console](/categories/cli)
4. /
5. krypt0nn/colorizer

ActiveLibrary[CLI & Console](/categories/cli)

krypt0nn/colorizer
==================

Library to work with CLI color codes

0.1.2(4y ago)117GPL-3.0-or-laterPHPPHP >=7.4

Since Dec 31Pushed 4y ago1 watchersCompare

[ Source](https://github.com/krypt0nn/Colorizer)[ Packagist](https://packagist.org/packages/krypt0nn/colorizer)[ Docs](https://github.com/KRypt0nn/Colorizer)[ RSS](/packages/krypt0nn-colorizer/feed)WikiDiscussions master Synced 3w ago

READMEChangelog (3)DependenciesVersions (4)Used By (0)

🚀 Colorizer
===========

[](#-colorizer)

**Colorizer** - небольшая библиотека для работы с [цветовыми управляющими кодами](https://en.wikipedia.org/wiki/ANSI_escape_code#Colors)

### Установка

[](#установка)

```
composer require krypt0nn/colorizer
```

### Использование

[](#использование)

За реализацию подсветки текста отвечают классы `Colorizer\Color` и `Colorizer\Colors`. Класс `Colorizer\Colors` реализует 8 базовых функций добавления цвета в текст:

ФункцияВозвращаемый цветовой кодColors::blackЧёрныйColors::redКрасныйColors::greenЗелёныйColors::yellowЖёлтыйColors::blueСинийColors::magentaФиолетовыйColors::cyanГолубойColors::whiteБелыйУ каждой из описанных выше функций есть два дополнительных аргументы: `bool $bright = false` и `bool $background = false`. Первый отвечает за яркость цвета. К примеру, если вызвать `Colors::black()` - текст станет чёрным, а если `Colors::black(true)` - серым

Второй параметр отвечает за то, куда данный цвет должен применяться - в качестве цвета текста или цвета фона текста. Так, конструкция `Colors::red(false, true) . Colors::yellow()` будет выводить весь последующий текст с красным фоном и жёлтым цветом текста

Чтобы вернуть настройки цвета по умолчанию можно воспользоваться функцией `Colors::reset()`

Для упрощения подсветки какого-то текста существует метод `Colors::format`, принимающий в качестве аргумента строку, содержащую основной текст и необходимые к добавлению цвета в формате `[название цвета,яркость=0,фон=0]`. К примеру, `Colors::format('Hello, [yellow]World[reset]!')` вернёт строку, в которой слово "World" будет подсвечено жёлтым. А из примера выше `Colors::format('Hello, [red,0,1][yellow]World[reset]!')` сделает "World" написанным жёлтым цветом по красному фону

> Обратите внимание на то, что все методы данной библиотеки возвращают управляющие символы, задающие цвета для текста внутри CLI. Это значит, что функция `Colors::yellow()` не делает весь выводимый на экран текст жёлтым. Она возвращает управляющий код, который можно дописать в нужное вам место внутри вашего текста и уже самостоятельно вывести этот текст на экран. Аналогично функция `Colors::format()` лишь заменяет цвета, написанные внутри квадратных скобок, на управляющие коды. Чтобы вывести подсвеченный текст - используйте стандартные операторы вывода, к примеру, функцию `echo`. Примеры этого можно посмотреть ниже

#### Разные способы подсветки жёлтым цветом слова "World"

[](#разные-способы-подсветки-жёлтым-цветом-слова-world)

```