fusonic/csv-reader

Map data from CSV files to typed PHP models.

0.5.1 2024-09-16 12:25 UTC

Requires

• php: >=8.2

Requires (Dev)

• friendsofphp/php-cs-fixer: ^3.58
• infection/infection: ^0.29
• phpstan/phpstan: ^1.11
• phpstan/phpstan-deprecation-rules: ^1.2
• phpstan/phpstan-phpunit: ^1.4
• phpstan/phpstan-strict-rules: ^1.6
• phpunit/phpunit: ^11.2
• tomasvotruba/type-coverage: ^0.3

Suggests

• ext-intl: Required to use IntlValueConverter for advanced value conversion.

MIT

• Fusonic GmbH

README

CSV Reader is a powerful library for PHP 8 that allows you to map data from CSV files to a strongly typed data model. It does this by utilizing PHP 8's typed properties / arguments and automatically converts string values to the types defined for your class fields.

Install

Use composer to install the lib from Packagist.

composer require fusonic/csv-reader

Requirements:

• PHP 8.2+

Usage

Just define a class that represents your CSV's data structure and use the IndexMapping or TitleMapping attributes to define the mapping. You don't have to map all the columns, just the ones you need on your model.

class Foo
{
    #[TitleMapping('Price')]
    public float $price;

    #[TitleMapping('Price')]
    public function setPrice(float $value): void
    {
        // Not implemented
    }
}

Now use the CsvReader class to convert CSV data to your object model:

$reader = new CsvReader('myfile.csv');
foreach ($reader->readObjects(Foo::class) as $item) {
    var_dump($item);
}

Hint: You can also pass a resource instead of a file's path to CsvReader. This way you can also access files from remote filesystems, for example if you are using league/flysystem.

Supported types

• int
• float
• string
• bool (uses filter_var() with FILTER_VALIDATE_BOOLEAN and supports values like on, true, 1)
• DateTime
• DateTimeInterface
• DateTimeImmutable

If you choose to use a **nullable type like ?string``** it will be mapped as null` if the CSV value is an empty string or 'null' (case insensitive).

Options

Refer to the CsvReaderOptions class to learn about options.

IntlValueConverter

If you need to unserialize floating point numbers from a specific culture, you can use the IntlValueConverter like this:

$options = new CsvReaderOptions();
$options->valueConverter = new IntlValueConverter('de-AT');

$reader = new CsvReader($options);

Note: parsing German date format is done implicitely by the default ValueConverter implementation since PHP supports passing German date formats to DateTimeInterface derivates.

Contributing

This is a subtree split of fusonic/php-extensions repository. Please create your pull requests there.