Arp\LaminasDoctrine\Query\Filter\AbstractFilter

Complexity

Total Complexity

9

Size/Duplication

Total Lines	88
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	3	1
A	validateFieldName()	0	10	3
A	formatValue()	0	3	1
A	resolveValue()	0	12	2
A	resolveFieldName()	0	5	2

<?php

declare(strict_types=1);

namespace Arp\LaminasDoctrine\Query\Filter;

use Arp\LaminasDoctrine\Query\Exception\InvalidArgumentException;
use Arp\LaminasDoctrine\Query\Metadata\MetadataInterface;
use Arp\LaminasDoctrine\Query\QueryFilterManager;

/**
 * @author  Alex Patterson <alex.patterson.webdev@gmail.com>
 * @package Arp\LaminasDoctrine\Query\Filter
 */
abstract class AbstractFilter implements FilterInterface
{
    /**
     * @var QueryFilterManager
     */
    protected QueryFilterManager $queryFilterManager;

    /**
     * @param QueryFilterManager $queryFilterManager
     */
    public function __construct(QueryFilterManager $queryFilterManager)
    {
        $this->queryFilterManager = $queryFilterManager;
    }

    /**
     * @param MetadataInterface $metadata
     * @param array             $criteria
     * @param string            $key
     *
     * @return string
     */
    protected function resolveFieldName(MetadataInterface $metadata, array $criteria, string $key): string

The parameter $metadata is not used and could be removed.

    {
        if (empty($criteria[$key])) {
            throw new InvalidArgumentException(
                sprintf('The required \'%s\' is missing', $key)
            );
        }

The function implicitly returns null when the if condition on line 39 is false. This is incompatible with the type-hinted return string. Consider adding a return statement or allowing null as return value.

    }

    /**
     * @param MetadataInterface $metadata
     * @param string            $fieldName
     * @param string            $entityName
     *
     * @throws InvalidArgumentException
     */
    protected function validateFieldName(MetadataInterface $metadata, string $fieldName, string $entityName): void
    {
        if (!$metadata->hasField($fieldName) && !$metadata->hasAssociation($fieldName)) {
            throw new InvalidArgumentException(
                sprintf(
                    'Unable to apply query filter \'%s\': '
                    . 'The entity class \'%s\' has no field or association named \'%s\'',
                    static::class,
                    $entityName,
                    $fieldName
                )
            );
        }
    }

    /**
     * @param string $fieldName
     * @param array  $criteria
     *
     * @return mixed
     *
     * @throws InvalidArgumentException
     */
    protected function resolveValue(string $fieldName, array $criteria)
    {
        if (!array_key_exists('value', $criteria)) {
            throw new InvalidArgumentException(
                sprintf(
                    'The required \'value\' criteria value is missing for filter \'%s::%s\'',
                    static::class,
                    $fieldName
                )
            );
        }
        return $criteria['value'];
    }

    /**
     * @param MetadataInterface $metadata
     * @param string            $fieldName
     * @param mixed             $value
     * @param string|null       $format
     *
     * @return mixed
     *
     * @noinspection PhpUnusedParameterInspection
     */
    protected function formatValue(MetadataInterface $metadata, string $fieldName, $value, ?string $format = null)

The parameter $format is not used and could be removed.

The parameter $fieldName is not used and could be removed.

The parameter $metadata is not used and could be removed.

    {
        return $value;
    }
}