Nayjest\Collection\Extended\ObjectCollectionTrait

Complexity

Total Complexity

13

Size/Duplication

Total Lines	120
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Test Coverage

Coverage

42.86%

Importance

Changes	8
Bugs	1	Features	2

11 Methods

Rating	Name	Duplication	Size	Complexity
	find()	0	1	?
	filter()	0	1	?
	toArray()	0	1	?
	sort()	0	1	?
A	findByType()	0	4	1
A	filterByType()	0	4	1
A	filterByProperty()	0	6	1
A	findByProperty()	0	6	1
A	sortByProperty()	0	12	3
A	getPropertyComparator()	0	13	3
A	indexByProperty()	0	11	3

<?php

namespace Nayjest\Collection\Extended;

use mp;

/**
 * Implementation of methods added in ObjectCollectionReadInterface.
 *
 * ObjectCollectionTrait requires implementation of \Nayjest\Collection\CollectionReadInterface.
 */
trait ObjectCollectionTrait
{

    /**
     * @param callable $callback
     * @param array|null $optionalArguments
     * @return static
     */
    abstract public function find(callable $callback, array $optionalArguments = null);

    /**
     * @param callable $callback
     * @param array|null $optionalArguments
     * @return static
     */
    abstract public function filter(callable $callback, array $optionalArguments = null);

    abstract public function toArray();

    /**
     * @param callable $compareFunction
     * @return static
     */
    abstract public function sort(callable $compareFunction);

    /**
     * @param string $className
     *
     * @return mixed
     */
    public function findByType($className)
    {
        return $this->find('is_a', [$className]);
    }

    /**
     * @param string $className
     * @return static
     */
    public function filterByType($className)
    {
        return $this->filter('is_a', [$className]);
    }

    /**
     * @param string $propertyName
     * @param $value
     * @param bool $useGetters
     * @return static
     */
    public function filterByProperty($propertyName, $value, $useGetters = false)
    {
        return $this->filter(
            $this->getPropertyComparator($propertyName, $value, $useGetters)
        );
    }

    /**
     * @param string $propertyName
     * @param $value
     * @param bool $useGetters
     * @return mixed
     */
    public function findByProperty($propertyName, $value, $useGetters = false)
    {
        return $this->find(
            $this->getPropertyComparator($propertyName, $value, $useGetters)
        );
    }

    /**
     * @param string $propertyName
     * @return static
     */
    public function sortByProperty($propertyName)
    {

        return $this->sort(function ($itemA, $itemB) use ($propertyName) {
            $a = mp\getValue($itemA, $propertyName, 0);
            $b = mp\getValue($itemB, $propertyName, 0);
            if ($a < $b) {
                return -1;
            }
            return ($a > $b) ? 1 : 0;
        });
    }

    private function getPropertyComparator($propertyName, $value, $useGetters)
    {
        if ($useGetters) {
            return function ($item) use ($propertyName, $value) {
                // NAN used as default because NAN !== NAN
                return mp\getValue($item, $propertyName, NAN) === $value;
            };
        } else {
            return function ($item) use ($propertyName, $value) {
                return isset($item->{$propertyName}) && $item->{$propertyName} === $value;
            };
        }
    }

    /**
     * Returns array indexed by specified property of collection elements.
     * If there is few elements with same property value, last will be used.
     *
     * @param string $propertyName
     * @return array|object[]
     */
    public function indexByProperty($propertyName)
    {
        $results = [];
        foreach ($this->toArray() as $item) {
            $key = mp\getValue($item, $propertyName);
            if ($key) {
                $results[$key] = $item;
            }
        }
        return $results;
    }
}