Mathielen Import Engine Bundle

Introduction

This is a bundle for the mathielen/import-engine library. It provides an easy way to configure a full-blown data importer for you symfony2 project.

Installation

This library is available on Packagist:

To install it, run:

$ composer require mathielen/import-engine-bundle:dev-master

Then add the bundle to app/AppKernel.php:

public function registerBundles()
{
    return array(
        ...
        new Mathielen\ImportEngineBundle\MathielenImportEngineBundle(),
        ...
    );
}

Configuration

Add your importer configurations in your app/config/config.yml.

Full example:

mathielen_import_engine:
    #configure storageproviders, that are used in all importers
    storageprovider:
        upload:
            type: upload
            uri: "%kernel.root_dir%/Resources/import"
        local:
            type: directory
            uri: /tmp/somedir
        doctrine:
            type: doctrine
            queries:
                - SELECT id FROM Acme\DemoBundle\Entity\Person P WHERE P.age > 10
                - Acme\DemoBundle\Entity\ImportData
                
    #configure your Importers
    importers:
        your_importer_name:

            #automaticly recognize this importer by meeting of the conditions below
            preconditions:
                format: excel               #format of data must be [csv, excel, xml]
                fieldcount: 2               #must have this number of fields
                fields:                     #these fields must exist (order is irrelevant)
                    - 'header2'
                    - 'header1'
                fieldset:                   #all fields must exist exactly this order
                    - 'header1'
                    - 'header2'
                filename: 'somefile.xls'    #filename must match one of these regular expression(s) (can be a list)

            #use an object-factory to convert raw row-arrays to target objects
            object_factory:
                type: jms_serializer        #[jms_serializer, ~]
                class: Acme\DemoBundle\ValueObject\MyImportedRow

            #validate imported data
            validation:
                source:                     #add constraints to source fields
                    header1: email
                    header2: notempty
                target: ~                   #activate validation against generated object from object-factory (via annotations, xml)
                                            #or supply list of constraints like in source

            #target of import
            target:
                type: service               #[service, doctrine, file]
                service: import_service     #service name in DIC
                method: processImportRow    #method to invoke on service

Minimum example:

mathielen_import_engine:
    importers:
        minimum_importer:
            target:
                type: file
                uri: /tmp/myfile.csv
                format: csv

Usage

use Mathielen\ImportEngine\ValueObject\ImportConfiguration;
use Symfony\Component\HttpFoundation\Request;
use Sensio\Bundle\FrameworkExtraBundle\Configuration\Route;
use Sensio\Bundle\FrameworkExtraBundle\Configuration\Template;

class DemoController extends Controller
{

    /**
     * @Route("/import", name="_demo_import")
     * @Template()
     */
    public function importAction(Request $request)
    {
        //handle the uploaded file
        $storageLocator = $this->container->get('mathielen_importengine.import.storagelocator');
        $storageSelection = $storageLocator->selectStorage('default', $request->files->getIterator()->current());

        //create a new import configuration with your file for the specified importer
        //you can also use auto-discovery with preconditions (see config above and omit 2nd parameter here)
        $importConfiguration = new ImportConfiguration($storageSelection, 'your_importer_name');

        //build the import engine
        $importBuilder = $this->container->get('mathielen_importengine.import.builder');
        $importBuilder->build($importConfiguration);

        //run the import
        $importRunner = $this->container->get('mathielen_importengine.import.runner');
        $importRun = $importRunner->run($importConfiguration->toRun());

        return $importRun->getStatistics();
    }

}

Todos

• Xml Configuration with validation constraint lists doesnt work