wildphp / irc-textformatter
IRC Text Formatter for WildPHP
v0.1
2019-01-23 17:55 UTC
Requires
- php: >=7.0.0
Requires (Dev)
- phpunit/phpunit: ^6
- squizlabs/php_codesniffer: ^3.0
This package is auto-updated.
Last update: 2024-10-30 01:21:32 UTC
README
Tiny library to format text according to the IRC standard.
Installation
To install this package, you need Composer.
$ composer require wildphp/irc-textformatter ^0.1
Usage
The formatter works as a utility class. It exposes the following methods:
bold(string $text)
italic(string $text)
underline(string $text)
color(string $text, string $foreground, string $background = '')
(see below what colors are supported)
Along with the above basic methods, some more advanced methods are provided:
findColorByString(string $color)
- returns a numeric string with the color code based on human readable input ('white' will return '00', see the color table below)calculateStringColor(string $stringToColor)
- returns a numeric string with color code based on string contentsconsistentStringColor(string $stringToColor)
- same as above, but pre-applies the color to the string
It also allows you to strip various formatting elements from text:
stripBold(string $text)
stripItalic(string $text)
stripUnderline(string $text)
stripColor(string $text)
Color table
Contributors
You can see the full list of contributors in the GitHub repository.