ermarian/xbbcode

An extensible BBCode parser utility.

XBBCode

This is a parser for the BBCode markup language, supporting arbitrary rendering plugins for every tag., _(*1)

Installation

Add the library to your composer dependencies as follows:, _(*2)

composer require ermarian/xbbcode, _(*3)

Usage

The parser can be invoked as follows:, _(*4)

 new TemplateTagProcessor('{content}'),
  'url' => new CallbackTagProcessor(function(TagElementInterface $tag) {
    $url = htmlspecialchars($tag->getOption());
    return '<strong>Hello <a href="http://example.com">world</a>!</strong>

More powerful processor plugins can simply extend TagProcessorBase and implement doProcess to perform their own rendering., _(*5)

Syntax

The syntax of BBCode used here is as follows:, _(*6)

text = { VCHAR / LWSP / element1 /.../ elementN }

Where every elementN takes the following form (for a specific value of $name that contains only lowercase alphanumeric characters and underscores), _(*7)

elementN = "[$name" argument "]" text "[/$name]"
argument = option / { WSP attribute }
option = "=" option-value
attribute = name "=" attribute-value
name = { ALPHA | DIGIT | "_" }

The option-value and attribute-value strings must be quoted or escape terminating delimiters (spaces and ]) with backslashes., _(*8)

Tags must be correctly nested, and are otherwise skipped. For example, in the input [b][i][/b][/i], only the [b] tag will be parsed., _(*9)