backender/epiceditor-bundle

Symfony2 bundle for easy integration of the EpicEditor

Symfony2 BackenderEpiceditorBundle

This bundle provides a EpicEditor integration for your Symfony2 Project. It simply adds the form field type epiceditor to the Form Component., _(*1)

For more information about EpicEditor see: http://oscargodson.github.com/EpicEditor/, _(*2)

Installation

1. Add BackenderEpiceditorBundle to your composer.json
2. Enable the bundle
3. Install bundle assets
4. Configure the bundle (optional)
5. Add the editor to a form

Step 1: Add BackenderEpiceditorBundle to your composer.json

{
    "require": {
        "Backender/epiceditor-bundle": "*"
    }
}

Update your project dependencies:, _(*3)

php composer.phar update Backender/epiceditor-bundle

Step 2: Enable the bundle

``` php <?php // app/AppKernel.php, <sub>(*4)</sub>

public function registerBundles() { $bundles = array( // ... new Backender\EpiceditorBundle\BackenderEpiceditorBundle(), ); }, <sub>(*5)</sub>

### Step 3: Install bundle assets
```bash
$ php ./app/console assets:install web --symlink

--symlink is optional, <sub>(*6)</sub>

Step 4: Configure the bundle (optional)

For a full configuration dump use:, <sub>(*7)</sub>

$ php ./app/console config:dump-reference BackenderEpiceditorBundle

An example configuration:, <sub>(*8)</sub>

backender_epiceditor:  
    class:                Backender\EpiceditorBundle\Form\Type\EpiceditorType 
    container:            epiceditor 
    basepath:             /web/bundles/backenderepiceditor 
    clientSideStorage:    true 
    localStorageName:     epiceditor 
    parser:               marked 
    focusOnLoad:          false 
    file:                 
        name:                 epiceditor 
        defaultContent:       
        autoSave:             100 
    theme:                
        base:                 /themes/base/epiceditor.css 
        preview:              /themes/preview/github.css 
        editor:               /themes/editor/epic-dark.css 
    shortcut:             
        modifier:             18 
        fullscreen:           70 
        preview:              80 
        edit:                 79 

Or even overwrite the configuration within a FormBuilder (see Step 5)., <sub>(*9)</sub>

Step 5: Add the editor to a form

Example form:, <sub>(*10)</sub>

<?php

$form = $this->createFormBuilder($post)
    ->add('content', 'epiceditor', array(
            'container'             => 'epiceditor',
            'basepath'              => '/~marc/blog/web/bundles/backenderepiceditor',
            'clientSideStorage'     => true,
            'localStorageName'      => 'epiceditor',
            'parser'                => 'marked',
            'focusOnLoad'           => false,
            'file'                  => array(
                'name'              => 'epiceditor',
                'defaultContent'    => '',
                'autoSave'          => 100
            ),
            'theme'                 => array(
                'base'              => '/themes/base/epiceditor.css',
                'preview'           => '/themes/preview/github.css',
                'editor'            => '/themes/editor/epic-dark.css'
            ),
            'shortcut'              => array(
                'modifier'          => 18,
                'fullscreen'        => 70,
                'preview'           => 80,
                'edit'              => 79
            )
        ))
        ->getForm()
;

Note: All parameters from config.yml can be overwritten in a form (excluding class)., <sub>(*11)</sub>

Contribute

If the bundle doesn't allow you to customize an option, I invite you to fork the project, create a feature branch, and send a pull request., <sub>(*12)</sub>

To ensure a consistent code base, you should make sure the code follows the Coding Standards., <sub>(*13)</sub>

License

This bundle is under the MIT license. See the complete license here., <sub>(*14)</sub>

Next Steps

• Testing is coming soon