{"id":18356291,"url":"https://github.com/daalvand/csvgenerator","last_synced_at":"2025-04-10T01:48:02.183Z","repository":{"id":110782038,"uuid":"284090125","full_name":"daalvand/csvGenerator","owner":"daalvand","description":"php generator for nested array and complex action for any fied","archived":false,"fork":false,"pushed_at":"2020-08-01T04:20:04.000Z","size":12,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-02-15T17:43:10.740Z","etag":null,"topics":["csv","nested-arrays","php"],"latest_commit_sha":null,"homepage":"","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/daalvand.png","metadata":{"files":{"readme":"readme.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-07-31T17:13:56.000Z","updated_at":"2023-03-17T12:27:43.000Z","dependencies_parsed_at":null,"dependency_job_id":"263ba9f3-5d3d-405c-b6bd-6ebaea782cc3","html_url":"https://github.com/daalvand/csvGenerator","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/daalvand%2FcsvGenerator","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/daalvand%2FcsvGenerator/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/daalvand%2FcsvGenerator/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/daalvand%2FcsvGenerator/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/daalvand","download_url":"https://codeload.github.com/daalvand/csvGenerator/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248142593,"owners_count":21054665,"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":["csv","nested-arrays","php"],"created_at":"2024-11-05T22:09:35.349Z","updated_at":"2025-04-10T01:48:02.169Z","avatar_url":"https://github.com/daalvand.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Overview\nThis package is suitable for creating csv output from nested arrays as well as fields that are themselves variable length arrays.\nHere are some examples of how this package works ...\n# Installation\nSetup require in your projects composer.json file. Latest release: \n```shell script\ncomposer require daalvand/csv-generator\n``` \n# Usage\nFirst import the Mapper and Generator classes and specify the file name and path.\n\n```php\nrequire \"vendor/autoload.php\";\n$mapper    = new Daalvand\\CsvGenerator\\Mapper();\n$generator = new Daalvand\\CsvGenerator\\Generator();\n$filePath  = '/path';\n$fileName  = 'file.csv';\n$generator-\u003esetFileName($fileName)\n          -\u003esetFilePath($filePath);\n```\n\n#options\n```php\n//determine use utf8 and bom or not.  default -\u003e false\n$generator-\u003esetShouldAddBOM(false);\n//set enclosure  (one character only) . default -\u003e \"\n$generator-\u003esetEnclosure('\"');\n//set enclosure  (one character only). default -\u003e ,\n$generator-\u003esetDelimiter(',');\n//check if file exists append rows to end of file. default -\u003e false\n$generator-\u003eshouldAppend(true);\n\n```\n\n\n\nCan see a sample data here:\n```php\n    $data = [\n        [\n            'id' =\u003e 1,\n            'tags' =\u003e [\n                ['id' =\u003e 1, 'name' =\u003e 'a'],\n                ['id' =\u003e 2, 'name' =\u003e 'b'],\n                ['id' =\u003e 3, 'name' =\u003e 'c']\n            ],\n            'user' =\u003e [\n                'id' =\u003e 1,\n                'username' =\u003e 'user1',\n                'created_at' =\u003e '2020-10-10 10:10:10'\n            ]\n        ],\n        [\n            'id' =\u003e 2,\n            'tags' =\u003e [\n                ['id' =\u003e 1, 'name' =\u003e 'a'],\n                ['id' =\u003e 3, 'name' =\u003e 'c']\n            ],\n            'user' =\u003e [\n                'id' =\u003e 2,\n                'username' =\u003e 'user2',\n                'created_at' =\u003e '2020-11-11 11:11:11'\n            ]\n        ],\n        [\n            'id' =\u003e 3,\n            'tags' =\u003e [],\n            'user' =\u003e [\n                'id' =\u003e 3,\n                'username' =\u003e 'user3',\n                'created_at' =\u003e '2020-12-12 12:12:12'\n            ]\n        ]\n    ];\n```\n\n\n#first example:\nThe fastest way to create csv in this package is create headers from array structure by the dot based string\n```php\n$headers = [\n    'id',\n    'tags.*.id',\n    'tags.*.name',\n    'user.id',\n    'user.username',\n    'user.created_at',\n];\n\n\n$mapper-\u003esetHeaders($headers);\n//add mapper to generator service and open service \n$generator-\u003esetMapper($mapper)-\u003eopenGenerator();\n// add rows\nforeach ($data as $datum) {\n    $generator-\u003eaddRow($datum);\n}\n$generator-\u003eclose();\n```\n#second example\nin this example we can change name and change value of real data \nin below example `primary` header created from `id` field or `tags.ids` created from `tags.*.id`.\nAlso we can apply action to a field to change that value. for example: `user.created_at.time` is time of `user.created_at` date time field.\n\n```php\n$headers = [\n    'primary'              =\u003e ['from' =\u003e 'id'],\n    'tags.ids'             =\u003e ['from' =\u003e 'tags.*.id'],\n    'tags.names'           =\u003e ['from' =\u003e 'tags.*.name'],\n    'user.id'              =\u003e ['from' =\u003e 'user.id'],\n    'user.username'        =\u003e ['from' =\u003e 'user.username'],\n    'user.created_at.time' =\u003e ['from' =\u003e 'user.created_at', 'action' =\u003e 'NameSpace\\TimeService@getTime'],\n    'user.created_at.date' =\u003e ['from' =\u003e 'user.created_at', 'action' =\u003e 'NameSpace\\TimeService@getDate']\n];\n$mapper-\u003esetHeaders($headers);\n$generator-\u003esetMapper($mapper)-\u003eopenGenerator();\n\nforeach ($data as $datum) {\n    $generator-\u003eaddRow($datum);\n}\n$generator-\u003eclose();\n```","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdaalvand%2Fcsvgenerator","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdaalvand%2Fcsvgenerator","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdaalvand%2Fcsvgenerator/lists"}