mjohnson/decoda

A lightweight lexical string parser for BBCode styled markup.

6.13.0 2022-11-10 18:39 UTC

Requires

• php: >=7.3.0
• ext-mbstring: *

Requires (Dev)

• ext-json: *
• phpstan/phpstan: ^1.2
• phpunit/phpunit: ^9.5

Suggests

• ext-memcached: Cache data using Memcache
• ext-redis: Cache data using Redis

MIT

• Miles Johnson

• parser
• filter
• markup
• HOOK
• bbcode
• decoda
• lexer

README

A lightweight lexical string parser for BBCode styled markup.

Contributors

• "Marten-Plain" emoticons by Mårten Lundin - http://adiumxtras.com/index.php?a=xtras&xtra_id=6920
• "HTML_BBCodeParser" by Seth Price - http://pear.php.net/package/HTML_BBCodeParser/

Framework Integrations

• CakePHP - using Markup plugin.
• Symfony - using FMBbCodeBundle.

Features

• Parses custom code to valid (X)HTML markup
• Setting to make links and emails auto-clickable
• Setting to use shorthand text for links and emails
• Filters to parse markup and custom code
• Hooks to execute callbacks during the parsing cycle
• Loaders to load resources and files for configuration
• Engines to render complex markup using a template system
• Can censor offensive words
• Can convert smiley faces into images
• Basic support for localized messages
• Parser result caching
• Supports a wide range of tags
• Parent child node hierarchy
• Fixes incorrectly nested tags by removing the broken/unclosed tags
• Self closing tags
• Logs errors for validation
• Tag and attribute aliasing

Filters

The following filters and supported tags are available.

• Default - b, i, u, s, sup, sub, br, hr, abbr, time
• Block - align, float, hide, alert, note, div, spoiler, left, right, center, justify
• Code - code, source, var
• Email - email, mail
• Image - image, img
• List - list, olist, ol, ul, li, *
• Quote - quote
• Text - font, size, color, h1-h6
• Url - url, link
• Video - video, youtube, vimeo, veoh, liveleak, dailymotion, myspace, wegame, collegehumor
• Table - table, thead, tbody, tfoot, tr, td, th, row, col

Hooks

The following hooks are available.

• Censor - Censors all words found within config/censored
• Clickable - Converts all non-tag wrapped URLs and emails into clickable links
• Emoticon - Converts all smilies found within config/emoticons into emoticon images

Storage Engines

The following caching layers are supported.

• In-Memory
• Memcache
• Redis

Installation and Usage

See docs.