ArrayOne

It is a minimalist library that process arrays in PHP.

This library is focused to work with business data(reading/saving files, database records, API, etc.), so it is not similar to Numpy, Pandas, NumPHP or alike because they target difference objectives. It is more closely similar to Microsoft PowerQuery. What it does? Filter, order, renaming column, grouping, validating, amongst many other operations.

• [x] it works with PHP arrays. PHP arrays allows hierarchy structures using indexed and/or associative values.
• [x] It is aimed at speed.
• [x] It is minimalist, using the minimum of dependencies and only 1 PHP class. Do you hate when a simple library adds a whole framework as difference? Well, not here.
• [x] It works using fluent/nested notations.
• [x] Every method is documented using PhpDoc.

[]() []() []() []() []()

<!-- TOC --> * ArrayOne * Basic examples * Getting started * Concepts * initial operator

* set

* middle operator

* col
* columnToIndex
* filter
* first
* flat
* group
  * example
* indexToColumn
* join
* last
* map
* mask
* nav
* npos
* reduce
* removecol
* removeDuplicate
* setCol
* sort
* validate

* end operators

* all
* result

* versions <!-- TOC -->

Basic examples

// Reducing an array using aggregate functions:
$invoice=[
    'id'=>1,
    'date'=>new DateTime('now'),
    'customer'=>10,
    'detail'=>[
        ['idproduct'=>1,'unitPrice'=>200,'quantity'=>3],
        ['idproduct'=>2,'unitPrice'=>300,'quantity'=>4],
        ['idproduct'=>3,'unitPrice'=>300,'quantity'=>5],
    ]
];
$arr=ArrayOne::set($invoice)
    ->nav('detail')
    ->reduce(['unitPrice'=>'sum','quantity'=>'sum'])
    ->current(); //['unitPrice'=>800,'quanty'=>12]

Getting started

First, you must install the library. You can download this library or use Composer for its installation:

> composer require eftec/arrayone

Once the library is installed and included, you can use as:

use eftec\ArrayOne;
ArrayOne::set($array); // Initial operator: $array is our initial array.
    ->someoperator1()  // Middle operator: here we do one or many operations to transform the array
    ->someoperator2()
    ->someoperator3()
    ->current(); // End operator: and we get the end result that usually is an array but it could be even a literal.

Concepts

$array=['hello'  // indexed field
       'field2'=>'world', // named field
       'fields'=>[   // a field with sub-fields
           'alpha'=>1,
           'beta'=>2
       ],
       'table'=>[ // a field with a list of values (a table)
           ['id'=>1,'name'=>'red'],
           ['id'=>2,'name'=>'orange'],
           ['id'=>3,'name'=>'blue'],           
       ]
   ];

• indexed and named fields works similarly.
• When a field contains an array, then you can "navigate" inside it using the command nav(). In the case of the field called fields is nav("field")
• Sometimes, some field contains an array of values that behave like a table (see table field)

initial operator

Initial operator is the first operator of the chain.

set

It sets the array to be transformed, and it starts the pipeline. It must be the first operator unless you are using the constructor.

ArrayOne::set($array)->all();
// or you can use the constructor.
(new ArrayOne($array))->all();

middle operator

Middle operators are operators that are called between the initial operator set() and the end operator all() or current(). They do the transformation and they could be stacked.

example:

ArrayOne::set($array)
    ->nav('field') // middle operator #1
    ->group('col1',['col2'=>'sum']) // middle operator #2
    ->all();

col

Returns a single column as an array of values. Example:

$this->col('c1'); // [['c1'=>1,'c2'=>2],['c1'=>3,'c2'=>4]] => [['c1'=>1],['c1'=>3]];

columnToIndex

it converts a column into an index Example:

$this->indexToField('colold'); //  [['colold'=>'a','col1'=>'b','col2'=>'c'] => ['a'=>['col1'=>'b','col2'=>'c']]

• parameter mixed $oldColumn the old column. This column will be converted into an index

filter

It filters the values. If the condition is false, then the row is deleted. It uses array_filter() The indexes are not rebuilt. Example:

$array = [['id' => 1, 'name' => 'chile'], ['id' => 2, 'name' => 'argentina'], ['id' => 3, 'name' => 'peru']];
// ['id' => 2, 'name' => 'argentina']
$r = ArrayOne::set($array)->filter(function($id, $row) {return $row['id'] === 2;}, true)->current();
// [1=>['id' => 2, 'name' => 'argentina']]
$r = ArrayOne::set($array)->filter(function($id, $row) {return $row['id'] === 2;}, false)->current();

first

It returns the first element of an array. return value* $this

flat

It flats the results. If the result is an array with a single row, then it returns the row without the array Example:

$this->flat(); // [['a'=>1,'b'=>2]] => ['a'=>1,'b'=>2]

• return value $this
  ### group
  It groups one column and return its column grouped and values aggregated   
  Example:
  $this->group('type',['amount'=>'sum','price'=>'sum']);
  

