Arrilot\Collectors\Collector

Complexity

Total Complexity

18

Size/Duplication

Total Lines	168
Duplicated Lines	0 %

Coupling/Cohesion

Components	3
Dependencies	1

Importance

Changes

0

10 Methods

Rating	Name	Duplication	Size	Complexity
	getList()	0	1	?
A	scanCollection()	0	9	2
A	scanItem()	0	7	1
A	addIds()	0	10	3
A	select()	0	6	1
A	where()	0	6	1
A	performQuery()	0	8	2
A	collectIdsFromItem()	0	10	4
A	collectIdsFromField()	0	6	3
A	getIdsWithoutDuplications()	0	4	1

<?php

namespace Arrilot\Collectors;

use Illuminate\Support\Arr;

abstract class Collector
{
    /**
     * Ids that are collected from sources.
     *
     * @var array
     */
    protected $ids = [];

    /**
     * Fields that should be selected.
     *
     * @var mixed
     */
    protected $select = null;

    /**
     * Additional filter.
     *
     * @var mixed
     */
    protected $where = null;

    /**
     * Data keyed by id.
     *
     * @var array
     */
    protected $data = [];

    /**
     * Get data for given ids.
     *
     * @param array $ids
     * @return array
     */
    abstract protected function getList(array $ids);

    /**
     * Add a collection source.
     *
     * @param $collection
     * @param mixed $fields
     * @return $this
     */
    public function scanCollection($collection, $fields)
    {
        $fields = (array) $fields;
        foreach ($collection as $item) {
            $this->collectIdsFromItem($item, $fields);
        }

        return $this;
    }

    /**
     * Add an item source.
     *
     * @param $item
     * @param mixed $fields
     * @return $this
     */
    public function scanItem($item, $fields)
    {
        $fields = (array) $fields;
        $this->collectIdsFromItem($item, $fields);

        return $this;
    }

    /**
     * Add existeing ids array source.
     *
     * @param array $ids
     * @return $this
     */
    public function addIds($ids)
    {
        foreach ($ids as $id) {
            if ((int) $id) {
                $this->ids[] = (int) $id;
            }
        }

        return $this;
    }

    /**
     * Setter for select.
     *
     * @param mixed $select
     * @return $this
     */
    public function select($select)
    {
        $this->select = $select;

        return $this;
    }

    /**
     * Setter for where.
     *
     * @param mixed $where
     * @return $this
     */
    public function where($where)
    {
        $this->where = $where;

        return $this;
    }

    /**
     * Perform main query.
     *
     * @return array
     */
    public function performQuery()
    {
        if (empty($this->ids)) {
            return [];
        }

        return $this->getList($this->getIdsWithoutDuplications());
    }
    
    /**
     * Collect ids from source and add them to $this->ids
     *
     * @param $item
     * @param array $fields
     */
    protected function collectIdsFromItem($item, array $fields)
    {
        foreach ($fields as $field) {
            foreach ($this->collectIdsFromField($item, $field) as $id) {
                if ((int) $id) {
                    $this->ids[] = (int) $id;
                }
            }
        }
    }
    
    /**
     * Collect ids from field of item
     *
     * @param $item
     * @param string $field
     * @return array
     */
    protected function collectIdsFromField($item, $field)
    {
        $ids = Arr::get($item, $field, []);

        return is_object($ids) && method_exists($ids, 'toArray') ? $ids->toArray() : (array) $ids;
    }

    /**
     * A faster alternative to array_unique.
     *
     * @return array
     */
    protected function getIdsWithoutDuplications()
    {
        return array_flip(array_flip($this->ids));
    }
}