philiprehberger/php-array-query

SQL-like fluent query builder for filtering, sorting, and transforming arrays

Maintainers

Package info

github.com/philiprehberger/php-array-query

pkg:composer/philiprehberger/php-array-query

Statistics

Installs: 1

Dependents: 0

Suggesters: 0

Stars: 1

Open Issues: 0

v1.0.2 2026-03-17 20:06 UTC

This package is auto-updated.

Last update: 2026-03-17 20:14:31 UTC


README

Tests Latest Version on Packagist License

SQL-like fluent query builder for filtering, sorting, and transforming arrays.

Requirements

  • PHP ^8.2
  • No external dependencies

Installation

composer require philiprehberger/php-array-query

Usage

Basic Filtering

use PhilipRehberger\ArrayQuery\ArrayQuery;

$users = [
    ['name' => 'Alice', 'age' => 30, 'city' => 'NYC', 'score' => 85],
    ['name' => 'Bob', 'age' => 25, 'city' => 'LA', 'score' => 92],
    ['name' => 'Charlie', 'age' => 35, 'city' => 'NYC', 'score' => 78],
    ['name' => 'Diana', 'age' => 28, 'city' => 'Chicago', 'score' => null],
    ['name' => 'Eve', 'age' => 22, 'city' => 'LA', 'score' => 95],
];

$results = ArrayQuery::from($users)
    ->where('city', '=', 'NYC')
    ->where('age', '>', 25)
    ->get();
// [['name' => 'Alice', ...], ['name' => 'Charlie', ...]]

Sorting

$results = ArrayQuery::from($users)
    ->sort('age', 'desc')
    ->get();
// Sorted by age descending: Charlie, Alice, Diana, Bob, Eve

Limit & Offset

$results = ArrayQuery::from($users)
    ->sort('age')
    ->offset(1)
    ->limit(3)
    ->get();
// Skip first, take next 3

Select Specific Keys

$results = ArrayQuery::from($users)
    ->select(['name', 'age'])
    ->get();
// [['name' => 'Alice', 'age' => 30], ...]

Pluck a Single Column

$names = ArrayQuery::from($users)
    ->where('city', '=', 'LA')
    ->pluck('name');
// ['Bob', 'Eve']

Group By

$groups = ArrayQuery::from($users)
    ->groupBy('city');
// ['NYC' => [...], 'LA' => [...], 'Chicago' => [...]]

Aggregates

$query = ArrayQuery::from($users)->whereNotNull('score');

$query->sum('score');   // 350
$query->avg('score');   // 87.5
$query->min('score');   // 78
$query->max('score');   // 95
$query->count();        // 4

Additional Filters

// Where In
ArrayQuery::from($users)->whereIn('city', ['NYC', 'LA'])->get();

// Where Null / Not Null
ArrayQuery::from($users)->whereNull('score')->get();
ArrayQuery::from($users)->whereNotNull('score')->get();

// Where Between
ArrayQuery::from($users)->whereBetween('age', 25, 30)->get();

// Like (case-insensitive)
ArrayQuery::from($users)->where('name', 'like', '%ali%')->get();

Dot Notation for Nested Arrays

$items = [
    ['name' => 'Alice', 'address' => ['city' => 'NYC']],
    ['name' => 'Bob', 'address' => ['city' => 'LA']],
];

ArrayQuery::from($items)
    ->where('address.city', '=', 'NYC')
    ->get();

API

Method Description
ArrayQuery::from(array $items) Create a new query from an array of associative arrays
where(string $key, string $operator, mixed $value) Filter by comparison (=, ==, ===, !=, <>, >, <, >=, <=, like, not like)
whereIn(string $key, array $values) Filter where value is in list
whereNotNull(string $key) Filter where value is not null
whereNull(string $key) Filter where value is null
whereBetween(string $key, mixed $min, mixed $max) Filter where value is between min and max (inclusive)
sort(string $key, string $direction = 'asc') Sort results by key (asc or desc)
limit(int $count) Limit number of results
offset(int $count) Skip a number of results
select(array $keys) Select only specified keys
pluck(string $key) Extract a single column as a flat array
groupBy(string $key) Group results by a key
map(callable $fn) Transform items with a callback
first() Get the first result or null
last() Get the last result or null
count() Count the results
get() Get all results
sum(string $key) Sum values of a key
avg(string $key) Average values of a key
min(string $key) Minimum value of a key
max(string $key) Maximum value of a key

Development

composer install
vendor/bin/phpunit
vendor/bin/pint --test
vendor/bin/phpstan analyse

License

MIT