Skip to content

Commit

Permalink
Added more info in README
Browse files Browse the repository at this point in the history
  • Loading branch information
onlinesid committed Apr 25, 2018
1 parent 1fe13cd commit e79860f
Show file tree
Hide file tree
Showing 2 changed files with 33 additions and 3 deletions.
34 changes: 32 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,38 @@
# php-data-tabulator

A PHP library to turn rows of data into aggregated tabular data format
A PHP library to turn rows of data (e.g.: from database query result) into aggregated tabular data format

An example:

$rows = [
['id' => 7, 'u_id' => 1, 'u_name' => 'Joan', 'a_id' => 'PK', 'a_name' => 'Packing', 'num' => 10.5, ],
['id' => 4, 'u_id' => 1, 'u_name' => 'Joan', 'a_id' => 'PK', 'a_name' => 'Packing', 'num' => 0.5, ],
['id' => 2, 'u_id' => 1, 'u_name' => 'Joan', 'a_id' => 'DR', 'a_name' => 'Driving', 'num' => 2.3, ],
['id' => 5, 'u_id' => 2, 'u_name' => 'Robb', 'a_id' => 'DR', 'a_name' => 'Driving', 'num' => 8.7, ],
];
$tabulator = new DataTabulator($rows);

$table = $tabulator->to2DTable('Name', 'u_id', 'u_name', 'a_id', 'a_name', 'num');

// Expected result ($table) is something like:
//
// Name Packing (PK) Driving (DR)
// Joan (1) 11 2.3
// Robb (2) 0 8.7

## Installation

### Library

$ git clone https://github.com/onlinesid/php-data-tabulator.git

### Dependencies

#### [`Composer`](https://github.com/composer/composer) (*will use the Composer ClassLoader*)

$ wget http://getcomposer.org/composer.phar
$ php composer.phar require onlinesid/php-data-tabulator:dev-master

## Running the tests

$ php bin/phpunit

2 changes: 1 addition & 1 deletion composer.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"description": "A PHP library to transform rows into an aggregated table",
"minimum-stability": "dev",
"license": "MIT",
"version": "1.0.0",
"version": "1.0.1",
"authors": [
{
"name": "Sid Bachtiar",
Expand Down

0 comments on commit e79860f

Please sign in to comment.