uniibu/nbbc

An updated composer-compatible fork of the NBBC BBCode parsing library.

Maintainers

Details

github.com/uniibu/nbbc

Source

Issues

Installs: 14

Dependents: 0

Suggesters: 0

Security: 0

Stars: 0

Watchers: 2

Forks: 0

Open Issues: 2

dev-master 2017-04-13 12:07 UTC

Requires

  • php: >=5.4.0

Requires (Dev)

BSDv2 ab45b0ec41b7da3792953355d836fb8fc099b2b7

  • John Sayo <unibtc.woop@gmail.com>

This package is not auto-updated.

Last update: 2025-06-22 06:10:31 UTC

README

Build Status Packagist Version

NBBC is a high-speed, extensible, easy-to-use validating BBCode parser. It was originally developed by Sean Werkema and most of the core code is still his. The core NBBC was last updated officially in 2010. This is forked from https://github.com/vanilla/nbbc.

Changes between this version of NBBC and the vanilla/nbbc project

  • Changed smileys to sprite to lower image downloads
  • Changed smileys to instead of
  • Smileys folder now includes a smileys.png which you can use as the smiley sprite.
  • For smiley css, you can use the smiley.css on the tools folder.

Changes between vanilla/nbbc project and the original project

This project breaks backwards-compatibility with the 1.x version of NBBC which is why it has been given a major version number update even though no significant functionality has been added. Here are a summary of changes.

  • All core classes have been moved into the Nbbc namespace to support PSR-4 autoloading and become a full composer library.
  • PHP 4 is no longer supported. The minimum version of PHP required is now PHP 5.4.
  • All properties on the BBCode class have been protected and must now be accessed with getters/setters.
  • The URL auto-detection has been rewritten. It supports more general cases, but has removed support for some edge cases such as email addresses with an IP address domain.
  • Images and smileys no longer check to see if files exist locally. This removes auto-generated image sizes too.

In addition to backwards-compatibility breaking changes there have been a few other changes that should not break backwards compatibility.

  • Tests have been moved into a PHPUnit test suite.
  • Calls to the EmailAddressValidator have been replaced with PHP's filter_var() function.
  • Calls to the Profiler have been removed from the BBCode class. There are plenty of profiling tools out there now that don't bloat the code.
  • The "@" error silencing operator has been removed wherever possible.

A note on copyright

As noted above, most of the NBBC was written by Sean Werkema and the copyright on that code remains his. There are files that also have a copyright assigned to Vanilla Forums Inc. That additional copyright only applies to the changes made by us. It is not our intention to claim credit for the excellent work done by the original author. We are just following the rules of copyright the best we can. This library will always be licensed under the original open source license (BSDv2).

nbbc-uni