• parameter mixed $column the column to group.
• parameter array $functionAggregation An associative array ['colname'=>'aggregation'] with the aggregations <b>count</b>: Count <b>avg</b>: Average <b>min</b>: Minimum <b>max</b>: Maximum <b>sum</b>: Sum <b>first</b>: First <b>last</b>: last

example

$array=[
    ['cat'=>'cat1','col_min'=>1,'col_max'=>1,'col_sum'=>1,'col_avg'=>1,'col_first'=>'john1','col_last'=>'doe1'],
    ['cat'=>'cat2','col_min'=>2,'col_max'=>2,'col_sum'=>2,'col_avg'=>2,'col_first'=>'john2','col_last'=>'doe2'],
    ['cat'=>'cat3','col_min'=>3,'col_max'=>3,'col_sum'=>3,'col_avg'=>3,'col_first'=>'john3','col_last'=>'doe3'],
    ['cat'=>'cat1','col_min'=>4,'col_max'=>4,'col_sum'=>4,'col_avg'=>4,'col_first'=>'john4','col_last'=>'doe4'],
    ['cat'=>'cat2','col_min'=>5,'col_max'=>5,'col_sum'=>5,'col_avg'=>5,'col_first'=>'john5','col_last'=>'doe5']
    ];
$result=ArrayOne::set($array)
    ->group('cat',[
        'col_min'=>'min',
        'col_max'=>'max',
        'col_sum'=>'sum',
        'col_avg'=>'avg',
        'col_count'=>'count',
        'col_first'=>'first',
        'col_last'=>'last',
    ])
    ->all();
/* [
    'cat1' =>
        ['col_min' => 1, 'col_max' => 4, 'col_sum' => 5, 'col_avg' => 2.5, 'col_first' => 'john1', 'col_last' => 'doe4', 'col_count' => 2,],
    'cat2' =>
        ['col_min' => 2, 'col_max' => 5, 'col_sum' => 7, 'col_avg' => 3.5, 'col_first' => 'john2', 'col_last' => 'doe5', 'col_count' => 2,],
    'cat3' =>
        ['col_min' => 3, 'col_max' => 3, 'col_sum' => 3, 'col_avg' => 3, 'col_first' => 'john3', 'col_last' => 'doe3', 'col_count' => 1,],
];

indexToColumn

It converts the index into a field, and renumerates the array Example:

$this->indexToField('colnew'); // ['a'=>['col1'=>'b','col2'=>'c']] => [['colnew'=>'a','col1'=>'b','col2'=>'c']

• parameter mixed $newColumn the name of the new column

• return value $this
  ### join
  Joins the current array with another array   
  If the columns of both arrays have the same name, then the current name is retained.   
  Example:
  $products=[['id'=>1,'name'=>'cocacola','idtype'=>123]];
  $types=[['id'=>123,'desc'=>'it is the type #123']];
  ArrayOne::set($products)->join($types,'idtype','id')->all()
  // [['id'=>1,'prod'=>'cocacola','idtype'=>123,'desc'=>'it is the type #123']] "id" is from product.
  

• parameter array|null $arrayToJoin
• parameter mixed $column1 the column of the current array
• parameter mixed $column2 the column of the array to join.
• return value $this ### last It returns the last element of an array.
• return value $this ### map It calls a function for every element of an array
• parameter callable|null $condition The function to call.

• return value $this
  ### mask
  It masks the current array using another array.<br>
  Masking deletes all field that are not part of our mask<br>
  The mask is smart to recognize a table, so it could mask multiples values by only specifying the first row.  
  Example:
  $array=['a'=>1,'b'=>2,'c'=>3,'items'=>[[a1'=>1,'a2'=>2,'a3'=3],[a1'=>1,'a2'=>2,'a3'=3]];
  $mask=['a'=>1,'items'=>[[a1'=>1]]; // [[a1'=>1]] masks an entire table
  $this->mask($mask); // $array=['a'=>1,'items'=>[[a1'=>1],[a1'=>1]];
  

• param array $arrayMask An associative array with the mask. The mask could contain any value.

• return value ArrayOne
  ### nav
  Navigate inside the arrays.   
  If you want to select a subcolumn, then you could indicate it separated by dot: "column.subcolumn". You
  can separate up to 5 levels.
  Example:
  $this->nav('col');
  $this->nav(); // return to root.
  $this->nav('col.subcol.subsubcol'); //  [col=>[subcol=>[subsubcol=>[1,2,3]]]] returns  [1,2,3]
  

• parameter string|int|null $colName the name of the field. If null then it returns to the root. You can add more leves by separating by "."
• return value $this ### npos It returns the n-position of an array.
• parameter $index

• return value $this
  ### reduce
  You can reduce (flat) an array using aggregations or a custom function.
  Example:
  $this->reduce(['col1'=>'sum','col2'=>'avg','col3'=>'min','col4'=>'max']);
  $this->reduce(function($row,$index,$prev) { return ['col1'=>$row['col1']+$prev['col1]];  });
  

• parameter array|callable $functionAggregation An associative array where the index is the column and the value is the function of aggregation A function using the syntax: function ($row,$index,$prev) where $prev is the accumulator value

• return value $this
  ### removecol
  It removes a column   
  Example:
  $this->removeCol('col1');
  $this->removeCol(['col1','col2']);
  

• parameter mixed $colName The name of the column or columns (array)

• return value $this
  ### removeDuplicate
  ### setCol
  It adds or modify a column.
  Example:
  $this->setCol('col1',function($row,$index) { return $row['col2']*$row['col3'];  });
  

• parameter string|int|null $colName the name of the column. If null, then it uses the entire row
• parameter callable|null $operation the operation to realize.

• return value $this
  ### sort
  Sort an array   
  Example:
  $this->sort('payment','desc'); // sort an array using the column paypent descending.
  

• parameter mixed $column if column is null, then it sorts the row (instead of a column of the row)
• parameter string $direction =\['asc','desc'][$i] ascending or descending.

• return value $this
  ### validate
  Validate the current array using a comparison table   
  Example:
  $this->validate([
         'id'=>'int',
    	 'price'=>'int|between;1,20'   // the price must be an integer and it must be between 1 and 20 (including them).
         'table'=>[['col1'=>'int';'col2'=>'string|notnull,,the value is required|']],   // note the double [[ ]] to indicate a table of values
         'list'=>[['int']]
    ]);
  

  Example Using a custom function:
  

  // 1) defining the service class. class ServiceClass { / * @param mixed $value the value to evaluate * @param mixed $compare the value to compare (optional) * @param ?string $msg the message to return if fails * @return bool */ public function test($value,$compare=null,&$msg=null): bool { return true; } } // 2.1) and setting the service class using the class ValidateOne ->set($array,ServiceClass:class) ->validate('field'=>'fn:test') ->all(); // 2.2) or you could use an instance $obj=new ServiceClass(); ValidateOne ->set($array,$obj) ->validate('field'=>'fn:test') ->all();
