happyproff / earray

EArray is a small PHP class to provide convenient ways to access a PHP Array.

EArray

EArray is a small PHP class to provide convenient ways to access a PHP Array.

• Convenient accessing a nested array.
• Supporting a default value.
• Supporting a normal array operation.
• Implement sort functions.

It aims to remove code that checks array key existence. Especially for a nested array. Do you hate like the following code?

$val = null;
$arr2 = isset($arr["key"]) ? $arr["key"] : null;
if (is_array($arr2)) {
    $val = isset($arr2["key2"]) ? $arr2["key2"] : null;
}

echo $val;

You can write same things using EArray object.

$val = $earray->get("key/key2", null);
echo $val;

Requirement

PHP5.3 or later.

Installation

You can use composer installation. Make composer.json file like the following.

{
      "require": {
          "kohkimakimoto/earray": "2.0.*"
      }
}

And run composer install command.

$ curl -s http://getcomposer.org/installer | php
$ php composer.phar install

Usage

Accessing array values

<?php
use Kohkimakimoto\EArray\EArray;

$earray = new EArray(array("foo" => "bar"));
$earray->get("foo");             # "bar"
$earray->get("foo2");            # null
$earray->get("foo2", "default"); # "default"

$earray->set("foo", "bar2");
$earray->get("foo");             # "bar2"

$earray->delete("foo");
$earray->get("foo");             # null

Accessing nested array values

<?php
use Kohkimakimoto\EArray\EArray;

$earray = new EArray(
    array(
        "foo" => array(
            "foo2" => array(
                "foo3",
                "foo4",
                ),
            "foo2-1" => "foo5",
            ),
        "bar",
        "hoge",
        )
);

// You can get value from a nested array using a delimiter (default "/")
$earray->get("foo/foo2-1");             # "foo5".
$earray->get("foo");                    # EArray(array("foo2" => array("foo3","foo4",),"foo2-1" => "foo5"))
$earray->get("foo")->get("foo2-1");     # "foo5".
$earray->get("foo")->toArray();         # array("foo2" => array("foo3","foo4",),"foo2-1" => "foo5")

// You can change a delimiter by the third argument.
$earray->get("foo.foo2-1", null, ".");  # "foo5"

// You can set a nested array using a delimiter
$earray->set("foo/foo2-1", "foo5-modify");
$earray->get("foo/foo2-1");             # "foo5-modify".

You can specify a default delemiter by constructor

<?php
use Kohkimakimoto\EArray\EArray;

$earray = new EArray(array("foo" => array("bar" => "value")), ".");

$earray->get("foo.bar"));    // "value"

Sort an array

<?php
use Kohkimakimoto\EArray\EArray;

$array = array();
$array["f"]["details"]["weight"] = 1;
$array["f"]["details"]["position"] = 34;
$array["e"]["details"]["weight"] = 2;
$array["e"]["details"]["position"] = 33;
$array["d"]["details"]["weight"] = 3;
$array["d"]["details"]["position"] = 22;
$array["c"]["details"]["weight"] = 4;
$array["c"]["details"]["position"] = 11;
$array["b"]["details"]["weight"] = 5;
$array["b"]["details"]["position"] = 2;
$array["a"]["details"]["weight"] = 6;
$array["a"]["details"]["position"] = 1;

$earray = new EArray($array);
print_r($earray->sort("details/position")->toArray());  // sort by details/position 

// Result
// array("a" => array(...), "b" => array(...), "c" => array(...), "d" => array(...), ...)

print_r($earray->rsort("details/position")->toArray());  // reverse sort by details/position 

// Result
// array("f" => array(...), "e" => array(...), "d" => array(...), "c" => array(...), ...)

Using like a normal array

<?php
use Kohkimakimoto\EArray\EArray;

$earray = new EArray(array(
    "foo" => "bar",
    "foo1" => "bar1",
    "foo2" => "bar2",
    "foo3" => "bar3",
    "foo4" => "bar4",
));

foreach ($earray as $k => $v) {
   echo $v;  # "bar", "bar1", "bar2", ...
}

License

Apache License 2.0