Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/helios-ag/FMBbCodeBundle

:capital_abcd: BBCode bundle for Symfony projects
https://github.com/helios-ag/FMBbCodeBundle

bbcode bbcode-filter bundle decoda php symfony symfony-bundle twig twig-extension

Last synced: 3 months ago
JSON representation

:capital_abcd: BBCode bundle for Symfony projects

Lists

README

        

FMBBCodeBundle
==============

[PHP-Decoda](https://github.com/milesj/decoda) integration in Symfony2

A lightweight lexical string parser for BBCode styled markup.

## Contributors

* **Alexandre Quercia [alquerci](https://github.com/alquerci)**
* Gaiffe Antoine [toinouu](https://github.com/toinouu)
* Luis Íñiguez [idetia](https://github.com/idetia)
* Sebastian [slider](https://github.com/slider)
* [olleyyy](https://github.com/olleyyy)
* Dirk Olbertz [dolbertz](https://github.com/dolbertz)
* Florian Krauthan [fkrauthan](https://github.com/fkrauthan)
* [predakanga](https://github.com/predakanga)
* Dan [piratadelfuturo](https://github.com/piratadelfuturo)

### Code Quality Assurance ###

| SLInsight | Travis CI | Gitter | Coverage | StyleCI |
| ----------|-----------|---------|----------|---------|
|[![SensioLabsInsight](https://insight.sensiolabs.com/projects/f355c58b-f9b6-482c-8d2d-d1bc8791c9e5/big.png)](https://insight.sensiolabs.com/projects/f355c58b-f9b6-482c-8d2d-d1bc8791c9e5) |[![Build Status](https://travis-ci.org/helios-ag/FMBbCodeBundle.png?branch=master)](https://travis-ci.org/helios-ag/FMBbCodeBundle)|[![Join the chat at https://gitter.im/helios-ag/FMBbCodeBundle](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/helios-ag/FMBbCodeBundle?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)|[![Coverage Status](https://coveralls.io/repos/helios-ag/FMBbCodeBundle/badge.svg?branch=master&service=github)](https://coveralls.io/github/helios-ag/FMBbCodeBundle?branch=master)|[![StyleCI](https://styleci.io/repos/2714013/shield)](https://styleci.io/repos/2714013)|

| Deps Status | Version | Downloads |
| ----------|-----------|---------|
|[![Dependency Status](https://www.versioneye.com/user/projects/53db56c04b3ac87d6a000207/badge.svg?style=flat)](https://www.versioneye.com/user/projects/53db56c04b3ac87d6a000207)|[![Latest Stable Version](https://poser.pugx.org/helios-ag/fm-bbcode-bundle/version.png)](https://packagist.org/packages/helios-ag/fm-bbcode-bundle)|[![Total Downloads](https://poser.pugx.org/helios-ag/fm-bbcode-bundle/d/total.png)](https://packagist.org/packages/helios-ag/fm-bbcode-bundle)|

## Installation

To install this bundle, you'll need both the [Decoda library](https://github.com/milesj/decoda)
and this bundle. Installation depends on how your project is setup:

### Step 1: Installation

Using Composer, just add the following configuration to your `composer.json`:

Or you can use composer to install this bundle:

For symfony <3.0, use latest ~6 version

```sh
composer require helios-ag/fm-bbcode-bundle:~6
```

for Symfony 3

```sh
composer require helios-ag/fm-bbcode-bundle
```
or

```sh
composer require helios-ag/fm-bbcode-bundle:~7
```

### Step 2: Enable the bundle

Finally, enable the bundle in the kernel:

``` php

xHtml: # Default:
smilies:
- ":my_emoticon:"
```

### How to automatically dump emoticons on each deploy

Add the following commands to you projects composer.json:

```json
# composer.json
"scripts": {
"post-install-cmd": [
"FM\\BbcodeBundle\\Composer\\ScriptHandler::installEmoticons"
],
"post-update-cmd": [
"FM\\BbcodeBundle\\Composer\\ScriptHandler::installEmoticons"
]
}
```

To customize emoticons assets folders, use `path` and `folder` node configuration:

```yaml
# app/config.yml

fm_bbcode:
emoticon:
path: # Default: /emoticons
folder: # Default: %kernel.root_dir%/../vendor/mjohnson/decoda/emoticons%
```