dcelasun/extract_property

Extracts a given property from an array of objects

extract_property() for PHP

, _(*1)

This simple library provides an easy way to extract a given property from an array of objects., _(*2)

Usage

array extract_property( array $objects, mixed $key [, mixed $index] )

Given an array of objects, extract_property() returns the values from a single property of each object, identified by $key. Optionally, you may provide an $index to index the values in the returned array by the values from the $index property of each object in the input array., _(*3)

For example, using the following $users array, we tell extract_property() to return an array of just the names, indexed by their record IDs., _(*4)

``` php <?php $users = array();, <sub>(*5)</sub>

$a = new stdClass; $b = new stdClass; $c = new stdClass;, <sub>(*6)</sub>

$a->id = 1; $a->name = 'John'; $a->surname = 'Doe';, <sub>(*7)</sub>

$users[] = $a;, <sub>(*8)</sub>

$b->id = 2; $b->name = 'Jane'; $b->surname = 'Doe';, <sub>(*9)</sub>

$users[] = $b;, <sub>(*10)</sub>

$c->id = 3; $c->name = 'Foo'; $c->surname = 'Bar';, <sub>(*11)</sub>

$users[] = $c;, <sub>(*12)</sub>

$names = extract_property($users, 'name', 'id');, <sub>(*13)</sub>

If we call `print_r()` on `$names`, you'll see a resulting array that looks
a bit like this:

``` text
Array
(
    [1] => John
    [2] => Jane
    [3] => Foo
)

You could of course omit the $index so the resulting array looks like this:, <sub>(*14)</sub>

``` text Array ( [0] => John [1] => Jane [2] => Foo ), <sub>(*15)</sub>

## Installation

The easiest way to install this library is to use Composer and add the following
to your project's `composer.json` file:

``` javascript
{
    "require": {
        "dcelasun/extract_property": "1.*"
    }
}

Then, when you run composer install, everything will fall magically into place, and the extract_property() function will be available to your project, as long as you are including Composer's autoloader., <sub>(*16)</sub>

However, you do not need Composer to use this library., <sub>(*17)</sub>

This library has no dependencies and should work on older versions of PHP. Download the code and include src/extract_property.php in your project, and everything should work fine., <sub>(*18)</sub>