wildphp/irc-textformatter

IRC Text Formatter for WildPHP

Maintainers

Details

github.com/WildPHP/irc-textformatter

Source

Issues

Installs: 21

Dependents: 0

Suggesters: 0

Security: 0

Stars: 0

Watchers: 3

Forks: 0

Open Issues: 0

v0.1 2019-01-23 17:55 UTC

Requires

  • php: >=7.0.0

Requires (Dev)

MIT 0d96c86d30625563e8d15322dd9fdb701b06fcac

This package is auto-updated.

Last update: 2024-11-30 01:26:29 UTC

README

Build Status Scrutinizer Code Quality Scrutinizer Code Coverage Latest Stable Version Latest Unstable Version Total Downloads

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 contents
  • consistentStringColor(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.