BEdita\WebTools\Utility\CsvTrait

Complexity

Total Complexity

3

Size/Duplication

Total Lines	29
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

1 Method

Rating	Name	Duplication	Size	Complexity
A	read()	0	19	3

<?php
declare(strict_types=1);

/**
 * BEdita, API-first content management framework
 * Copyright 2023 Atlas Srl, Chialab Srl
 *
 * This file is part of BEdita: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published
 * by the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * See LICENSE.LGPL or <http://gnu.org/licenses/lgpl-3.0.html> for more details.
 */
namespace BEdita\WebTools\Utility;

use Cake\Core\InstanceConfigTrait;
use Cake\Http\Exception\BadRequestException;

/**
 * Trait for share Csv stuff.
 */
trait CsvTrait
{
    use InstanceConfigTrait;

    /**
     * Progressively read a CSV file, line by line.
     *
     * @param string $path Path to CSV file.
     * @return \Generator<array<string, string>>
     */
    public function read($path): \Generator
    {
        $fh = fopen($path, 'rb');
        $options = $this->getConfig('csv');
        $delimiter = $options['delimiter'];
        $enclosure = $options['enclosure'];
        $escape = $options['escape'];
        flock($fh, LOCK_SH);
        $header = fgetcsv($fh, null, $delimiter, $enclosure, $escape);
        if ($header === false) {
            throw new BadRequestException(sprintf('Unable to get csv data for file: %s', $path));
        }
        $i = 0;
        while (($row = fgetcsv($fh, null, $delimiter, $enclosure, $escape)) !== false) {
            yield array_combine($header, $row);
            $i++;
        }
        flock($fh, LOCK_UN);
        fclose($fh);
    }
}