ListSorter\AbstractListSorter

Complexity

Total Complexity

15

Size/Duplication

Total Lines	118
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Test Coverage

Coverage

100%

Importance

Changes

0

10 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	5	1
	getSortBy()	0	1	?
	getSortDir()	0	1	?
A	getRequest()	0	4	1
A	setRequest()	0	4	1
A	getSortableItems()	0	4	1
A	setSortableItems()	0	13	3
A	validateSortableItems()	0	12	3
A	extractKeys()	0	14	3
A	areKeysUnique()	0	8	2

<?php

declare(strict_types=1);

namespace ListSorter;

use Illuminate\Http\Request;

abstract class AbstractListSorter
{
    protected $request;
    protected $sortableItems;

    public function __construct(Request $request, array $sortableItems)
    {
        $this->setRequest($request);
        $this->setSortableItems($sortableItems);
    }

    /**
     * @return string
     */
    abstract public function getSortBy();

    /**
     * @return string
     */
    abstract public function getSortDir();

    /**
     * @return Request
     */
    public function getRequest()
    {
        return $this->request;
    }

    /**
     * @param Request $request
     */
    public function setRequest(Request $request)

You have injected the Request via parameter $request. This is generally not recommended as there might be multiple instances during a request cycle (f.e. when using sub-requests). Instead, it is recommended to inject the RequestStack and retrieve the current request each time you need it via getCurrentRequest().

    {
        $this->request = $request;
    }

    /**
     * @return array
     */
    public function getSortableItems()
    {
        return $this->sortableItems;
    }

    /**
     * @param array $sortableItems
     *
     * @throws \Exception
     */
    public function setSortableItems(array $sortableItems)
    {
        // validate aliases
        $this->validateSortableItems($sortableItems);

        foreach ($sortableItems as $key => $sortableItem) {
            if (!$sortableItem instanceof SortableItem) {
                $sortableItems[$key] = new SortableItem($sortableItem);
            }
        }

        $this->sortableItems = $sortableItems;
    }

    /**
     * @param array $sortableItems
     *
     * @throws \Exception
     *
     * @return bool
     */
    private function validateSortableItems(array $sortableItems)
    {
        if (empty($sortableItems)) {
            throw new \Exception('Sortable items can not be empty');
        }

        if ($this->areKeysUnique($this->extractKeys($sortableItems)) !== true) {
            throw new \Exception('Sortable item alias must be unique');
        }

        return true;
    }

    /**
     * @param array $sortableItems
     *
     * @return array
     */
    private function extractKeys(array $sortableItems)
    {
        $keys = [];
        foreach ($sortableItems as $sortableItem) {
            if (!$sortableItem instanceof SortableItem) {
                $keys[] = $sortableItem;
                continue;
            }

            $keys[] = $sortableItem->getKey();
        }

        return $keys;
    }

    /**
     * @param array $aliases
     *
     * @return bool
     */
    private function areKeysUnique(array $aliases)
    {
        if (count($aliases) === count(array_unique($aliases))) {
            return true;
        }

        return false;
    }
}