{"id":19188780,"url":"https://github.com/miquido/csv-file-reader","last_synced_at":"2025-05-08T02:47:31.338Z","repository":{"id":57017333,"uuid":"144588658","full_name":"miquido/csv-file-reader","owner":"miquido","description":"The project was made by Miquido. https://www.miquido.com/","archived":false,"fork":false,"pushed_at":"2018-10-05T10:11:25.000Z","size":48,"stargazers_count":5,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-04-20T06:35:01.095Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/miquido.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-08-13T14:09:15.000Z","updated_at":"2023-09-25T07:17:17.000Z","dependencies_parsed_at":"2022-08-22T11:31:45.930Z","dependency_job_id":null,"html_url":"https://github.com/miquido/csv-file-reader","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/miquido%2Fcsv-file-reader","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/miquido%2Fcsv-file-reader/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/miquido%2Fcsv-file-reader/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/miquido%2Fcsv-file-reader/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/miquido","download_url":"https://codeload.github.com/miquido/csv-file-reader/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252989941,"owners_count":21836665,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-09T11:26:00.489Z","updated_at":"2025-05-08T02:47:31.319Z","avatar_url":"https://github.com/miquido.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![Build](https://travis-ci.org/miquido/csv-file-reader.svg?branch=master)](https://travis-ci.org/miquido/csv-file-reader)\n[![Maintainability](https://api.codeclimate.com/v1/badges/d7b1addb4a14eab9cb48/maintainability)](https://codeclimate.com/github/miquido/csv-file-reader/maintainability)\n[![Test Coverage](https://api.codeclimate.com/v1/badges/d7b1addb4a14eab9cb48/test_coverage)](https://codeclimate.com/github/miquido/csv-file-reader/test_coverage)\n[![MIT Licence](https://badges.frapsoft.com/os/mit/mit.svg?v=103)](https://opensource.org/licenses/mit-license.php)\n\n# CSV File Reader\n\n- [Installation guide](#installation)\n- [Code Samples](#code-samples)\n- [Contributing](#contributing)\n\n## Installation \nUse [Composer](https://getcomposer.org) to install the package:\n\n```shell\ncomposer require miquido/csv-file-reader\n```\n\n## Code Samples\n- [Simple read a csv file example](#simple-read-a-csv-file-example)\n- [Process a file as a stream](#process-a-file-as-a-stream)\n- [Using data transformer and error handler](#using-data-transformer)\n- [Batch processing](#batch-processing)\n\n### Simple read a csv file example\n```php\n\u003c?php\n\nuse Miquido\\CsvFileReader\\CsvFile;\nuse Miquido\\CsvFileReader\\Line\\CsvLineInterface;\n\n// open a file\n$csv = new CsvFile('./examples/users.csv');\n\n$count = $csv-\u003ecountLines(); // 101\n\n// don't worry about memory, it reads a file line-by-line \nforeach ($csv-\u003ereadLines() as $line) {\n    /** @var CsvLineInterface $line */\n    $line-\u003egetLineNumber(); // 2 ... 101\n    $line-\u003egetData(); // ['id' =\u003e '1', 'name' =\u003e 'Miriam', 'surname' =\u003e 'Mccoy', 'age' =\u003e '79'] ...\n}\n```\n\n### Process a file as a stream\n*Miquido\\CsvFileReader\\CsvFileReader* class uses [miquido/observable](https://github.com/miquido/observable) library for data processing.   \n```php\n\u003c?php\n\nuse Miquido\\CsvFileReader\\CsvFile;\nuse Miquido\\CsvFileReader\\CsvFileReader;\nuse Miquido\\CsvFileReader\\Line\\CsvLineInterface;\n\n$reader = new CsvFileReader(new CsvFile('./examples/users.csv'));\n$reader-\u003elines()-\u003esubscribe(function (CsvLineInterface $line) {\n    // do something with a line\n    $line-\u003egetLineNumber(); // 2 ... 101\n    $line-\u003egetData(); // ['id' =\u003e '1', 'name' =\u003e 'Miriam', 'surname' =\u003e 'Mccoy', 'age' =\u003e '79'] ...\n});\n\n$reader-\u003eloop(); // start reading a file\n```\n\n### Using data transformer and error handler\nPlease check [miquido/data-structure](https://github.com/miquido/data-structure) library for more details about classes used in examples below. \n```php\n\u003c?php\n\nuse Miquido\\CsvFileReader\\CsvFile;\nuse Miquido\\CsvFileReader\\CsvFileReader;\nuse Miquido\\CsvFileReader\\Line\\CsvLineInterface;\nuse Miquido\\DataStructure\\Map\\MapInterface;\nuse Miquido\\DataStructure\\Map\\Map;\n\n// change data to Map object\n$transformer = function (array $data, int $line): MapInterface {\n    return new Map($data);\n};\n\n$reader = new CsvFileReader(new CsvFile('./examples/users.csv'), $transformer);\n$reader-\u003elines()-\u003esubscribe(function (CsvLineInterface $line): void {\n    $line-\u003egetData(); // getData() now returns Map() object\n});\n\n$reader-\u003eloop(); // start reading a file\n\n```\n\nIf transformer throws an error, it will appear in $reader-\u003eerrors() stream\n\n```php\n\u003c?php\n\nuse Miquido\\CsvFileReader\\CsvFile;\nuse Miquido\\CsvFileReader\\CsvFileReader;\nuse Miquido\\CsvFileReader\\Exception\\InvalidCsvLineException;\n\n// check user's age\n$transformer = function (array $data, int $line): array {\n    $age = (int) $data['age'];\n    if ($age \u003c 18) {\n        throw new \\Exception('Invalid age');\n    }\n    \n    return $data;\n};\n\n$reader = new CsvFileReader(new CsvFile('./examples/users.csv'), $transformer);\n$reader-\u003edata()-\u003esubscribe(function (array $lineData): void {\n    // do something with data\n});\n$reader-\u003eerrors()-\u003esubscribe(function (InvalidCsvLineException $e): void {\n    // do something with an error\n    $e-\u003egetMessage();\n    $e-\u003egetCsvLine();\n});\n\n$reader-\u003eloop(); // start reading a file\n``` \n\n### Batch processing\nSimply use *Miquido\\Observable\\Operator*:\n```php\n\u003c?php\n\nuse Miquido\\CsvFileReader\\CsvFile;\nuse Miquido\\CsvFileReader\\CsvFileReader;\nuse Miquido\\Observable\\Operator;\n\n$batchSize = 10;\n\n$reader = new CsvFileReader(new CsvFile('./examples/users.csv'));\n$reader-\u003elines()-\u003epipe(new Operator\\BufferCount($batchSize))-\u003esubscribe(function (array $lines): void {\n    // do something with 10 lines\n});\n\n$reader-\u003eloop(); // start reading a file\n```\n\nSee [*miquido/observable*](https://github.com/miquido/observable) library for more operators.\n\n## Contributing\n\nPull requests, bug fixes and issue reports are welcome.\nBefore proposing a change, please discuss your change by raising an issue.\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmiquido%2Fcsv-file-reader","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmiquido%2Fcsv-file-reader","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmiquido%2Fcsv-file-reader/lists"}