Aura\Marshal\Collection\GenericCollection

Complexity

Total Complexity

3

Size/Duplication

Total Lines	32
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

2 Methods

Rating	Name	Duplication	Size	Complexity
A	isEmpty()	0	3	1
A	getFieldValues()	0	7	2

<?php
/**
 *
 * This file is part of the Aura project for PHP.
 *
 * @package Aura.Marshal
 *
 * @license https://opensource.org/licenses/mit-license.php MIT
 *
 */
namespace Aura\Marshal\Collection;

use Aura\Marshal\Data;
use Aura\Marshal\ToArrayInterface;
use Aura\Marshal\ToArrayTrait;

/**
 *
 * Represents a generic collection of entities.
 *
 * @package Aura.Marshal
 *
 */
class GenericCollection extends Data implements ToArrayInterface
{
    use ToArrayTrait;

    /**
     *
     * Returns an array of all values for a single field in the collection.
     *
     * @param string $field The field name to retrieve values for.
     *
     * @return array<int|string, mixed>
     *
     */
    public function getFieldValues($field)
    {
        $values = [];
        foreach ($this->data as $offset => $entity) {
            $values[$offset] = $entity->$field;
        }
        return $values;
    }

    /**
     *
     * Is the collection empty?
     *
     * @return bool
     *
     */
    public function isEmpty()
    {
        return empty($this->data);
    }
}