Documentation

Documentation

The usage is very simple and straightfoward, lets see:

Table of contents

• Declaration
• Add
  • Array operator
  • add()
• Remove
  • remove()
  • php unset()
  • clear()
• Update
  • Array operator
  • update()
• Search
  • Array operator
  • get()
  • find()
  • getAll()
  • indexOf()
  • keyOf()
  • offsetExists()
  • getOffsets()
  • count()
• Iterate
  • each()
  • php foreach
• Serialize
  • serialize()
  • unserialize()
• Json
  • toJson()
  • fromJson()
  • php json_encode

Declaration

$friendsAge = new Collection();

Add

Collection provides 2 methods for adding data.

• By array operator.
• By function.

When using collection add function, you can chain functions.

Add with Array Operator

// By Array Operator.
$friendsAge["andrew"] = 23;
$friendsAge["bob"] = 28;
$friendsAge["carl"] = 26;

add function

// You can chain functions.
$friendsAge->add("diana", 23)
           ->add("earl", 18)
           ->add("frank", 26);

Remove

To delete data you can use 3 ways:

• Collection remove function.
• Php unset function.
• Collection clear function.

Remove with Array Operator

unset($friendsAge["franklin"]);

remove function

// You can chain functions.
$friendsAge->remove("joey")
           ->remove("andrew");

clear function

// Clear entire collection
$friendsAge->clear();

Update

Whenever you want to update a value in your collection you can do it with two different ways:

• By array operator.
• By function

Note: When you use update function, if the key doesnt exist, this one will be added to your collection.

Update with Array Operator

$friendsAge["franklin"] = 20;

update Function

// With associative key access.
$friendsAge->update("franklin", 20);

// With index access. update(index, value);
$friendsAge->update(3, 48);

Search

Search with Array Operator

$friendsAge["franklin"];

get function

// Using associative key.
$friendsAge->get("franklin");

// Using index.
$friendsAge->get(1);

find function

/* This function accepts a callable with two parameters $key and $value. 
   You can map the return with a boolean value to get specific value.
*/

$mySpecificValue = $friendsAge->find(function($key, $value){
    return ($value == '20'); // returns the first value thats equals to '20'.
});

$mySpecificValue = $friendsAge->find(function($key, $value){
    return ($key == 'earl' || $key == 'john'); // returns the first one of the two values.  
});

getAll function

// Returns an array with collection values.
$valuesArray = $friendsAge->getAll();

indexOf function

// Returns the index of the given associative key.
$index = $friendsAge->indexOf("franklin");

keyOf function

// Returns the associative key of the given index.
$key = $friendsAge->keyOf(2);

offsetExists function

// Returns true or false if the offset exists.

// With associative key
$friendsAge->offsetExists("franklin");

// With index 
$friendsAge->offsetExists(1);

getOffsets function

// Returns all associative keys
$keys = $friendsAge->getOffsets();

count function

// Get the number of elements in your collection.
$size = $friendsAge->count();

Iterate

each function

/* This function accepts as argument a callable object. 
   This callable object contains 2 parameters, one for the offset and the other for the value.
   If you return anything inside the callable, you will receive those values back stored in a array.
*/
$myReturnedValuesArray = $friendsAge->each(function($key, $value){
    return "{$key} is {$value} old!";
});

Using foreach

foreach($friendsAge as $friend => $age){
    echo "{$friend} is {$age} old!";
}

Serialize

serialize function

$value = $friendsAge->serialize();

unserialize function

$friendsAge->unserialize($value);

Json

toJson function

$json = $friendsAge->toJson();

fromJson function

$friendsAge->fromJson($json);

Using json_encode

$json = json_encode($friendsAge);