Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kaliop/csv-parser
PHP CSV Parser. OOP-style, Customizable and Testable
https://github.com/kaliop/csv-parser
csv csv-parser excel library php
Last synced: about 2 months ago
JSON representation
PHP CSV Parser. OOP-style, Customizable and Testable
- Host: GitHub
- URL: https://github.com/kaliop/csv-parser
- Owner: kaliop
- License: mit
- Created: 2019-05-22T09:51:04.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2019-05-27T12:11:02.000Z (over 5 years ago)
- Last Synced: 2024-04-28T16:05:07.327Z (8 months ago)
- Topics: csv, csv-parser, excel, library, php
- Language: PHP
- Homepage:
- Size: 23.4 KB
- Stars: 0
- Watchers: 6
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# CSV Parser Library
This library allows you to define your CSV parsing in OOP style, allowing you to easily filter and test your imports.
It's been in production on various large clients with multiples complex imports for quite some time now.
Main advantages are:
- OOP-style: One *Parser* class per import = meaningful for developers working on the project.
- Testable: A fixture csv and you can easily write tests for the import.
- Fully Customizable: each parsed result is also a PHP class where the developer can add its own logic.
- Lightly coupled: this package depends only on Symfony's Validator. Any database/persistence stuff is possible (see example below).
## Installation
Install this package using composer:
``` bash
composer require kaliop/csv-parser
```
## Basic Usage
You'll need to describe the mapping between CSV columns and entity's properties.
To do so, you should start by creating a *Parser*, but first, let's take a look at our CSV:
```csv
date;order_id;client_name;address;postal_code;country;amount
2019-04-15;678945;"Laurent Doe";"12 avenue PhpUnit";34000;France;12
2019-03-12;987564;"Ruh Doe";"15 rue du test";31001;France;50,53
2019-05-01;123456;"Julien Doe";"125 rue PHP";34440;France;69,12
2019-02-09;456123;"Gérard Doe";"15 blvd Bouchard";76000;France;789,10
2019-01-01;965478;"Jean-Luc Doe";"15 rue du test";34000;France;5,00
2019-05-01;126578;"Bernard Doe";"15 rue Symfony";75000;France;33,53
2019-05-01;216543;"Maël Doe";"Disneyland Paris";77000;France;1250,53
2019-05-01;987521;"Gros Doe";"15 rue de Behat";98520;France;50,98
```
our Entity looks like this:
```php
[
'property' => 'entity.date',
'filter' => function($value) { return \DateTime::createFromFormat('Y-m-d', $value); }
],
ColumnHelper::index('B') => [
'property' => 'entity.id',
'filter' => function($value) { return \intval($value); }
],
ColumnHelper::index('C') => [
'property' => 'entity.clientName',
'filter' => function($value) { return \trim($value); }
],
ColumnHelper::index('D') => [
'property' => 'entity.address',
'filter' => function($value) { return \trim($value); }
],
ColumnHelper::index('E') => [
'property' => 'entity.postalCode',
'filter' => function($value) { return \intval($value); }
],
ColumnHelper::index('F') => [
'property' => 'entity.country',
'filter' => function($value) { return \trim($value); }
],
ColumnHelper::index('G') => [
'property' => 'entity.amount',
'filter' => function($value) { return \floatval($value); }
]
];
}
public function getEntityClassName()
{
return Order::class;
}
}
```
And now do the magic! In this example we persist imported entities in database.
```php
em = $em;
}
public function import($csvFilePath)
{
$parser = new OrderParser($csvFilePath, ";");
$results = $parser->execute();
foreach ($results as $result) {
if ($result->isValid()) {
$this->em->persist($result->getEntity());
continue;
}
// log or do something with invalid entities
}
$this->em->flush();
}
}
```
## Advanced Usage
You can decide to change the default ```ParserResult``` class to do you own logic once the Entity has been parsed.
In the following example we will add a ```$shipDate``` which will be set by our custom result class, in the ```finalize()``` method:
```php
entity instanceof Order || !$this->entity->date) {
// do nothing on invalid entities
return;
}
$shipDate = clone $this->entity->date;
$shipDate->modify('+3 days');
$this->entity->shipDate = $shipDate;
}
}
```
Now just tell your Parser to use this Result class and you're ready:
```php
setResultClassName(App\CSV\OrderParserResult::class);
```
## Run PHPUnit Tests
```bash
./vendor/bin/phpunit
```