nested-json-flattener

A php package to flatten nested json objects and nested arrays (Based on csvwriter npm package implementation)

Github星跟蹤圖

NestedJsonFlattener

Code Climate Build Status
codecov
Latest Stable Version Total Downloads Latest Unstable Version License

A php package to flatten nested json objects and nested arrays. It also allows you to create csv files from the flattened data.

Features

  1. The package allows you to select a specific node of the json object or array and flat it. The selected node can be flattened whether is a object or collection.

  2. It takes in count the full path where a value is stored in a nested json object and uses it as header name. Let's use the example below.

{
	"name": "This is a name",
	"nested": {
		"type": "This is a type",
		"location": "Earth",
		"geo": {
			"latitude": "1234567890",
			"longitude": "0987654321"
		},
		"primitivesCollection":[123, 456, 789]
	}	
}

If we'd like to flat that json object and put it into a csv file, the result would be as follows:, name, nested.type, nested.location, nested.geo.latitude, nested.geo.longitude, nested.primitivesCollection, ------------------, ------------------, -----------------, ---------------------, ----------------------, -----------------------------, This is a name, This is a type, Earth, 1234567890, 0987654321, 123, 456, 789, ## Credits
It's based on csvwriter npm package implementation.

How to use it

If you need to flat a nested json string

use NestedJsonFlattener\Flattener\Flattener;
$dataJson = '{
	"name": "This is a name",
	"nested": {
		"type": "This is a type",
		"location": "Earth",
		"geo": {
			"latitude": "1234567890",
			"longitude": "0987654321"
		},
		"primitivesCollection":[123, 456, 789]
	}	
}';

$flattener = new Flattener();
$flattener->setJsonData($dataJson);
$flat = $flattener->getFlatData();
print_r($flat);

If you need to flat a nested array

use NestedJsonFlattener\Flattener\Flattener;
$data = [
	'name' => 'This is a name', 
	'nested' => [
		'type' => 'This is a type',
		'location' => 'Earth',
		'geo' => [
			'latitude'=> '1234567890',
			'longitude'=> '0987654321'
		],
		'primitivesCollection'=> [123, 456, 789]
	]
];

$flattener = new Flattener();
$flattener->setArrayData($data);
$flat = $flattener->getFlatData();
print_r($flat);

If you need to select a specific path to be flattened

Read JsonPath documentation from Stefan Goessner to learn how to create paths.

use NestedJsonFlattener\Flattener\Flattener;
$data = [
	'name' => 'This is a name', 
	'nested' => [
		'type' => 'This is a type',
		'location' => 'Earth',
		'geo' => [
			'latitude'=> '1234567890',
			'longitude'=> '0987654321'
		],
		'primitivesCollection'=> [123, 456, 789]
	]
];
// This is a path based on JsonPath implementation
$options = ['path'=>'$.nested'];

$flattener = new Flattener($options);
$flattener->setArrayData($data);
$flat = $flattener->getFlatData();
print_r($flat);

If you need to write a csv file

use NestedJsonFlattener\Flattener\Flattener;
$data = [
	'name' => 'This is a name', 
	'nested' => [
		'type' => 'This is a type',
		'location' => 'Earth',
		'geo' => [
			'latitude'=> '1234567890',
			'longitude'=> '0987654321'
		],
		'primitivesCollection'=> [123, 456, 789]
	]
];
$flattener = new Flattener();
$flattener->setArrayData($data);
$flattener->writeCsv();

TODO

  1. The package still needs to get configurations from params. See milestone
  2. Some of the params in mind are: whether take primitives arrays as one element or not (taken as one element by default)
  3. Add a way to create a configuration to tell the class how to handle internal collections. See milestone

主要指標

概覽
名稱與所有者tonirilix/nested-json-flattener
主編程語言PHP
編程語言PHP (語言數: 1)
平台
許可證MIT License
所有者活动
創建於2016-01-19 12:15:05
推送於2024-01-11 08:43:37
最后一次提交2018-09-05 15:58:52
發布數11
最新版本名稱v2.1.2 (發布於 )
第一版名稱cvswriter_v1.0.0 (發布於 2016-01-19 14:02:26)
用户参与
星數26
關注者數4
派生數12
提交數92
已啟用問題?
問題數13
打開的問題數10
拉請求數8
打開的拉請求數1
關閉的拉請求數0
项目设置
已啟用Wiki?
已存檔?
是復刻?
已鎖定?
是鏡像?
是私有?