PHP-Decoda integration in Symfony2

A lightweight lexical string parser for BBCode styled markup.

Installation

To install this bundle, you'll need both the Decoda library and this bundle. Installation depends on how your project is setup:

Step 1: Installation

Add the following lines to your deps file

[php-decoda]
    git=https://github.com/milesj/php-decoda.git
    version=3.5

[FMBbcodeBundle]
    git=https://github.com/helios-ag/FMBbCodeBundle.git
    target=bundles/FM/BbcodeBundle

Run the vendors script::

./bin/vendors install

Or you can use composer to install this bundle: Add FMBbcodeBundle in your composer.json:

{
    "require": {
        "helios-ag/fm-bbcode-bundle": "*"
    }
}

Now tell composer to download the bundle by running the command:

$ php composer.phar update helios-ag/fm-bbcode-bundle

Step 2: Configure the autoloader

Add the following entries to your autoloader:

<?php
// app/autoload.php

$loader->registerNamespaces(array(
    // ...
       'FM' => __DIR__.'/../vendor/bundles',
        // your other namespaces
    ));

$loader->registerPrefixes(array(
    //...
       'Decoda' => __DIR__.'/../vendor/php-decoda/decoda',
    // your other libraries
    ));

Step 3: Enable the bundle

Finally, enable the bundle in the kernel:

<?php
// app/AppKernel.php

public function registerBundles()
{
    $bundles = array(
        // ...
        new FM\BbcodeBundle\FMBbcodeBundle(),
    );
}

Basic configuration

Make the Twig extensions available by updating your configuration:

By default only "default" filter enabled, which provide support
for [b], [i], [u], [s], [sub], [sup] BBCodes

Examples to use the extension in your Twig template

Define BBCode filter in your config.yml:

    fm_bbcode:
      filter_sets:
        my_default_filter:
          locale: ru
          xhtml: true
          filters: [ default ]

And you can do the following:

     {{'[b]Bold text[/b]'|bbcode_filter('my_default_filter')}}
     {{'[u]Underlined text[/u]'|bbcode_filter('my_default_filter')}}
     {{'[i]Italic text[/i]'|bbcode_filter('my_default_filter')}}

    fm_bbcode:
      filter_sets:
        my_default_filter:
          locale: ru
          xhtml: true
          filters: [ default, quote ]
          whitelist: [ b, quote ]

After enabling "quote" filter, you can do such things:

      {{'[quote="helios"]My quote[/quote]'|bbcode_filter('my_default_filter')}}

Also you can define multiple filter sets under filter_sets parameter like this:

    fm_bbcode:
      filter_sets:
        my_forum_filter:
          locale: ru
          xhtml: true
          filters: [ default, quote ]
          whitelist: [ b, quote ]
        my_comment_filter:
          locale: ru
          xhtml: true
          filters: [ default, block, code, email, image, list, quote, text, url, video ]

      {{'[quote="helios"]My quote[/quote]'|bbcode_filter('my_forum_filter')}}
      {{'[code]My source code[/code]'|bbcode_filter('my_comment_filter')}}

Please keep in mind, that whitelist tags overrides filters configuration.

Advanced usage

FMBBcode bundle allow you to extend php-decoda functionality, you can extend available tags via filters and hooks,
change messages, that used with some tags, and add your own templates. All this options available under config
section of the fm_bbcode node.

Adding own templates

Your own templates can be defined at templates node, the example below shows how:

    fm_bbcode:
        config:
          templates:
            - path: %kernel.root_dir%/Resources/Decoda/templates/

Template examples can be inside decoda library

Adding own filters

You can define, own filters to extend list of supported tags, new filters can be set under filters: section of the
config subnode, example below shows how:

fm_bbcode:
    config:
      filters:
        - { classname: magic, class: \Boom\Bundle\LibraryBundle\Decoda\Filter\MagicFilter }

Adding own hooks

The same technique as above with filters.

fm_bbcode:
    config:
      hooks:
         - { classname: magic, class: \Boom\Bundle\LibraryBundle\Decoda\Filter\MagicFilter }

Adding own messages

Some templates and hooks, use text strings, that can be translated into different languages, the original file
 located under decoda/config directory, but content of this file can be overriden with messages option, under
 messages: node. File should be json formatted.

fm_bbcode:
    config:
      messages: '/some/path/to/somewhere'