Silverback\ApiComponentBundle\Entity\SortableTrait

Complexity

Total Complexity

7

Size/Duplication

Total Lines	50
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes

0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	setSort()	0	4	1
A	getSort()	0	3	1
B	calculateSort()	0	13	5

<?php

namespace Silverback\ApiComponentBundle\Entity;

use Doctrine\Common\Collections\ArrayCollection;
use Doctrine\Common\Collections\Collection;
use Doctrine\ORM\Mapping as ORM;
use Symfony\Component\Validator\Constraints as Assert;

/**
 * Trait SortableTrait
 * @package Silverback\ApiComponentBundle\Entity
 * @author Daniel West <daniel@silverback.is>
 */
trait SortableTrait
{
    /**
     * @ORM\Column(type="integer", nullable=false)
     * @Assert\NotNull()
     * @var int
     */
    protected $sort;

    /**
     * @return int
     */
    public function getSort(): int
    {
        return $this->sort;
    }

    /**
     * @param int $sort
     * @return SortableTrait|SortableInterface
     */
    public function setSort(int $sort = 0)
    {
        $this->sort = $sort;
        return $this;
    }

    /**
     * @param bool|null $sortLast
     * @return int
     */
    final public function calculateSort(?bool $sortLast = null): int
    {
        /* @var $collection Collection|SortableInterface[] */
        $collection = $this->getSortCollection();
        if (null === $sortLast) {
            return 0;
        }
        if ($sortLast) {
            $lastItem = $collection->last();
            return $lastItem ? ($lastItem->getSort() + 1) : 0;
        }
        $firstItem = $collection->first();
        return $firstItem ? ($firstItem->getSort() - 1) : 0;
    }

    /**
     * @return ArrayCollection
     */
    abstract public function getSortCollection(): ArrayCollection;
}