kapitanluffy/array-legacy

dev-master 2018-11-12 10:11 UTC

MIT

• Kapitanluffy Pirata

README

A class for converting arrays into fault-tolerant objects. Its aim is to access arrays as usual but without checking if a key is "set".

// No more checking if the key is set
if (isset($foo['baz')) {
    $baz = $foo['baz'];
}

// No more setting a default value
if (isset($foo['bar') == false) {
    $foo['bar'] = 'default value';
}

What are "legacy" arrays?

These are arrays that are used like objects. After working with "legacy" codes, I have seen many of them use arrays to store data. They (the developers) did not bother creating objects that would "model" their data because there's "not enough time" or "too much refactoring".

With ArrayLegacy, we can avoid this..

NOTICE Undefined index: Foo on line number 5

Usage

Convert an array into an ArrayLegacy

$foo = [
    "title" => "FooBar",
    "in_stock" => 1000,
    "price" => 100
];

$foo = ArrayLegacy::make($foo);

Use like an array

$foo['title'] = "FooBaz";
// Output: FooBaz
echo $foo['title'];

Use a getter/setter method

$foo->setInStock(999);
// Output: 999
echo $foo->getInStock();

Use get/set methods

$foo->set("price", 99);
// Output: 99
echo $foo->get("price");

With get() you can also specify a default value if the key does not exist

// Output: This is a default description
echo $foo->get("description", "This is a default description");

Remove a key using unset()

unset($foo["title"]);
// Output: null
echo $foo["title"];

Use a mutator when accessing/modifying a key

// Note that mutators should directly access `attributes` property
class Foo extends ArrayLegacy {
    public function setTitle($value) {
        $this->attributes['title'] = strtolower($value);
    }

    public function getTitle() {
        return ucwords($this->attributes['title']);
    }
}

$foo = new Foo($foo);
echo $foo->setTitle("This is a test");

// Output: This Is A Test
echo $foo->getTitle();

Using PHP array functions

You can use array functions by calling it directly in the object.

• Functions with an array_ prefix can be called without the prefix.
• Functions returning the array type will return a new ArrayLegacy instance.
• Functions that pass the array by reference will modify the current instance.

Unsupported functions are the following:

• array_combine
• array_fill_keys
• array_fill
• range
• list
• extract

$foo = new Foo($foo);

// calls array_keys, returns a new ArrayLegacy instance of keys
$foo->keys('bar');

// calls shuffle and applies it to the current instance
$foo->shuffle();