pwfoo/tablearray

PHP library for arrays with tableslike structure

tableArray

PHP library for arrays with tableslike structure

Features

• Create from Array, JSON-String, Iterator or XML
• Methods for column selection, row filtering and sorting

Usage

Simple example 1

require '/yourpath/tableArray.php';

$data = [ 
  ['id' => 1, 'val' => 23.333333333], 
  ['id' => 2, 'val' => 13.7777777777], 
]; 
$newData = tableArray::create($data) 
  ->select('id, FORMAT("%6.2f",val) as rval') 
  ->orderBy('val ASC')
  ->fetchAll(); 
  
$expected = [ 
  ['id' => 2, 'rval' => " 13.78"],
  ['id' => 1, 'rval' => " 23.33"],  
]; 
var_dump($newData == $expected); //bool(true)

Simple example 2

require '/yourpath/tableArray.php';

$data = [ 
  ['name' => 'A1', 'likes' => 3], 
  ['name' => 'A12', 'likes' => 6], 
  ['name' => 'A2','likes' => 14], 
  ['name' => 'A14','likes' => 7], 
];
 
$newData = tableArray::create($data)
  ->select('name AS class, likes') 
  ->orderBy('name ASC NATURAL') 
  ->fetchAll();

$expected = [ 
  ['class' => 'A1', 'likes' => 3], 
  ['class' => 'A2','likes' => 14], 
  ['class' => 'A12', 'likes' => 6], 
  ['class' => 'A14','likes' => 7], 
];
var_dump($newData === $expected); //bool(true)

Pivot Group example

require '/yourpath/tableArray.php';

$data = [ 
  ['group' => 1, 'type' => 'A', 'value' => 'AA'],
  ['group' => 2, 'type' => 'A', 'value' => 'BB'], 
  ['group' => 1, 'type' => 'B', 'value' => 5],
  ['group' => 2, 'type' => 'B', 'value' => 7], 
]; 
$newData = tableArray::create($data) 
  ->pivot('group','value','type')
  ->fetchAll();

$expected = [
  1 => ['group' => 1, 'value.A' => "AA", 'value.B' => 5 ],
  2 => ['group' => 2, 'value.A' => "BB", 'value.B' => 7 ],
];

CSV Import example

require '/yourpath/tableArray.php';

$csv = new SplFileObject('datei.csv');

$csv->setFlags(SplFileObject::READ_CSV 
  | SplFileObject::SKIP_EMPTY 
  | SplFileObject::READ_AHEAD 
  | SplFileObject::DROP_NEW_LINE
);

$tabArr = tableArray::create($csv)
  //Using first row of CSV as the array keys
  ->firstRowToKey()  
  ->fetchAll()
;

XML example

$strXML = '<?xml version="1.0" encoding="utf-8"?>
<Store>
  <Hardware>
    <Article Number="123754" Name="MX925" Typ="Printer">25</Article>
    <Article Number="75356" Name="S6056" Typ="Monitor">60</Article>
  </Hardware>
</Store>';
$xml = $xml = simplexml_load_string($strXML);

$tabArr = tableArray::createFromXML($xml->Hardware->Article)
  ->flatten()  //allows access to attributes
  ->SELECT('@attributes.Number AS number,
      @attributes.Name AS name,
      @attributes.Typ AS typ,
      0 AS stock')
  ->orderBy('number')
  ->fetchAll()
;

$expected = [
  ['number' => "75356",'name' => "S6056",'typ' => "Monitor",'stock' => "60"],
  ['number' => "123754",'name' => "MX925",'typ' => "Printer",'stock' => "25"]
];
var_dump($tabArr === $expected); //bool(true)

Static methods

• create
• createFromJson
• createFromXml
• createFromOneDimArray
• check

Instance methods

• select
• filter
• filterLikeAll
• filterLikeIn
• filterUnique
• filterGroupMin
• filterGroupMax
• filterGroupSum
• orderBy
• offset
• limit
• innerJoinOn
• leftJoinOn
• pivot
• flatten
• addFlatKeys
• addKeys
• addSqlFunction
• addSqlFunctionFromArray
• getSqlFunction
• firstRowToKey
• fieldNameRaw
• fetchAll
• fetchAllObj
• fetchKeyValue
• fetchColumn
• fetchColumnUnique
• fetchGroup
• fetchRaw
• fetchLimit

Internal functions may be used by select and orderBy

• UPPER(fieldName)
• LOWER(fieldName)
• TRIM(fieldName[,'character_mask'])
• FORMAT('format',fieldName[,fieldName])
• SCALE(fieldName,'factor'[,add[,format]])
• DATEFORMAT('dateFormat',fieldName)
• REPLACE('search','replace',fieldName)
• SUBSTR(fieldName,'start'[,length])
• LIKE(fieldName,'likePattern')
• INTVAL(fieldName)
• FLOATVAL(fieldName)

Interface

• Iterator
• JsonSerializable

Class Methods

select

Select rows for a fetch ->select('field1, field2,..') ->select('field1 as newName,..') ->select('fct(field1) as newName,..)

$data =[
  ['id' => 1, 'article' => "pc1", 'price' => 1231.0],
  ['id' => 1, 'article' => "pc2", 'price' => 471.5],
];

$newData = tableArray::create($data)
  ->select("article as Name, FORMAT('%.2f€',price) as Euro")
  ->fetchAll()
;
/* Result $newData
[
  ['Name' => "pc1", 'Euro' => "1231.00€"],
  ['Name' => "pc2", 'Euro' => "471.50€",
]
*/

Documentation

http://jspit.de/tools/classdoc.php?class=tableArray

Examples and Test

http://jspit.de/check/phpcheck.class.tablearray.php

Requirements

• PHP 5.6+, PHP 7.x