README.md

Akeneo Spreadsheet Parser

This component is designed to extract data from spreadsheets, while being easy on resources, even for large files.

The current version of the spreadsheet parser works with csv and xlsx files.

Installing the package

From your application root:

    $ php composer.phar require --prefer-dist "akeneo-labs/spreadsheet-parser"

Usage

To extract data from an XLSX spreadsheet, use the following code:

    use Akeneo\Component\SpreadsheetParser\SpreadsheetParser;

    $workbook = SpreadsheetParser::open('myfile.xlsx');

    $myWorksheetIndex = $workbook->getWorksheetIndex('myworksheet');
    
    foreach ($workbook->createRowIterator($myWorksheetIndex) as $rowIndex => $values) {
        var_dump($rowIndex, $values);
    }

By using the CSV parser options, you can specify the format of your CSV file :

    use Akeneo\Component\SpreadsheetParser\SpreadsheetParser;

    $workbook = SpreadsheetParser::open('myfile.csv');

    $iterator = $workbook->createRowIterator(
        0,
        [
            'encoding'  => 'UTF-8',
            'length'    => null,
            'delimiter' => ',',
            'enclosure' => '"',
            'escape'    => '\\'
        ]
    );
   
    
    foreach ($workbook->createRowIterator(0) as $rowIndex => $values) {
        var_dump($rowIndex, $values);
    }

Running the tests

To run unit tests, use phpspec:

    $ php bin/phpspec run

To run integration tests, use phpunit:

    $ phpunit