Piqla v1.2.1

Available methods

function Pinq(array $input = []); // Constructor

function where(callable $func): Pinq;
function select(callable $func): Pinq;
function delete(callable $func): Pinq;
function update(callable $func): Pinq;
function insert(callable $func): Pinq;
function orderBy(boolean $accending, callable $func): Pinq;
function orderAscendingBy(callable $func): Pinq;
function orderDescendingBy(callable $func): Pinq;
function distinct(): Pinq;
function join(array $list, callable $where, callable $select): Piqla;
function group(callable $heads, callable $select): Piqla[];
function count(): int;
function min(callable $func, boolean $return_item = true): mixed;
function max(callable $func, boolean $return_item = true): mixed;
function sum(callable $func): number;
function average(callable $func): Pinq;
function limit(int $count, int $offset): Pinq;
function offset(int $offset): Pinq;

function fromJsonString(string $json);
function toJsonString(): string;
function toArray(): array;

How to use

Define an array and pass that to new Piqla instance constructor

Callback functions must have one argument

This argument (its name doen't matter) is current item in list for each loop cycle

just join function has two arguments. the second argument is joined list's item

Now you can use Piqla deformer functions and call them on returned result again and again and ... (like bellow samples)

Sample

$persons = new Piqla([
    [
        "_id" => 1,
        "name" => "jack",
        "family" => "gonjishke",
        "age" => 45
    ],
    [
        "_id" => 2,
        "name" => "joe",
        "family" => "gandomi",
        "age" => 32
    ],
    [
        "_id" => 3,
        "name" => "jack",
        "family" => "landan",
        "age" => 23
    ],
    [
        "_id" => 4,
        "name" => "john",
        "family" => "val john",
        "age" => 63
    ]
]);

$addresses = new Piqla([
    ["_id" => 1, "person_id" => 2, "phone_number" => "12398747", "country" => "near", "city" => "here", "street" => "here 1", "since" => "2017/02/12"],
    ["_id" => 2, "person_id" => 1, "phone_number" => "22118965", "country" => "far", "city" => "there", "street" => "there 12", "since" => "2015/07/03"],
    ["_id" => 3, "person_id" => 2, "phone_number" => "55663322", "country" => "near", "city" => "here", "street" => "here 2", "since" => "2018/03/01"],
    ["_id" => 4, "person_id" => 3, "phone_number" => "74653689", "country" => "far", "city" => "right of there", "street" => "rot 3", "since" => "2016/05/23"],
    ["_id" => 5, "person_id" => 1, "phone_number" => "77441122", "country" => "near", "city" => "near of hear", "street" => "noh 23", "since" => "2017/10/11"]
]);

where()

$persons->where(function ($item) {
    return ($item["age"] > 35);
});

// Result: [{_id: 1, name: "jack", family: "gonjishke", age: 45},{_id: 4, name: "john", family: "val john", age: 63}]

select()

$persons->select(function ($item) {
    return ["fullname" => $item["family"] . ", " . $item["name"], "old" => ($item["age"] > 40)];
});

// Result: [fullname: "gonjishke, jack", old: true}, {fullname: "gandomi, joe", old => false}, {fullname: "landan, jack" old: false}, {fullname: "val john, john", old: true}]


$persons->select(function ($item) {
    if ($item["age"] > 40) return ["fullname" => $item["family"] . ", " . $item["name"]];
});

// Result: [fullname: "gonjishke, jack", {fullname: "val john, john"}]

delete()

$persons->delete(function ($item) {
    return $item["age"] < 40;
});

// Result: [_id: 1, name: "jack", family: "gonjishke", age: 45}, {_id: 4, name: "john", family: "val john", age: 63}]

update()

$persons->update(function ($item) {
    if ($item["age"] > 40)
        return ["age" => round($item["age"] / 2), "old" => true];
    else
        return ["old" => false];
});

// Result: [_id: 1, name: "jack", family: "gonjishke", age: 23, old: true}, {_id: 2, name: "joe", family: "gandomi", age: 32, old: false}, {_id: 3, name: "jack", family: "landan", age: 23, old: false}, {_id: 4, name: "john", family: "val john", age: 32, old: true}]

insert()

$persons->insert(function () {
    return ["name" => "nicol", "family" => "cadmiom", "old" => true];
});

// Result: [_id: 1, name: "jack", family: "gonjishke", age: 45, old: NULL}, {_id: 2, name: "joe", family: "gandomi", age: 32, old: NULL}, {_id: 3, name: "jack", family: "landan", age: 23, old: NULL}, {_id: 4, name: "john", family: "val john", age: 63, old: NULL}, {_id: NULL, name: "nicol", family: "cadmiom", old: true, age: NULL}]

orderBy()

$persons->orderBy(["name" => false, "age" => true])

// Result: [{"_id":4,"name":"john","family":"val john","age":63},{"_id":2,"name":"joe","family":"gandomi","age":32},{"_id":3,"name":"jack","family":"landan","age":23},{"_id":1,"name":"jack","family":"gonjishke","age":45}]

$persons->orderDescendingBy(function ($item) {
    return [$item["age"] > 35, -$item["age"]];
});

// Result: [_id: 1, name: "jack", family: "gonjishke", age: 45}, {_id: 4, name: "john", family: "val john", age: 63}, {_id: 3, name: "jack", family: "landan", age: 23}, {_id: 2, name: "joe", family: "gandomi", age: 32}]

distinct()

$persons->name->distinct();

// Result: [name: "jack"}, {name: "joe"}, {name: "john"}]

join()

$persons->join($addresses->toArray(), function ($left, $right) {
    return ($left["_id"] == $right["person_id"]);
}, , function ($left, $right) {
    return ["full_name" => $left["family"] . ", " . $left["name"], "phone_number" => $right["phone_number"], "address" => $right["street"] . ", " . $right["city"] . ", " . $right["country"]];
});

// Result: [{"full_name":"gonjishke, jack","phone_number":"22118965","address":"there 12, there, far"},{"full_name":"gonjishke, jack","phone_number":"77441122","address":"noh 23, near of hear, near"},{"full_name":"gandomi, joe","phone_number":"12398747","address":"here 1, here, near"},{"full_name":"gandomi, joe","phone_number":"55663322","address":"here 2, here, near"},{"full_name":"landan, jack","phone_number":"74653689","address":"rot 3, right of there, far"}]

group()

$addresses->group(function ($item) {
    return $item["country"];
}, function ($item) {
    return ["_id" => $item["_id"], "person_id" => $item["person_id"]];
});

// Result: {"near":[{"_id":1,"person_id":2},{"_id":3,"person_id":2},{"_id":5,"person_id":1}],"far":[{"_id":2,"person_id":1},{"_id":4,"person_id":3}]}

count()

$persons->count();

// Result: 4

min()

$persons->min(function ($item) {
    if ($item["name"] == "jack") {
        return $item["age"];
    }
});

// Result: {_id: 3, name: "jack", family: "landan", age: 23}

$persons->min(function ($item) {
    if ($item["name"] != "jack") {
        return strlen($item["name"]);
    }
});

// Result: {_id: 2, name: "joe", family: "gandomi", age: 32}

max()

$persons->max(function ($item) {
    if ($item["name"] == "jack") {
        return $item["age"];
    }
});

// Result: {_id: 1, name: "jack", family: "gonjishke", age: 45}

$persons->max(ffunction ($item) {
    if ($item["name"] != "jack") {
        return strlen($item["name"]);
    }
});

// Result: {_id: 4, name: "john", family: "val john", age: 63}

sum()

$persons->sum(function ($item) {
    if ($item["name"] == "jack") {
        return $item["age"];
    }
});

// Result: 68

$persons->sum(function ($item) {
    if ($item["name"] != "jack") {
        return strlen($item["name"]);
    }
});

// Result: 7

average()

$persons->average(function ($item) {
    if ($item["name"] == "jack") {
        return $item["age"];
    }
});

// Result: 34

$persons->average(function ($item) {
    if ($item["name"] != "jack") {
        return strlen($item["name"]);
    }
});

// Result: 3.5

limit()

$persons->limit(2, 1);

// Result: [_id: 2, name: "joe", family: "gandomi", age: 32}, {_id: 3, name: "jack", family: "landan", age: 23}]

offset()

$persons->offset(2);

// Result: [_id: 3, name: "jack", family: "landan", age: 23}, {_id: 4, name: "john", family: "val john", age: 63}]