asimlqt/arrayquery

Array query

dev-master 2014-05-28 23:07 UTC

Requires

• php: >=5.3.0

Apache-2.0

• Asim Liaquat

• php
• array
• query
• linq

README

ArrayQuery is a library to query, group and sort data stored in a nested php array format.

Example

use Asimlqt\ArrayQuery\Input\ArrayOfArrays;
use Asimlqt\ArrayQuery\Query;

$data = array(
    array(
        'continent' => 'Europe',
        'country' => 'England',
        'city' => 'London',
        'population' => '8000000'
    ),
    array(
        'continent' => 'Europe',
        'country' => 'France',
        'city' => 'Paris',
        'population' => '2200000'
    ),
    array(
        'continent' => 'Asia',
        'country' => 'Japan',
        'city' => 'Tokyo',
        'population' => '13200000'
    ),
);

$source = new ArrayOfArrays($data);
$query = new Query($source);
$query->where(function($row) { return $row['population'] > 5000000; });
print_r($query->getResult());
    

API

select($columns)

Select is similar to a select in an sql query, It only keeps the columns which are passed to the method and discards all others. This sohuld generally be called after queryingfor the required data, just before calling getResult(). Once select has been called, you can not filter or query on the rows which have been removed by the select as they no longer exist.

$query->select(array('city', 'population'));

filter($column, array $values)

Filter removes columns which don't have one of the specified values. It is similar to a "WHERE IN" clause in mysql.

$query->filter('city', array('London', 'Paris'));

where($closure)

The where function gives the freedom of filtering data in any way the user likes. The closure accepts the current row and must return true or false. If the function returns boolean true then the row will be kept, any other value will cause the row to be removed.

$query->where(function($row) { return $row['population'] > 5000000; });

groupBy($columns, $closure)

Allows grouping of data so that there will be only one row for each unique set of the specified column values.

$query->groupBy(array('continent', 'country'));

You can optionally specify a closure as the second argument. If a closure is specified then it will be called each time a duplicate row is found for the specified columns. The return value must be a row. e.g.

$query->groupBy(array('continent', 'country'), function($oldRow, $newRow) {
	$oldRow['population'] += $newRow['population'];
	return $oldRow;
});

orderBy(array $order)

Allows ordering of the data by one or more columns. The key of the array is the column name and the value is either SORT_ASC or SORT_DESC.

$query->orderBy(array('continent' => SORT_ASC, 'population' => SORT_DESC));