manialib/formatting

Manipulate styles in Maniaplanet strings.

Manialib\Formatting

Manialib\Formatting is a PHP package for manipulating styles in Maniaplanet strings., _(*1)

Learn more about Maniaplanet formatting characters on the wiki., _(*2)

Beta

, _(*3)

This is a work in progress. As long as we don't release a stable version, we might break stuff at any point. If this is a problem, feel free to open an issue and we'll try to help., _(*4)

Features

• Strip styles from strings: links, colors, etc.
• Convert strings to other formats: HTML for now

Find out more in the change log., _(*5)

Requirements

• PHP 8.1+

Installation

Install via Composer:, _(*6)

{
    "require": {
        "manialib/formatting": "^4.0"
    }
}

Usage

Modify styles of a string:, _(*7)

Note the String fluent interface which allows to chain method calls, _(*8)

use Manialib\Formatting\ManiaplanetString;

$nickname = '$l[https://github.com/manialib/formatting]$cfeg$fff๐u1 $666ツ$l';

$string = new ManiaplanetString($nickname);
echo $string->stripColors()->stripLinks();

Will output:, _(*9)

g๐u1 ツ

Convert a string to HTML:, _(*10)

use Manialib\Formatting\ManiaplanetString;

$string = new ManiaplanetString('$cfeg$fff๐u1 $666ツ');

echo $string->toHtml();

Will output:, _(*11)

<span style="color:#cfe;">g</span><span style="color:#fff;">๐u1 </span><span style="color:#666;">ツ</span>

Everything you need for using this should be documented in Manialib/Formatting/StringInterface., _(*12)

Tests

$ php vendor/bin/phpunit, _(*13)

$ php vendor/bin/phpcs --standard=PSR2 src, _(*14)

Development guidelines

We follow best practices from the amazing PHP ecosystem. Warm kudos to Symfony, The PHP League, the PHP subreddit and many more for inspiration and challenging ideas., _(*15)

• We adhere to the best-practices put forward by PHP The Right Way
• We comply to the standards of the PHP-FIG
• We distribute code via Packagist and Composer
• We manage version numbers with Semantic Versioning
• We keep a changelog
• We use Manialib\ as our PHP vendor namespace
• We use manialib/ as our Packagist vendor namespace
• We'll (try to) make documentation & tests :)