README

A library for creating a collection of items that store arbitrary data.

Installation

Install via composer:

composer require blesta/items:~1.0

Basic Usage

Item

Item stores generic data, typically user-defined arrays or object data.

$item = new Item();

Set fields onto the item:

$fields = [
    'key' => 'item1',
    'value' => 'Item'
];
$item->setFields($fields);
$item->setField('custom', 'ABC123');
$item->removeField('value');
print_r($item->getFields());

Output is a standard class object of the fields:

stdClass Object (
    [key] => item1
    [custom] => ABC123
)

ItemMap

ItemMap combines the values from one Item with the keys of another Item. The result is a new Item consisting of only the mapped keys that have item values.

// Create the item
$fields = [
    'domain' => 'domain.com',
    'amount' => 100.0000,
    'override_amount' => 150.0000,
    'custom' => 'ABC123'
];
$item = new Item();
$item->setFields($fields);

// Create an item to use for field mapping
$mapFields = [
    'value' => 'domain',
    'price' => ['override_amount', 'amount']
    'type' => 'generic'
];
$mapItem = new Item();
$mapItem->setFields($mapFields);

$map = new ItemMap();
$newItem = $map->combine($item, $mapItem);
print_r($newItem->getFields());

The fields set on the new item are only those keys from $mapItem that exist in $item after performing the mapping:

stdClass Object (
    [value] => domain.com
    [price] => 150.0000
)

ItemCollection

$collection = new ItemCollection();

$item1 = new Item();
$item2 = new Item();
$collection->append($item1)->append($item2);
$total = $collection->count(); // 2

$collection->remove($item1);
$total = $collection->count(); // 1

foreach ($collection as $item) {
    print_r($item->getFields()); // stdClass object of fields
}