TranslationFieldFilter::filter() - Code Metrics - Inspection of "Support for KNP when using `TranslationFieldFilter..." - sonata-project/SonataTranslationBundle - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — 2.x (#311)

unknown

created 2019-11-21 14:41 UTC

TranslationFieldFilter::filter() C

↳ Parent: TranslationFieldFilter

Complexity

Conditions	12
Paths	26

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	64
rs	6.3587
c	0
b	0
f	0
cc	12
nc	26
nop	4

How to fix Long Method Complexity

<?php

declare(strict_types=1);

/*
 * This file is part of the Sonata Project package.
 *
 * (c) Thomas Rabaix <[email protected]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Sonata\TranslationBundle\Filter;

use Sonata\AdminBundle\Datagrid\ProxyQueryInterface;
use Sonata\AdminBundle\Form\Type\Filter\DefaultType;
use Sonata\DoctrineORMAdminBundle\Filter\Filter;
use Sonata\TranslationBundle\Enum\TranslationFilterMode;
use Symfony\Component\Form\Extension\Core\Type\HiddenType;
use Symfony\Component\Form\Extension\Core\Type\TextType;

final class TranslationFieldFilter extends Filter
{
    private $filterMode;

    public function __construct(string $filterMode)
    {
        $this->filterMode = $filterMode;
    }

    /**
     * {@inheritdoc}
     */
    public function filter(ProxyQueryInterface $queryBuilder, $alias, $field, $data)
    {
        if (!$data || !\is_array($data) || !\array_key_exists('value', $data) || null === $data['value']) {

            return;
        }

        $data['value'] = trim($data['value']);

        if (0 === \strlen($data['value'])) {
            return;
        }
        $joinAlias = 'tff';
        $filterMode = $this->getOption('filter_mode');

        // verify if the join is not already done
        $aliasAlreadyExists = false;
        foreach ($queryBuilder->getDQLParts()['join'] as $joins) {
            foreach ($joins as $join) {
                if ($join->getAlias() === $joinAlias) {
                    $aliasAlreadyExists = true;
                    break 2;
                }
            }
        }

        if (!$aliasAlreadyExists) {
            $queryBuilder->leftJoin($alias.'.translations', $joinAlias);
        }

        if (TranslationFilterMode::GEDMO === $filterMode) {
            // search on translation OR on normal field when using Gedmo
            $this->applyWhere($queryBuilder, $queryBuilder->expr()->orX(
                $queryBuilder->expr()->andX(
                    $queryBuilder->expr()->eq($joinAlias.'.field', $queryBuilder->expr()->literal($field)),
                    $queryBuilder->expr()->like(
                        $joinAlias.'.content',
                        $queryBuilder->expr()->literal('%'.$data['value'].'%')
                    )
                ),
                $queryBuilder->expr()->like(
                    sprintf('%s.%s', $alias, $field),
                    $queryBuilder->expr()->literal('%'.$data['value'].'%')
                )
            ));

            $this->active = true;
        } elseif (TranslationFilterMode::KNPLABS === $filterMode) {
            // search on translation OR on normal field when using Knp
            $this->applyWhere($queryBuilder,
                $queryBuilder->expr()->andX(
                    $queryBuilder->expr()->like(
                        $joinAlias.".$field",
                        $queryBuilder->expr()->literal('%'.$data['value'].'%')
                    )
                )
            );

            $this->active = true;
        } else {
            throw new \LogicException(
                sprintf('Invalid filter mode given: "%s"', $filterMode)
            );
        }
    }

    /**
     * {@inheritdoc}
     */
    public function getDefaultOptions()
    {
        return [
            'field_type' => TextType::class,
            'operator_type' => HiddenType::class,
            'filter_mode' => $this->filterMode,
            'operator_options' => [],
        ];
    }

    /**
     * {@inheritdoc}
     */
    public function getRenderSettings()
    {
        return [DefaultType::class, [
            'field_type' => $this->getFieldType(),
            'field_options' => $this->getFieldOptions(),
            'operator_type' => $this->getOption('operator_type'),
            'operator_options' => $this->getOption('operator_options'),
            'label' => $this->getLabel(),
        ]];
    }

    /**
     * {@inheritdoc}
     */
    protected function association(ProxyQueryInterface $queryBuilder, $data)
    {
        $alias = $queryBuilder->entityJoin($this->getParentAssociationMappings());

        return [$this->getOption('alias', $alias), $this->getFieldName()];
    }
}


