Import CsvFileReader

Hello!

I have several Import Processors.
They must have different settings of delimiter, enclosure and escape here:
https://github.com/orocrm/platform/blob/master/src/Oro/Bundle/ImportExportBundle/Reader/CsvFileReader.php

How I can do this?

Topic

[Yevhen ShyshkinParticipant]

Hello, stalxed.

There are two ways to do that:

1) preferable solution: you can pass these variables to execution context – see this code;

2) another solution: you can extend this reader, override variables and use it in batch job configuration.

[stalxedParticipant]

Thank you for answer!

I use importexport configuration like in this bundle:
https://github.com/orocrm/crm/blob/master/src/OroCRM/Bundle/ContactBundle/Resources/config/importexport.yml

For example, how from OroCRMContactBundle pass this variables to execution context?
I spent a few hours, but did not understand how to do it.

[stalxedParticipant]

I think I cant do it from here
https://github.com/orocrm/platform/blob/master/src/Oro/Bundle/ImportExportBundle/Processor/ImportProcessor.php
In documentation he called after the read operation.
Or am I wrong?
If I’m not mistaken, where else can I set the context variables?(before call the function initializeFromContext in CsvFileReader).

[stalxedParticipant]

I found solution:
1) Need create listener:

<?php namespace Acme\ImportExportBundle\Listener; use Akeneo\Bundle\BatchBundle\Entity\JobInstance; use Akeneo\Bundle\BatchBundle\Event\StepExecutionEvent; use Oro\Bundle\ImportExportBundle\Job\JobExecutor; class ImportExportListener { public function changeCsv(StepExecutionEvent $event) { $jobInstance = $event ->getStepExecution() ->getJobExecution() ->getJobInstance(); if (! $this->isImport($jobInstance)) { return; } $rawConfiguration = $jobInstance->getRawConfiguration(); $rawConfiguration = $this->changeRawConfiguration($rawConfiguration); $jobInstance->setRawConfiguration($rawConfiguration); } private function isImport(JobInstance $jobInstance) { if ($jobInstance->getAlias() == JobExecutor::JOB_IMPORT_FROM_CSV) { return true; } if ($jobInstance->getAlias() == JobExecutor::JOB_VALIDATE_IMPORT_FROM_CSV) { return true; } return false; } private function changeRawConfiguration($rawConfiguration) { $processorAlias = $rawConfiguration['import_validation']['processorAlias']; if ($processorAlias == 'my_processor') { $rawConfiguration['import_validation']['delimiter'] = '|'; $rawConfiguration['import_validation']['enclosure'] = '"'; $rawConfiguration['import_validation']['escape'] = '\\'; } return $rawConfiguration; } }

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51

<?php namespace Acme\ImportExportBundle\Listener;   use Akeneo\Bundle\BatchBundle\Entity\JobInstance; use Akeneo\Bundle\BatchBundle\Event\StepExecutionEvent; use Oro\Bundle\ImportExportBundle\Job\JobExecutor;   class ImportExportListener {     public function changeCsv(StepExecutionEvent $event)     {         $jobInstance = $event             ->getStepExecution()             ->getJobExecution()             ->getJobInstance();           if (! $this->isImport($jobInstance)) {             return;         }           $rawConfiguration = $jobInstance->getRawConfiguration();         $rawConfiguration = $this->changeRawConfiguration($rawConfiguration);         $jobInstance->setRawConfiguration($rawConfiguration);     }       private function isImport(JobInstance $jobInstance)     {         if ($jobInstance->getAlias() == JobExecutor::JOB_IMPORT_FROM_CSV) {             return true;         }         if ($jobInstance->getAlias() == JobExecutor::JOB_VALIDATE_IMPORT_FROM_CSV) {             return true;         }           return false;     }       private function changeRawConfiguration($rawConfiguration)     {         $processorAlias = $rawConfiguration['import_validation']['processorAlias'];         if ($processorAlias == 'my_processor') {             $rawConfiguration['import_validation']['delimiter'] = '|';             $rawConfiguration['import_validation']['enclosure'] = '"';             $rawConfiguration['import_validation']['escape'] = '\\';         }           return $rawConfiguration;     } }

2) Need register listener:

listener.import_export_listener: class: Acme\ImportExportBundle\Listener\ImportExportListener tags: - { name: kernel.event_listener, event: akeneo_batch.before_step_execution, method: changeCsv }

1 2 3 4 5 6

listener.import_export_listener:     class: Acme\ImportExportBundle\Listener\ImportExportListener     tags:         - { name: kernel.event_listener, event: akeneo_batch.before_step_execution, method: changeCsv }

[Yevhen ShyshkinParticipant]

Good job, stalxed!

Just a several tips:
– alongside with “import_validation” type you should alter configuration for “import” type
– instead of hardcoded types you can use constants ProcessorRegistry::TYPE_IMPORT_VALIDATION and ProcessorRegistry::TYPE_IMPORT

[stalxedParticipant]

Thanks Yevhen Shyshkin!

I improved the code:

