ivuorinen/bbcodeparser

Parse your BBCode easy with this library.

v3.0 2018-06-08 10:38 UTC

Requires

• php: >=7

Requires (Dev)

• orchestra/testbench: ~3.0
• phpunit/phpunit: ~5
• squizlabs/php_codesniffer: ~2

MIT

• Ismo Vuorinen
• Joseph Landberg

• parser
• laravel
• bbcode
• PSR-2
• PSR-1
• PSR-4

README

The ivuorinen\BBCodeParser package will help you with parsing BBCode. This package is build on work by Joseph Landberg.

Install

Via Composer

composer require ivuorinen/bbcodeparser

Usage

To parse some text it's as easy as this!

$bbcode = new ivuorinen\BBCode\BBCodeParser();

echo $bbcode->parse('[b]Bold Text![/b]');
// <strong>Bold Text!</strong>

Would like the parser to not use all bbcodes? Just do like this.

$bbcode = new ivuorinen\BBCode\BBCodeParser();

echo $bbcode
    ->only('bold', 'italic')
    ->parse('[b][u]Bold[/u] [i]Italic[/i]![/b]'); // <strong>[u]Bold[/u] <em>Italic</em>!</strong>

echo $bbcode
    ->except('bold')
    ->parse('[b]Bold[/b] [i]Italic[/i]'); // [b]Bold[/b] <em>Italic</em>

By default, the parser is case-sensitive. But if you would like the parser to accept tags like [B]Bold Text[/B] it's really easy.

$bbcode = new ivuorinen\BBCode\BBCodeParser();

// Case insensitive
echo $bbcode->parse('[b]Bold[/b] [I]Italic![/I]', true); // <strong>Bold</strong> <em>Italic!</em>

// Or like this:
echo $bbcode->parseCaseInsensitive('[b]Bold[/b] [i]Italic[/i]'); // <strong>Bold</strong> <em>Italic!</em>

You could also make it more explicit that the parser is case-sensitive by using another helper function.

$bbcode = new ivuorinen\BBCode\BBCodeParser();

echo $bbcode->parseCaseSensitive('[b]Bold[/b] [I]Italic![/I]'); // <strong>Bold</strong> [I]Italic![/I]

If you would like to completely remove all BBCode it's just one function call away.

$bbcode = new ivuorinen\BBCode\BBCodeParser();

echo $bbcode->stripBBCodeTags('[b]Bold[/b] [i]Italic![/i]'); // Bold Italic!

Laravel integration

The integration into Laravel is really easy, and the method is the same for both Laravel 4 and Laravel 5. This package supports Laravel Package Auto-Discovery, so it should be picked up automatically.

If you don't want auto-discovery, or because of old habits, just open your app.php config file.

In there you just add this to your providers array

'ivuorinen\BBCode\BBCodeParserServiceProvider'

And this to your facades array

'BBCode' => 'ivuorinen\BBCode\Facades\BBCodeParser'

The syntax is the same as if you would use it in vanilla PHP but with the BBCode:: before the methods. Here are some examples.

// Simple parsing
echo BBCode::parse('[b]Bold Text![/b]');

// Limiting the parsers with the only method
echo BBCode::only('bold', 'italic')
        ->parse('[b][u]Bold[/u] [i]Italic[/i]![/b]'); // <strong>[u]Bold[/u] <em>Italic</em>!</strong>

// Or the except method
echo BBCode::except('bold')
        ->parse('[b]Bold[/b] [i]Italic[/i]'); // [b]Bold[/b] <em>Italic</em>

Testing

composer test

Contributing

Please see CONTRIBUTING for details.

Credits

• Ismo Vuorinen
• Joseph Landberg
• All Contributors

License

The MIT License (MIT). Please see License File for more information.