apollonin / array-filter

Array-filter

Array-filter is a library for filtering arrays in python-way. You can set up your condition as an array index, and get a filtered array..

Array-filter supports any of comparison operators [==, != , >, <, >=, <=]. Also you can use one of condition operators (AND -> &&, OR -> ||)

Installation

Via composer

composer require seredenko/array-filter

Usage

create a new array-filter object and put your array for filtering

  $yourArray = [
    0 => ['name' => 'John', 'balance' => 1.00, 'isActive' => true],
    1 => ['name' => 'Mike', 'balance' => 10.00, 'isActive' => true],
    2 => ['name' => 'Gregor', 'balance' => 100.00, 'isActive' => false],
    ...
  ];


  $filter = new ArrayFilter($yourArray);

using simple filter

  $filteredArray1 = $filter['name == John'];

  $filteredArray2 = $filter['balance > 5'];

  $filteredArray3 = $filter['suspicious != true'];

using filter with condition

  $filteredArray1 = $filter['name == John && balance > 5'];

  $filteredArray2 = $filter['balance > 5 || suspicious != true'];

  $filteredArray3 = $filter['suspicious != true && balance != 0'];

**An array-filter returns a new self-object with filtered array. You can use chaining keys for filtering the already result **

  // second key will filter result of first key

  $filteredArray = $filter['isActive == true || balance == 6.99']['suspicious == false && age < 40']

If you want to get specific fields from the original array or from filtered array, input a line with the desired fields, divided by ':'

  $filteredArray = $filter['name == Gregory || balance == 6.99']['name:balance'];

If you want to get a filtered result as a normal php array, you can get it via methods or data turning directly to the array

  // return filtered result with fresh keys, from 0 to end of array
  $result = $filteredArray->array_values();
  
  // return filtered result with saving keys from original array
  $result = $filteredArray->getArrayCopy();
  
  // cast object to array
  $result = (array) $filteredArray;

Set new value for one of the fields in the filtered array

  $filteredArray = $filter['name == Gregory || balance == 6.99']['name:balance'];
  $filteredArray['balance'] = 0;

Get slice of filtered array by start and end keys. Be sure that you first field bigger than second

  $result = $filter['balance:name'];
  
  //  $result = $filter['name:balance']; throw exception InvalidRangeFields

You can use the array-filter object like a normal array in loops

  foreach($filteredArray as $value)
  {
    print_r($value);
  }