igorakaamigo/php5-tiny-bbcode

A tiny BBCode implementation for old PHP5.

1.1.0 2017-12-30 22:49 UTC

Requires

• php: >=5.4

Requires (Dev)

• phpunit/phpunit: 4.8

MIT

• Igor M Osipov

• library
• utils
• bbcode
• php5

README

This library includes a lightweight implementation of a BBCode subset to HTML translator.

Features

• It's tiny, yep.
• PSR-4 autoloading compliant structure
• Unit-Testing with PHPUnit
• Easy to use to any framework or even a plain php file

Installation

The suggested installation method is via composer:

php composer.phar require "igorakaamigo/php5-tiny-bbcode"

Usage

use \Igorakaamigo\Utils\BBCode;

echo BBCode::convert('[b]A bold string[/b]');
// Outputs: <strong>A bold string</strong>

echo BBCode::convert('<span>A text</span>');
// Outputs: &lt;span&gt;A text&lt;/span&gt;

echo BBCode::convert('[i]Hi&nbsp;there![/i]');
// Outputs: <em>Hi&amp;nbsp;there!</em>

echo BBCode::convert('[i]Hi&nbsp;there<br>!!![/i]', ['&nbsp;', '<br>']);
// Outputs: <em>Hi&nbsp;there<br>!!!</em>

echo BBCode::convert('Magic links: email me at [e-mail]');
// Outputs: Magic links: email me at <a href="mailto:[e-mail]">[e-mail]</a>

echo BBCode::convert('Magic links: http://www.domain.tld/path/to/resource');
// Outputs: Magic links: <a href="http://www.domain.tld/path/to/resource">http://www.domain.tld/path/to/resource</a>

Supported BBCodes

• [b]Bold string[/b]
• [i]Italic string[/i]
• [u]Underline string[/u]
• [s]Strikethrough string[/s]
• [email][e-mail][/email]
• [url]http://www.domain.tld[/url]
• [url="http://www.domain.tld"]Another way to render a link[/url] (quotes inside url tag are not necessary)
• [img]http://www.domain.tld/upload/image.png[/img]
• [quote]A quotation[/quote]
• [quote="Quote author"]A quotation[/quote] (quotes inside quote tag are not necessary)
• [code]A program code sample[/code]
• [size="12"]A text written using a 12px-sized font[/size] (quotes inside size tag are not necessary)
• [size="10pt"]A text written using a 10pt-sized font[/size] (quotes inside size tag are not necessary)
• [color="#33FF33"]A green text line[/color] (quotes inside color tag are not necessary)
• [table], [tr], [td] – table-related tags
• [ul], [ol], [li], [*], [list], [list=1|a|A|i|I], [list="1|a|A|i|I"] – list-related tags

[attachment] tag is not supported yet.

Contributing

Just a kata project. Anyway – if one is interested –

Fork --> modify --> pull-request