• parameter array $comparisonTable The comparison table, is an associative table with the conditions to compare using the next syntax: [index=>"condition|condition2..."]. * The conditions could be express as: \<name of the condition>;\<value>\<custom error message> The\<value>* could be a simple literal (1,hello, etc.) or a list of values (separated by comma) The\<custom error message>could contain the next variables:%fieldthe id of the field, %value the current value of the field,%compthe value to compare,%firstthe first value to compare,%secondthe second value to compare, example "%field(%value) is not equals to%comp",%rowid* is the id of the current row (if any)

| Name | Description | syntax | |-------------------|-----------------------------------------------------------------------------------------------------|------------------------------| | nullable | the value can be a null. If the value is null, then it ignores other validations | nullable | | f:\<namefunction> | It calls a custom function defined in the service class. See example | f:myfunction | | contain | if a text is contained in | contain;\<text> | | notcontain | if a text is not contained in | notcontain;\<text> | | alpha | if the value is alphabetic | alpha | | alphanumunder | if the value is alphanumeric or under-case | alphanumunder | | alphanum | if the value is alphanumeric | alphanum | | text | if the value is a text | text | | regexp | if the value match a regular expression. You can't use comma in the regular expression. | regexp;\<regular expression> | | email | if the value is an email | email | | url | if the value is an url | url | | domain | if the value is a domain | domain | | minlen | the value must have a minimum length | minlen;\<size> | | maxlen | the value must have a maximum lenght | maxlen;\<size> | | betweenlen | if the value has a size between | betweenlen;<sizemin,sizemax> | | exist | if the value exists | exist | | missing,notexist | if the value not exist | missing\ |notexist | | req,required | if the value is required | req\ |required | | eq == | if the value is equals to | eq;\<value to compare> | | ne != <> | if the value is not equals to | nq;\<value to compare> | | null | The value must be null. It is different to nullable because nullable allow other conditions | null | | empty | if the value is empty | empty | | notnull | if the value is not null | notnull | | lt | if the value is less than | lt;\<value to compare> | | lte | if the value is less or equals than | lte;\<value to compare> | | gt | if the value is great than | gt;\<value to compare> | | gte | if the value is great or equals than | gte;\<value to compare> | | between | if the value is between | between;\<from,to> | | true | if the value is true or 1 | true | | false | if the value is false, or 0 | false | | array | if the value is an array | array | | int | if the value is an integer | int | | string | if the value is a string | string | | float | if the value is a float | float | | object | if the value is an object | object | | in | the value must be in a list | in;apple,pear,banana | | notin | the value must not be in a list | notin;apple,pear,banana |

• parameter bool $extraFieldError if true and the current array has more values than comparison table, then it returns an error.

end operators

all

Returns the whole array transformed. If you want the current navigation then use current()

Example:

$this->set($array)->nav('field')->all();

result

Returns the result indicated by nav(). If you want to return the whole array, then use all()

Example:

$this->set($array)->nav('field')->current();

• return value mixed

versions

• 1.0 2023-03-26 first version

License

Copyright Jorge Castro Castillo 2023. Licensed under dual license: LGPL-3.0 and commercial license.

In short: - [x] Can I use in a close source application for free? Yes if you don't modify this library.