codebrisk/bbcodeparser

Parse your BBCode easy with this library.

, _(*1)

BBCodeParser

BBCodeParser is a standalone library that parses all(?) the common bbcode tags. The easiest way to install is via composer and is equally as easy to integrate into Laravel 4, _(*2)

The available tags are:, _(*3)

• [b][/b] Bold
• [i][/i] Italic
• [u][/u] Underline
• [s][/s] Line through
• [size=4][/size] Font size
• [color=#eee][/color] Font color
• [center][/center] Center
• [quote][/quote] Quote
• [quote=John Doe][/] Named quote
• [url][/url] Link
• [url=http://example.com]example.com[/url] Named link
• [img]http://example.com]example.com/logo.png[/img] Image
• [list=1][/list] Ordered list (numerical)
• [list=a][/list] Ordered list (alphabetically)
• [list][/list] Unordered list
• [*] List item
• [code][/code] Code
• [youtube][/youtube] Youtube

Installation

The easiest way to install the BBCodeParser library is via composer. If you don´t now what composer is or how you use it you can find more information about that at their website., _(*4)

Composer

You can find the BBCodeParser class via Packagist. Require the package in your composer.json file., _(*5)

"golonka/bbcodeparser": "1.3"

Then you run install or update to download your new requirement, _(*6)

php composer.phar install

or, _(*7)

php composer.phar update

Now you are able to require the vendor/autoload.php file to PSR-0 autoload the library., _(*8)

Example

// include composer autoload
require 'vendor/autoload.php';

// import the BBCodeParser Class
use Golonka\BBCode\BBCodeParser;

// Lets parse!
$bbcode = new BBCodeParser;
$bbcode->parse('[b]Bold[/b]'); // <b>Bold</b>

If you´re a fan of Laravel 4 then the integration is made in a blink of an eye. We will go through how that is done below., _(*9)

Laravel 4 integration

The BBCodeParser Class has optional Laravel 4 support and comes with a Service Provider and Facades for easy integration. After you have done the installation correctly, just follow the instructions., _(*10)

Open your Laravel config file config/app.php and add the following lines., _(*11)

In the $providers array add the service providers for this package., _(*12)

'Golonka\BBCode\BBCodeParserServiceProvider'

Add the facade of this package to the $aliases array., _(*13)

'BBCode' => 'Golonka\BBCode\Facades\BBCodeParser'

Now the BBCodeParser Class will be auto-loaded by Laravel., _(*14)

Example

By default all tags will be parsed, _(*15)

BBCode::parse('[b]bold[/b][i]italic[/i]');

If you would like to use only some tags when you parse you can do that by doing like this, _(*16)

// In this case the [i][/i] tag will not be parsed
BBCode::only('bold')->parse('[b]bold[/b][i]italic[/i]');

or, _(*17)

// In this case all tags except [b][/b] will be parsed
BBCode::except('bold')->parse('[b]bold[/b][i]italic[/i]');

Custom Parsers

You can add new custom parsers or overwrite existing parsers., _(*18)

// name, pattern, replace
BBCode::setParser('mailurl', '/\[mailurl\](.*)\[\/mailurl\]/', '<a href="mailto:$1">$1</a>');