akeneo-labs/spreadsheet-parser

Akeneo Spreadsheet parser. Reads XLXS files from Microsoft Excel and Open Office

Maintainers

Details

github.com/akeneo-labs/spreadsheet-parser

Homepage

Source

Issues

Installs: 523 438

Dependents: 6

Suggesters: 0

Security: 0

Stars: 146

Watchers: 24

Forks: 50

Open Issues: 18

v1.3.0 2018-12-09 10:18 UTC

Requires

Requires (Dev)

OSL-3.0 4be5fdae57363819dcd80e84ae875c6402213b1b

excelspreadsheetxlsxparserreaderakeneo

This package is auto-updated.

Last update: 2024-11-20 22:43:23 UTC

README

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