1			<?php
2
3			declare(strict_types=1);
4
5			/*
6			* This file is part of the Sonata Project package.
7			*
8			* (c) Thomas Rabaix <[email protected]>
9			*
10			* For the full copyright and license information, please view the LICENSE
11			* file that was distributed with this source code.
12			*/
13
14			namespace Sonata\TranslationBundle\Filter;
15
16			use Sonata\AdminBundle\Datagrid\ProxyQueryInterface;
17			use Sonata\AdminBundle\Form\Type\Filter\DefaultType;
18			use Sonata\DoctrineORMAdminBundle\Filter\Filter;
19			use Sonata\TranslationBundle\Enum\TranslationFilterMode;
20			use Symfony\Component\Form\Extension\Core\Type\HiddenType;
21			use Symfony\Component\Form\Extension\Core\Type\TextType;
22
23			final class TranslationFieldFilter extends Filter
24			{
25			private $filterMode;
26
27			public function __construct(string $filterMode)
28			{
29			$this->filterMode = $filterMode;
30			}
31
32			/**
33			* {@inheritdoc}
34			*/
35			public function filter(ProxyQueryInterface $queryBuilder, $alias, $field, $data)
36			{
37			if (!$data \|\| !\is_array($data) \|\| !\array_key_exists('value', $data) \|\| null === $data['value']) {
			0 ignored issues – show Bug Best Practice introduced 2019-01-11 06:42 UTC by Report Bug Copy Issue Report The expression `$data` of type `array` is implicitly converted to a boolean; are you sure this is intended? If so, consider using `empty($expr)` instead to make it clear that you intend to check for an array without elements. This check marks implicit conversions of arrays to boolean values in a comparison. While in PHP an empty array is considered to be equal (but not identical) to false, this is not always apparent. Consider making the comparison explicit by using `empty(..)` or `! empty(...)` instead. Loading history...
38			return;
39			}
40
41			$data['value'] = trim($data['value']);
42
43			if (0 === \strlen($data['value'])) {
44			return;
45			}
46			$joinAlias = 'tff';
47			$filterMode = $this->getOption('filter_mode');
48
49			// verify if the join is not already done
50			$aliasAlreadyExists = false;
51			foreach ($queryBuilder->getDQLParts()['join'] as $joins) {
52			foreach ($joins as $join) {
53			if ($join->getAlias() === $joinAlias) {
54			$aliasAlreadyExists = true;
55			break 2;
56			}
57			}
58			}
59
60			if (!$aliasAlreadyExists) {
61			$queryBuilder->leftJoin($alias.'.translations', $joinAlias);
62			}
63
64			if (TranslationFilterMode::GEDMO === $filterMode) {
65			// search on translation OR on normal field when using Gedmo
66			$this->applyWhere($queryBuilder, $queryBuilder->expr()->orX(
67			$queryBuilder->expr()->andX(
68			$queryBuilder->expr()->eq($joinAlias.'.field', $queryBuilder->expr()->literal($field)),
69			$queryBuilder->expr()->like(
70			$joinAlias.'.content',
71			$queryBuilder->expr()->literal('%'.$data['value'].'%')
72			)
73			),
74			$queryBuilder->expr()->like(
75			sprintf('%s.%s', $alias, $field),
76			$queryBuilder->expr()->literal('%'.$data['value'].'%')
77			)
78			));
79
80			$this->active = true;
81			} elseif (TranslationFilterMode::KNPLABS === $filterMode) {
82			// search on translation OR on normal field when using Knp
83			$this->applyWhere($queryBuilder,
84			$queryBuilder->expr()->andX(
85			$queryBuilder->expr()->like(
86			$joinAlias.".$field",
87			$queryBuilder->expr()->literal('%'.$data['value'].'%')
88			)
89			)
90			);
91
92			$this->active = true;
93			} else {
94			throw new \LogicException(
95			sprintf('Invalid filter mode given: "%s"', $filterMode)
96			);
97			}
98			}
99
100			/**
101			* {@inheritdoc}
102			*/
103			public function getDefaultOptions()
104			{
105			return [
106			'field_type' => TextType::class,
107			'operator_type' => HiddenType::class,
108			'filter_mode' => $this->filterMode,
109			'operator_options' => [],
110			];
111			}
112
113			/**
114			* {@inheritdoc}
115			*/
116			public function getRenderSettings()
117			{
118			return [DefaultType::class, [
119			'field_type' => $this->getFieldType(),
120			'field_options' => $this->getFieldOptions(),
121			'operator_type' => $this->getOption('operator_type'),
122			'operator_options' => $this->getOption('operator_options'),
123			'label' => $this->getLabel(),
124			]];
125			}
126
127			/**
128			* {@inheritdoc}
129			*/
130			protected function association(ProxyQueryInterface $queryBuilder, $data)
131			{
132			$alias = $queryBuilder->entityJoin($this->getParentAssociationMappings());
133
134			return [$this->getOption('alias', $alias), $this->getFieldName()];
135			}
136			}
137

sonata-project / SonataTranslationBundle

Pull Request — 2.x (#311)

TranslationFieldFilter::filter() C

Complexity

Size

Duplication

Importance

How to fix Long Method Complexity

Long Method

Duplication Side-by-Side

Filter issues like