Skip to content

akeneo-labs/spreadsheet-parser

Folders and files

NameName
Last commit message
Last commit date

Latest commit

4be5fda · Dec 9, 2018

History

98 Commits
Sep 6, 2016
Nov 9, 2016
Dec 9, 2018
Jun 6, 2014
Dec 9, 2018
Mar 25, 2016
May 23, 2014
Oct 1, 2016
Dec 9, 2018
May 23, 2014

Repository files navigation

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.

Travis Build Status Scrutinizer Code Quality

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