vinorcola/import-bundle

Bundle providing tools for importing and mapping a file.

v2.0.2 2024-02-20 11:05 UTC

Requires

• php: ^7.1 | ^8.0
• phpoffice/phpspreadsheet: ^1.0|^2.0
• psr/cache: ^1.0|^2.0|^3.0
• symfony/config: ^4.2|^5.0|^6.0
• symfony/contracts: ^1.1|^2.0|^3.0
• symfony/dependency-injection: ^4.2|^5.0|^6.0
• symfony/event-dispatcher: ^4.2|^5.0|^6.0
• symfony/form: ^4.2|^5.0|^6.0
• symfony/http-kernel: ^4.2|^5.0|^6.0
• symfony/routing: ^4.2|^5.0|^6.0
• vinorcola/helper-bundle: ^1.1

MIT

• Vinorcola

README

A bundle to import data from CSV or Excel files, letting the user map the columns of its file to the required fields for your process.

Configuration

Setup a temporary directory in which the uploaded files will be stored temporarily.

Setup as many imports as you want by configuring:

• the route prefix (several routes are generated for each import process)
• the mapping (the required columns for your process)
• The process service (which must implement Vinorcola\ImportBundle\Model\ImportConsumerInterface).

# config/packages/vinorcola_import.yaml

vinorcola_import:
    temporaryDirectory: "%kernel.project_dir%/document-storage/tmp"
    imports:
        company_import:
            route_prefix:
                name: import.company.
                url: /company/import
            mapping: [ nationalIdentifier, companyName, address, city ]
            service: App\Model\CompanyImportHandler
        contact_import:
            route_prefix:
                name: import.contact.
                url: /contact/import
            mapping: [ firstName, lastName, emailAddress, phoneNumber ]
            service: App\Model\ContactImportHanlder

# config/routes/vinorcola_import.yaml

import_routes:
    resource: '@VinorcolaImportBundle/Controller/'
    type: vinorcola_import

Then, the consume method of your process service will be called for line of data in the user's file, providing an array with the mapped columns and the line index:

public function consume(array $values, int $lineIndex): void;

For example, in the App\Model\CompanyImportHandler, the consume method will be called with a $values array containing the following keys:

• nationalIdentifier
• companyName
• address
• city