Spiral\Listing\ListingSerializer

Complexity

Total Complexity

13

Size/Duplication

Total Lines	133
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	6

Importance

Changes	1
Bugs	0	Features	0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	7	1
A	getID()	0	4	1
A	toArray()	0	9	1
A	jsonSerialize()	0	4	1
A	listingID()	0	4	1
A	packSorting()	0	13	3
A	packFilters()	0	9	2
B	packPagination()	0	31	3

<?php
/**
 * Spiral Framework.
 *
 * @license   MIT
 * @author    Anton Titov (Wolfy-J)
 */
namespace Spiral\Listing;


use Spiral\Listing\Exceptions\InvalidSelectorException;
use Spiral\Listing\Traits\SelectorValidationTrait;
use Spiral\ODM\Entities\DocumentSelector;
use Spiral\ORM\Entities\RecordSelector;
use Spiral\Pagination\Paginator;
use Spiral\Pagination\PaginatorAwareInterface;
use Spiral\Pagination\PaginatorInterface;

/**
 * Packs listing state into array form.
 */
class ListingSerializer implements \JsonSerializable
{
    use SelectorValidationTrait;

    /**
     * @var Listing
     */
    private $listing = null;

    /**
     * @var PaginatorAwareInterface|RecordSelector|DocumentSelector
     */
    private $selector = null;

    /**
     * @param Listing                                                 $listing
     * @param PaginatorAwareInterface|RecordSelector|DocumentSelector $selector
     *
     * @throws InvalidSelectorException
     */
    public function __construct(Listing $listing, PaginatorAwareInterface $selector)
    {
        $this->validateSelector($selector);

        $this->listing = $listing;
        $this->selector = $selector;
    }

    /**
     * Unique id associated with listing.
     *
     * @return string
     */
    public function getID()
    {
        return md5(spl_object_hash($this->listing));
    }

    /**
     * @return array
     */
    public function toArray()
    {
        return [
            'namespace'  => $this->listing->getNamespace(),
            'sorting'    => $this->packSorting(),
            'filters'    => $this->packFilters(),
            'pagination' => $this->packPagination()
        ];
    }

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

    /**
     * @param Listing $listing
     * @return string
     */
    public static function listingID(Listing $listing)
    {
        return md5(spl_object_hash($listing));
    }

    /**
     * @return array
     */
    protected function packSorting()
    {
        $packed = [
            'sorter' => $this->listing->getSorter(),
        ];

        $sorter = $this->listing->activeSorter();
        if ($sorter instanceof DirectionalSorterInterface) {
            $packed['direction'] = $sorter->getDirection() == SorterInterface::ASC ? 'asc' : 'desc';
        }

        return $packed;
    }

    /**
     * @return array
     */
    protected function packFilters()
    {
        $packed = [];
        foreach ($this->listing->activeFilters() as $name => $filter) {
            $packed[$name] = $filter->getValue();
        }

        return $packed;
    }

    /**
     * @return array
     */
    protected function packPagination()
    {
        /**
         * @var PaginatorInterface $paginator
         */
        $paginator = $this->selector->getPaginator();

        if ($paginator instanceof Paginator) {
            return [
                'page'         => $paginator->getPage(),

                //Total items
                'total'        => $paginator->count(),

                //Pages around
                'countPages'   => $paginator->countPages(),
                'nextPage'     => $paginator->nextPage(),
                'previousPage' => $paginator->previousPage(),

                //Limitations
                'limit'        => $paginator->getLimit(),
                'limits'       => $this->listing->getLimits()
            ];
        } else {
            return [
                'page'   => floor($paginator->getOffset() / $paginator->getLimit()) ?: 1,
                'limit'  => $paginator->getLimit(),
                'limits' => $this->listing->getLimits()
            ];
        }
    }
}