<?php namespace Acme\ImportExportBundle\Listener; use Akeneo\Bundle\BatchBundle\Entity\JobInstance; use Akeneo\Bundle\BatchBundle\Event\StepExecutionEvent; use Oro\Bundle\ImportExportBundle\Job\JobExecutor; use Oro\Bundle\ImportExportBundle\Processor\ProcessorRegistry; class ImportExportListener { private $processorAlias; private $delimiter; private $enclosure; private $escape; public function __construct($processorAlias, $delimiter, $enclosure, $escape) { $this->processorAlias = $processorAlias; $this->delimiter = $delimiter; $this->enclosure = $enclosure; $this->escape = $escape; } public function changeCsv(StepExecutionEvent $event) { $jobInstance = $event ->getStepExecution() ->getJobExecution() ->getJobInstance(); if (! $this->isImport($jobInstance) && ! $this->isValidate($jobInstance)) { return; } $rawConfiguration = $jobInstance->getRawConfiguration(); if ($this->isImport($jobInstance)) { $rawConfiguration = $this->changeImport($rawConfiguration); } if ($this->isValidate($jobInstance)) { $rawConfiguration = $this->changeValidate($rawConfiguration); } $jobInstance->setRawConfiguration($rawConfiguration); } private function isImport(JobInstance $jobInstance) { return $jobInstance->getAlias() == JobExecutor::JOB_IMPORT_FROM_CSV; } private function changeImport($rawConfiguration) { $type = ProcessorRegistry::TYPE_IMPORT; $processorAlias = $rawConfiguration[$type]['processorAlias']; if ($processorAlias == $this->processorAlias) { $rawConfiguration[$type]['delimiter'] = $this->delimiter; $rawConfiguration[$type]['enclosure'] = $this->enclosure; $rawConfiguration[$type]['escape'] = $this->escape; } return $rawConfiguration; } private function isValidate(JobInstance $jobInstance) { return $jobInstance->getAlias() == JobExecutor::JOB_VALIDATE_IMPORT_FROM_CSV; } private function changeValidate($rawConfiguration) { $type = ProcessorRegistry::TYPE_IMPORT_VALIDATION; $processorAlias = $rawConfiguration[$type]['processorAlias']; if ($processorAlias == $this->processorAlias) { $rawConfiguration[$type]['delimiter'] = $this->delimiter; $rawConfiguration[$type]['enclosure'] = $this->enclosure; $rawConfiguration[$type]['escape'] = $this->escape; } return $rawConfiguration; } }

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82

<?php namespace Acme\ImportExportBundle\Listener;   use Akeneo\Bundle\BatchBundle\Entity\JobInstance; use Akeneo\Bundle\BatchBundle\Event\StepExecutionEvent; use Oro\Bundle\ImportExportBundle\Job\JobExecutor; use Oro\Bundle\ImportExportBundle\Processor\ProcessorRegistry;   class ImportExportListener {     private $processorAlias;     private $delimiter;     private $enclosure;     private $escape;       public function __construct($processorAlias, $delimiter, $enclosure, $escape)     {         $this->processorAlias = $processorAlias;         $this->delimiter = $delimiter;         $this->enclosure = $enclosure;         $this->escape = $escape;     }       public function changeCsv(StepExecutionEvent $event)     {         $jobInstance = $event             ->getStepExecution()             ->getJobExecution()             ->getJobInstance();           if (! $this->isImport($jobInstance) && ! $this->isValidate($jobInstance)) {             return;         }           $rawConfiguration = $jobInstance->getRawConfiguration();         if ($this->isImport($jobInstance)) {             $rawConfiguration = $this->changeImport($rawConfiguration);         }         if ($this->isValidate($jobInstance)) {             $rawConfiguration = $this->changeValidate($rawConfiguration);         }         $jobInstance->setRawConfiguration($rawConfiguration);     }       private function isImport(JobInstance $jobInstance)     {         return $jobInstance->getAlias() == JobExecutor::JOB_IMPORT_FROM_CSV;     }       private function changeImport($rawConfiguration)     {         $type = ProcessorRegistry::TYPE_IMPORT;         $processorAlias = $rawConfiguration[$type]['processorAlias'];         if ($processorAlias == $this->processorAlias) {             $rawConfiguration[$type]['delimiter'] = $this->delimiter;             $rawConfiguration[$type]['enclosure'] = $this->enclosure;             $rawConfiguration[$type]['escape'] = $this->escape;         }           return $rawConfiguration;     }       private function isValidate(JobInstance $jobInstance)     {         return $jobInstance->getAlias() == JobExecutor::JOB_VALIDATE_IMPORT_FROM_CSV;     }       private function changeValidate($rawConfiguration)     {         $type = ProcessorRegistry::TYPE_IMPORT_VALIDATION;         $processorAlias = $rawConfiguration[$type]['processorAlias'];         if ($processorAlias == $this->processorAlias) {             $rawConfiguration[$type]['delimiter'] = $this->delimiter;             $rawConfiguration[$type]['enclosure'] = $this->enclosure;             $rawConfiguration[$type]['escape'] = $this->escape;         }           return $rawConfiguration;     } }

Now can registe few services:

listener.import_export_listener.my_processor1: class: Acme\ImportExportBundle\Listener\ImportExportListener arguments: - 'my_processor1' - '|' - '"' - '\\' tags: - { name: kernel.event_listener, event: akeneo_batch.before_step_execution, method: changeCsv } listener.import_export_listener.my_processor2: class: Acme\ImportExportBundle\Listener\ImportExportListener arguments: - 'my_processor1' - '|' - '"' - '\\' tags: - { name: kernel.event_listener, event: akeneo_batch.before_step_execution, method: changeCsv }

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21

listener.import_export_listener.my_processor1:     class: Acme\ImportExportBundle\Listener\ImportExportListener     arguments:         - 'my_processor1'         - '|'         - '"'         - '\\'     tags:         - { name: kernel.event_listener, event: akeneo_batch.before_step_execution, method: changeCsv }   listener.import_export_listener.my_processor2:     class: Acme\ImportExportBundle\Listener\ImportExportListener     arguments:         - 'my_processor1'         - '|'         - '"'         - '\\'     tags:         - { name: kernel.event_listener, event: akeneo_batch.before_step_execution, method: changeCsv }

I hope someone can help.
I would be glad if you publish in a cookbook documentation.

[Author]

Replies