gnugat/redaktilo-bundle

Provides Redaktilo's Editor and TextFactory as services

Redaktilo Bundle

Provides the following services from Redaktilo in a Symfony2 application:, _(*1)

• redaktilo.editor: an instance of Gnugat\Redaktilo\Editor

Documentation:, _(*2)

• Extending
• Installation
• Usage with Symfony2 DependencyInjection Component standalone
• Further documentation

, _(*3)

Extending

You can also extend Redaktilo by creating new SearchStrategy and new Command., _(*4)

To make your custom Command and SearchStrategy available, simply define them as services in your Symfony2 application and tag them:, _(*5)

services:
    acme_redaktilo.custom_command:
        class: Acme\RedaktiloBundle\Command\CustomCommand
        tags:
            - { name: redaktilo.command }

    acme_redaktilo.custom_search_strategy:
        class: Acme\RedaktiloBundle\Search\SearchStrategy
        tags:
            - { name: redaktilo.search_strategy, priority: 20 }

Note: SearchStrategy's priority is optionnal (defaults to 0). The higher the priority is, the sooner SearchEngine will check if the SearchStrategy supports the given pattern., _(*6)

Installation

Use Composer to install the bundle:, _(*7)

composer require gnugat/redaktilo-bundle:^1.0

Then register the bundle in you kernel. For example:, _(*8)

<?php
// File: app/AppKernel.php

use Symfony\Component\HttpKernel\Kernel;
use Symfony\Component\Config\Loader\LoaderInterface;

class AppKernel extends Kernel
{
    public function registerBundles()
    {
        return array(
            new Symfony\Bundle\FrameworkBundle\FrameworkBundle(),
            new Gnugat\RedaktiloBundle\GnugatRedaktiloBundle(),
        );
    }

    public function registerContainerConfiguration(LoaderInterface $loader)
    {
        $loader->load(__DIR__.'/config/config_'.$this->getEnvironment().'.yml');
    }
}

Usage with Symfony2 DependencyInjection Component standalone

If you're not using the full stack framework, but rather just the Symfony2 DependencyInjection Component, you can still use this bundle:, _(*9)

<?php

use Gnugat\RedaktiloBundle\DependencyInjection\CommandCompilerPass;
use Gnugat\RedaktiloBundle\DependencyInjection\SearchStrategyCompilerPass;
use Symfony\Component\Config\FileLocator;
use Symfony\Component\DependencyInjection\ContainerBuilder;
use Symfony\Component\DependencyInjection\Loader\YamlFileLoader;
use Symfony\Component\HttpKernel\DependencyInjection\Extension;

$container = new ContainerBuilder();
$fileLocator = new FileLocator(__DIR__.'/vendor/gnugat/redaktilo/Resources/config');
$loader = new YamlFileLoader($container, $fileLocator);

$loader->load('services.yml');
$container->addCompilerPass(new SearchStrategyCompilerPass());
$container->addCompilerPass(new CommandCompilerPass());

Further documentation

You can see the current and past versions using one of the following:, _(*10)

• the git tag command
• the releases page on Github
• the file listing the changes between versions

You can find more documentation at the following links:, _(*11)

• copyright and MIT license
• versioning and branching models
• contribution instructions