3f/converter

A set of classes to translate a text from HTML to BBcode and from BBCode to Markdown.

, _(*1)

Converter

A set of classes to translate a text from HTML to BBCode and from BBCode to Markdown., _(*2)

The HTML to BBCode converter, in particular, has not been created with the intent to convert an entire HTML page, but just to convert a set of HTML tags used to format articles and blog posts in the HTML era, when Markdown and BBcode didn't exist at all., _(*3)

The special BBCode to Markdown converter is able to convert: bold, italic, underline and strikethrough texts, lists, urls, images, quotes and even code blocks (snippets)., _(*4)

Composer Installation

To install Converter, you first need to install Composer, a Package Manager for PHP, following these few steps:, _(*5)

curl -s https://getcomposer.org/installer | php

You can run this command to easily access composer from anywhere on your system:, _(*6)

sudo mv composer.phar /usr/local/bin/composer

Converter Installation

Once you have installed Composer, it's easy install Converter., _(*7)

1. Edit your composer.json file, adding Converter to the require section:

{
    "require": {
        "3f/converter": "dev-master"
    },
}

1. Run the following command in your project root dir:

composer update

Usage

There are two classes: HTMLConverter and BBCodeConverter. The first class may be used to convert from HTML to BBCode, while the second one is used to convert from BBCode to Markdown., _(*8)

HTML to BBCode conversion:, _(*9)

$converter = new Converter\HTMLConverter($text, $id);
echo $converter->toBBCode();

BBCode to Markdown conversion:, _(*10)

$converter = new Converter\BBCodeConverter($text, $id);
echo $converter->toMarkdown();

In both cases the $id is optional. When provided is used in case an exception is raised during the conversion process., _(*11)

Documentation

The documentation can be generated using Doxygen. A Doxyfile is provided for your convenience., _(*12)

Requirements

• PHP 5.4.0 or above.

Authors

Filippo F. Fadda - filippo.fadda@programmazione.it - http://www.linkedin.com/in/filippofadda, _(*13)

License

Converter is licensed under the Apache License, Version 2.0 - see the LICENSE file for details., _(*14)