https://github.com/kapitanluffy/array-legacy
A class for converting arrays into fault-tolerant objects
https://github.com/kapitanluffy/array-legacy
arrays legacy-code php
Last synced: about 2 months ago
JSON representation
A class for converting arrays into fault-tolerant objects
- Host: GitHub
- URL: https://github.com/kapitanluffy/array-legacy
- Owner: kapitanluffy
- License: mit
- Created: 2018-11-06T08:25:00.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2018-11-12T10:12:07.000Z (over 6 years ago)
- Last Synced: 2025-02-07T03:25:37.588Z (3 months ago)
- Topics: arrays, legacy-code, php
- Language: PHP
- Size: 5.86 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ArrayLegacy
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".
```php
// 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
```php
$foo = [
"title" => "FooBar",
"in_stock" => 1000,
"price" => 100
];
$foo = ArrayLegacy::make($foo);
```
Use like an array
```php
$foo['title'] = "FooBaz";
// Output: FooBaz
echo $foo['title'];
```
Use a getter/setter method
```php
$foo->setInStock(999);
// Output: 999
echo $foo->getInStock();
```
Use get/set methods
```php
$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
```php
// Output: This is a default description
echo $foo->get("description", "This is a default description");
```
Remove a key using `unset()`
```php
unset($foo["title"]);
// Output: null
echo $foo["title"];
```
Use a mutator when accessing/modifying a key
```php
// 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](https://secure.php.net/manual/en/ref.array.php) 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
```php
$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();
```