KGzocha\Searcher\Criteria\Adapter\MappedOrderByAdapter

Complexity

Total Complexity

13

Size/Duplication

Total Lines	95
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Test Coverage

Coverage

100%

Importance

Changes

0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	8	1
A	getMappedOrderBy()	0	8	2
A	getFieldsMap()	0	4	1
A	getOrderBy()	0	4	1
A	setOrderBy()	0	4	1
A	shouldBeApplied()	0	4	2
A	checkFieldsMapType()	0	11	4
A	rawValueExistsInFieldsMap()	0	4	1

<?php
declare(strict_types=1);

namespace KGzocha\Searcher\Criteria\Adapter;

use KGzocha\Searcher\Criteria\OrderByCriteriaInterface;

/**
 * This adapter can be used if end-user should not see the actual parameter values
 * that are used in sorting. In order to do so, please provide parameter $fieldsMap.
 * Fields map key should be a value that will be visible to end-user.
 * Fields map value will be visible to developer.
 * To get "mapped" value (for end-user) just use getOrderBy()
 * To get "real" value (for developer) use getMappedOrderBy().
 *
 * @author Krzysztof Gzocha <krzysztof@propertyfinder.ae>
 */
class MappedOrderByAdapter implements OrderByCriteriaInterface
{
    /**
     * @var OrderByCriteriaInterface
     */
    private $orderBy;

    /**
     * @var array|\ArrayAccess
     */
    private $fieldsMap;

    /**
     * @param OrderByCriteriaInterface $orderBy
     * @param array|\ArrayAccess       $fieldsMap keys will be visible to user,
     *                                            values to CriteriaBuilder
     */
    public function __construct(
        OrderByCriteriaInterface $orderBy,
        $fieldsMap
    ) {
        $this->checkFieldsMapType($fieldsMap);
        $this->orderBy = $orderBy;
        $this->fieldsMap = $fieldsMap;
    }

    /**
     * @return string|null Returns null if user will enter value that is not in fieldsMap
     */
    public function getMappedOrderBy()
    {
        if ($this->rawValueExistsInFieldsMap()) {
            return $this->fieldsMap[$this->getOrderBy()];
        }

        return null;
    }

    /**
     * @return array|\ArrayAccess
     */
    public function getFieldsMap()
    {
        return $this->fieldsMap;
    }

    /**
     * {@inheritdoc}
     */
    public function getOrderBy()
    {
        return $this->orderBy->getOrderBy();
    }

    /**
     * {@inheritdoc}
     */
    public function setOrderBy(string $orderBy = null)
    {
        return $this->orderBy->setOrderBy($orderBy);
    }

    /**
     * {@inheritdoc}
     */
    public function shouldBeApplied(): bool
    {
        return $this->orderBy->shouldBeApplied() && $this->rawValueExistsInFieldsMap();
    }

    /**
     * @param mixed $fieldsMap
     *
     * @throws \InvalidArgumentException
     */
    private function checkFieldsMapType($fieldsMap)
    {
        if (!is_array($fieldsMap) && !$fieldsMap instanceof \ArrayAccess) {
            throw new \InvalidArgumentException(sprintf(
                'Parameter fieldsMap passed to %s should be an array or \ArrayAccess.'
                .' Given: %s',
                __CLASS__,
                is_object($fieldsMap) ? get_class($fieldsMap) : gettype($fieldsMap)
            ));
        }
    }

    /**
     * @return bool
     */
    private function rawValueExistsInFieldsMap(): bool
    {
        return array_key_exists($this->getOrderBy(), $this->fieldsMap);
    }
}