TranslationAdminListConfigurator::canExport() - Code Metrics - Inspection of "Merge pull request #2603 from Numkil/feature/useCo..." - Kunstmaan/KunstmaanBundlesCMS - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 9cc4a0...6da605 )

by Jeroen

created 2020-01-13 18:39 UTC

TranslationAdminListConfigurator::canExport() A

↳ Parent: TranslationAdminListConfigurator

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

Metric	Value
dl	0
loc	4
ccs	0
cts	3
cp	0
rs	10
c	0
b	0
f	0
cc	1
nc	1
nop	0
crap	2

<?php

namespace Kunstmaan\TranslatorBundle\AdminList;

use Doctrine\DBAL\Connection;
use Doctrine\DBAL\Query\QueryBuilder;
use Kunstmaan\AdminListBundle\AdminList\Configurator\AbstractDoctrineDBALAdminListConfigurator;
use Kunstmaan\AdminListBundle\AdminList\Configurator\ChangeableLimitInterface;
use Kunstmaan\AdminListBundle\AdminList\Field;
use Kunstmaan\AdminListBundle\AdminList\FieldAlias;
use Kunstmaan\AdminListBundle\AdminList\FilterType\DBAL\EnumerationFilterType;
use Kunstmaan\AdminListBundle\AdminList\FilterType\DBAL\StringFilterType;
use Kunstmaan\AdminListBundle\Traits\ChangeableLimitTrait;
use Kunstmaan\TranslatorBundle\Entity\Translation;

/**
 * TranslationAdminListConfigurator
 */
class TranslationAdminListConfigurator extends AbstractDoctrineDBALAdminListConfigurator implements ChangeableLimitInterface
{
    use ChangeableLimitTrait;

    /**
     * @var array
     */
    protected $locales;

    /**
     * @var string
     */
    protected $locale;

    /**
     * @var Field[]
     */
    private $exportFields = [];


    /**
     * @param Connection $connection
     * @param array      $locales
     */
    public function __construct(Connection $connection, array $locales)
    {
        parent::__construct($connection);
        $this->locales = $locales;
        $this->setCountField('CONCAT(b.translation_id)');
    }

    /**
     * Configure filters
     */
    public function buildFilters()
    {
        $this->addFilter('status', new StringFilterType('status'), 'kuma_translator.adminlist.filter.status');
        $this->addFilter('domain', new StringFilterType('domain'), 'kuma_translator.adminlist.filter.domain');
        $this->addFilter('keyword', new StringFilterType('keyword'), 'kuma_translator.adminlist.filter.keyword');
        $this->addFilter('text', new StringFilterType('text'), 'kuma_translator.adminlist.filter.text');
        $this->addFilter('locale', new EnumerationFilterType('locale'), 'kuma_translator.adminlist.filter.locale', array_combine(
            $this->locales,
            $this->locales
        ));
    }

    /**
     * Configure the visible columns
     */
    public function buildFields()
    {
        $this->addField('domain', 'kuma_translator.adminlist.header.domain', true);
        $this->addField('keyword', 'kuma_translator.adminlist.header.keyword', true);
        $this->addField('status', 'kuma_translator.adminlist.header.status', true);
    }

    public function getExportFields()
    {
        if (empty($this->exportFields)) {
            $this->addExportField('domain', 'kuma_translator.adminlist.header.domain');
            $this->addExportField('keyword', 'kuma_translator.adminlist.header.keyword');

            $this->locales = array_unique($this->locales);
            // Field building hack...
            foreach ($this->locales as $locale) {
                $this->addExportField($locale, strtoupper($locale));
            }

            $this->addExportField('status', 'kuma_translator.adminlist.header.status');
        }

        return $this->exportFields;
    }

    public function addExportField($name, $header, $template = null, FieldAlias $alias = null)
    {
        $this->exportFields[] = new Field($name, $header);

        return $this;
    }

    /**
     * @return bool
     */
    public function canAdd()
    {
        return true;
    }

    /**
     * @param object|array $item
     *
     * @return bool
     */
    public function canEdit($item)
    {
        return false;
    }

    /**
     * @param object|array $item
     *
     * @return bool
     */
    public function canEditInline($item)
    {
        return true;
    }

    /**
     * @return bool
     */
    public function canExport()
    {
        return true;
    }

    /**
     * Override path convention (because settings is a virtual admin subtree)
     *
     * @param string $suffix

     *
     * @return string
     */
    public function getPathByConvention($suffix = null)

    {
        if (empty($suffix)) {
            return sprintf('%s_settings_%ss', $this->getBundleName(), strtolower($this->getEntityName()));
        }

        return sprintf('%s_settings_%ss_%s', $this->getBundleName(), strtolower($this->getEntityName()), $suffix);
    }

    /**
     * {@inheritdoc}
     */
    public function getAdminType($item)
    {
        return null;
    }

    public function getBundleName()
    {
        return 'KunstmaanTranslatorBundle';
    }

    public function getEntityName()
    {
        return 'Translation';
    }

    public function getControllerPath()
    {
        return 'KunstmaanTranslatorBundle:Index';
    }

    /**
     * @return QueryBuilder|null
     */
    public function getQueryBuilder()
    {
        if (\is_null($this->queryBuilder)) {
            $this->queryBuilder = new QueryBuilder($this->connection);
            $this->queryBuilder
                ->select('DISTINCT b.translation_id AS id, b.keyword, b.domain, b.status')
                ->from('kuma_translation', 'b')
                ->andWhere('b.status != :statusstring')
                ->setParameter('statusstring', Translation::STATUS_DISABLED);

            // Apply filters
            $filters = $this->getFilterBuilder()->getCurrentFilters();
            $locales = [];

            $textValue = $textComparator = null;
            foreach ($filters as $filter) {
                if ($filter->getType() instanceof EnumerationFilterType && $filter->getColumnName() == 'locale') {
                    // Override default enumeration filter handling ... catch selected locales here
                    $data = $filter->getData();
                    $comparator = $filter->getType()->getComparator();
                    if ($comparator == 'in') {
                        $locales = $data['value'];
                    } elseif ($comparator == 'notin') {
                        $locales = array_diff($this->locales, $data['value']);
                    }
                } elseif ($filter->getType() instanceof StringFilterType && $filter->getColumnName() == 'text') {
                    // Override default text filter handling ...
                    $data = $filter->getData();
                    $textValue = $data['value'];
                    $textComparator = $data['comparator'];
                } else {
                    /* @var AbstractDBALFilterType $type */
                    $type = $filter->getType();
                    $type->setQueryBuilder($this->queryBuilder);
                    $filter->apply();
                }
            }

            if (!empty($locales)) {
                $this->locales = $locales;
            }
            $this->locales = array_unique($this->locales);

            // Field building hack...
            foreach ($this->locales as $locale) {
                $this->addField($locale, strtoupper($locale), false, '@KunstmaanTranslator/Translator/inline_edit.html.twig');
            }

            // Field filter hack...
            $this->addFilter('locale', new EnumerationFilterType('locale'), 'kuma_translator.adminlist.filter.locale', array_combine(
                $this->locales,
                $this->locales
            ));

            // Add join for every locale
            foreach ($this->locales as $locale) {
                $this->queryBuilder->addSelect('t_'.$locale.'.`text` AS '.$locale);
                $this->queryBuilder->addSelect('t_'.$locale.'.id AS '.$locale.'_id');
                $this->queryBuilder->leftJoin(
                    'b',
                    'kuma_translation',
                    't_'.$locale,
                    'b.keyword = t_'.$locale.'.keyword and b.domain = t_'.$locale.'.domain and t_'.$locale.'.locale=:locale_'.$locale
                );
                $this->queryBuilder->setParameter('locale_'.$locale, $locale);
            }

            // Apply text filter
            if (!\is_null($textValue) && !\is_null($textComparator)) {
                $orX = $this->queryBuilder->expr()->orX();

                foreach ($this->locales as $key => $locale) {
                    $uniqueId = 'txt_'.$key;
                    switch ($textComparator) {
                        case 'equals':
                            $expr = $this->queryBuilder->expr()->eq('t_'.$locale.'.`text`', ':var_'.$uniqueId);
                            $this->queryBuilder->setParameter('var_'.$uniqueId, $textValue);

                            break;
                        case 'notequals':
                            $expr = $this->queryBuilder->expr()->neq('t_'.$locale.'.`text`', ':var_'.$uniqueId);
                            $this->queryBuilder->setParameter('var_'.$uniqueId, $textValue);

                            break;
                        case 'contains':

                            $expr = $this->queryBuilder->expr()->like('t_'.$locale.'.`text`', ':var_'.$uniqueId);
                            $this->queryBuilder->setParameter('var_'.$uniqueId, '%'.$textValue.'%');

                            break;
                        case 'doesnotcontain':

                            $expr = 't_'.$locale.'.`text`'.' NOT LIKE :var_'.$uniqueId;
                            $this->queryBuilder->setParameter('var_'.$uniqueId, '%'.$textValue.'%');

                            break;
                        case 'startswith':
                            $expr = $this->queryBuilder->expr()->like('t_'.$locale.'.`text`', ':var_'.$uniqueId);
                            $this->queryBuilder->setParameter('var_'.$uniqueId, $textValue.'%');

                            break;
                        case 'endswith':
                            $expr = $this->queryBuilder->expr()->like('t_'.$locale.'.`text`', ':var_'.$uniqueId);
                            $this->queryBuilder->setParameter('var_'.$uniqueId, '%'.$textValue);

                            break;
                        case 'empty':
                            $expr = $this->queryBuilder->expr()->orX(
                                $this->queryBuilder->expr()->isNull('t_'.$locale.'.`text`'),
                                $this->queryBuilder->expr()->eq('t_'.$locale.'.`text`', '\'-\''),
                                $this->queryBuilder->expr()->eq('t_'.$locale.'.`text`', '\'\'')
                            );

                            break;
                    }
                    $orX->add($expr);
function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}
                }

                $this->queryBuilder->andWhere($orX);
            }

            // Apply sorting
            if (!empty($this->orderBy)) {

                $orderBy = $this->orderBy;
                $this->queryBuilder->orderBy($orderBy, ($this->orderDirection == 'DESC' ? 'DESC' : 'ASC'));
            }
        }

        return $this->queryBuilder;
    }
}


1		<?php
2
3		namespace Kunstmaan\TranslatorBundle\AdminList;
4
5		use Doctrine\DBAL\Connection;
6		use Doctrine\DBAL\Query\QueryBuilder;
7		use Kunstmaan\AdminListBundle\AdminList\Configurator\AbstractDoctrineDBALAdminListConfigurator;
8		use Kunstmaan\AdminListBundle\AdminList\Configurator\ChangeableLimitInterface;
9		use Kunstmaan\AdminListBundle\AdminList\Field;
10		use Kunstmaan\AdminListBundle\AdminList\FieldAlias;
11		use Kunstmaan\AdminListBundle\AdminList\FilterType\DBAL\EnumerationFilterType;
12		use Kunstmaan\AdminListBundle\AdminList\FilterType\DBAL\StringFilterType;
13		use Kunstmaan\AdminListBundle\Traits\ChangeableLimitTrait;
14		use Kunstmaan\TranslatorBundle\Entity\Translation;
15
16		/**
17		* TranslationAdminListConfigurator
18		*/
19		class TranslationAdminListConfigurator extends AbstractDoctrineDBALAdminListConfigurator implements ChangeableLimitInterface
20		{
21		use ChangeableLimitTrait;
22
23		/**
24		* @var array
25		*/
26		protected $locales;
27
28		/**
29		* @var string
30		*/
31		protected $locale;
32
33		/**
34		* @var Field[]
35		*/
36		private $exportFields = [];
		0 ignored issues – show Comprehensibility introduced 2019-12-12 09:59 UTC by Report Bug Copy Issue Report Consider using a different property name as you override a private property of the parent class. Loading history...
37
38		/**
39		* @param Connection $connection
40		* @param array $locales
41		*/
42		public function __construct(Connection $connection, array $locales)
43		{
44		parent::__construct($connection);
45		$this->locales = $locales;
46		$this->setCountField('CONCAT(b.translation_id)');
47		}
48
49		/**
50		* Configure filters
51		*/
52		public function buildFilters()
53		{
54		$this->addFilter('status', new StringFilterType('status'), 'kuma_translator.adminlist.filter.status');
55		$this->addFilter('domain', new StringFilterType('domain'), 'kuma_translator.adminlist.filter.domain');
56		$this->addFilter('keyword', new StringFilterType('keyword'), 'kuma_translator.adminlist.filter.keyword');
57		$this->addFilter('text', new StringFilterType('text'), 'kuma_translator.adminlist.filter.text');
58		$this->addFilter('locale', new EnumerationFilterType('locale'), 'kuma_translator.adminlist.filter.locale', array_combine(
59		$this->locales,
60		$this->locales
61		));
62		}
63
64		/**
65		* Configure the visible columns
66		*/
67		public function buildFields()
68		{
69		$this->addField('domain', 'kuma_translator.adminlist.header.domain', true);
70		$this->addField('keyword', 'kuma_translator.adminlist.header.keyword', true);
71		$this->addField('status', 'kuma_translator.adminlist.header.status', true);
72		}
73
74		public function getExportFields()
75		{
76		if (empty($this->exportFields)) {
77		$this->addExportField('domain', 'kuma_translator.adminlist.header.domain');
78		$this->addExportField('keyword', 'kuma_translator.adminlist.header.keyword');
79
80		$this->locales = array_unique($this->locales);
81		// Field building hack...
82		foreach ($this->locales as $locale) {
83		$this->addExportField($locale, strtoupper($locale));
84		}
85
86		$this->addExportField('status', 'kuma_translator.adminlist.header.status');
87		}
88
89		return $this->exportFields;
90		}
91
92		public function addExportField($name, $header, $template = null, FieldAlias $alias = null)
93		{
94		$this->exportFields[] = new Field($name, $header);
95
96		return $this;
97		}
98
99		/**
100		* @return bool
101		*/
102		public function canAdd()
103		{
104		return true;
105		}
106
107		/**
108		* @param object\|array $item
109		*
110		* @return bool
111		*/
112		public function canEdit($item)
113		{
114		return false;
115		}
116
117		/**
118		* @param object\|array $item
119		*
120		* @return bool
121		*/
122		public function canEditInline($item)
123		{
124		return true;
125		}
126
127		/**
128		* @return bool
129		*/
130		public function canExport()
131		{
132		return true;
133		}
134
135		/**
136		* Override path convention (because settings is a virtual admin subtree)
137		*
138		* @param string $suffix
		0 ignored issues – show Documentation introduced 2017-11-21 06:15 UTC by Report Bug Copy Issue Report Should the type for parameter `$suffix` not be `string\|null`? This check looks for `@param` annotations where the type inferred by our type inference engine differs from the declared type. It makes a suggestion as to what type it considers more descriptive. Most often this is a case of a parameter that can be null in addition to its declared types. Loading history...
139		*
140		* @return string
141		*/
142	View Code Duplication	public function getPathByConvention($suffix = null)
		0 ignored issues – show Duplication introduced 2017-11-21 06:15 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
143		{
144		if (empty($suffix)) {
145		return sprintf('%s_settings_%ss', $this->getBundleName(), strtolower($this->getEntityName()));
146		}
147
148		return sprintf('%s_settings_%ss_%s', $this->getBundleName(), strtolower($this->getEntityName()), $suffix);
149		}
150
151		/**
152		* {@inheritdoc}
153		*/
154		public function getAdminType($item)
155		{
156		return null;
157		}
158
159		public function getBundleName()
160		{
161		return 'KunstmaanTranslatorBundle';
162		}
163
164		public function getEntityName()
165		{
166		return 'Translation';
167		}
168
169		public function getControllerPath()
170		{
171		return 'KunstmaanTranslatorBundle:Index';
172		}
173
174		/**
175		* @return QueryBuilder\|null
176		*/
177		public function getQueryBuilder()
178		{
179		if (\is_null($this->queryBuilder)) {
180		$this->queryBuilder = new QueryBuilder($this->connection);
181		$this->queryBuilder
182		->select('DISTINCT b.translation_id AS id, b.keyword, b.domain, b.status')
183		->from('kuma_translation', 'b')
184		->andWhere('b.status != :statusstring')
185		->setParameter('statusstring', Translation::STATUS_DISABLED);
186
187		// Apply filters
188		$filters = $this->getFilterBuilder()->getCurrentFilters();
189		$locales = [];
190
191		$textValue = $textComparator = null;
192		foreach ($filters as $filter) {
193		if ($filter->getType() instanceof EnumerationFilterType && $filter->getColumnName() == 'locale') {
194		// Override default enumeration filter handling ... catch selected locales here
195		$data = $filter->getData();
196		$comparator = $filter->getType()->getComparator();
197		if ($comparator == 'in') {
198		$locales = $data['value'];
199		} elseif ($comparator == 'notin') {
200		$locales = array_diff($this->locales, $data['value']);
201		}
202		} elseif ($filter->getType() instanceof StringFilterType && $filter->getColumnName() == 'text') {
203		// Override default text filter handling ...
204		$data = $filter->getData();
205		$textValue = $data['value'];
206		$textComparator = $data['comparator'];
207		} else {
208		/* @var AbstractDBALFilterType $type */
209		$type = $filter->getType();
210		$type->setQueryBuilder($this->queryBuilder);
211		$filter->apply();
212		}
213		}
214
215		if (!empty($locales)) {
216		$this->locales = $locales;
217		}
218		$this->locales = array_unique($this->locales);
219
220		// Field building hack...
221		foreach ($this->locales as $locale) {
222		$this->addField($locale, strtoupper($locale), false, '@KunstmaanTranslator/Translator/inline_edit.html.twig');
223		}
224
225		// Field filter hack...
226		$this->addFilter('locale', new EnumerationFilterType('locale'), 'kuma_translator.adminlist.filter.locale', array_combine(
227		$this->locales,
228		$this->locales
229		));
230
231		// Add join for every locale
232		foreach ($this->locales as $locale) {
233		$this->queryBuilder->addSelect('t_'.$locale.'.`text` AS '.$locale);
234		$this->queryBuilder->addSelect('t_'.$locale.'.id AS '.$locale.'_id');
235		$this->queryBuilder->leftJoin(
236		'b',
237		'kuma_translation',
238		't_'.$locale,
239		'b.keyword = t_'.$locale.'.keyword and b.domain = t_'.$locale.'.domain and t_'.$locale.'.locale=:locale_'.$locale
240		);
241		$this->queryBuilder->setParameter('locale_'.$locale, $locale);
242		}
243
244		// Apply text filter
245		if (!\is_null($textValue) && !\is_null($textComparator)) {
246		$orX = $this->queryBuilder->expr()->orX();
247
248		foreach ($this->locales as $key => $locale) {
249		$uniqueId = 'txt_'.$key;
250		switch ($textComparator) {
251		case 'equals':
252		$expr = $this->queryBuilder->expr()->eq('t_'.$locale.'.`text`', ':var_'.$uniqueId);
253		$this->queryBuilder->setParameter('var_'.$uniqueId, $textValue);
254
255		break;
256		case 'notequals':
257		$expr = $this->queryBuilder->expr()->neq('t_'.$locale.'.`text`', ':var_'.$uniqueId);
258		$this->queryBuilder->setParameter('var_'.$uniqueId, $textValue);
259
260		break;
261	View Code Duplication	case 'contains':
		0 ignored issues – show Duplication introduced 2017-11-21 06:15 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
262		$expr = $this->queryBuilder->expr()->like('t_'.$locale.'.`text`', ':var_'.$uniqueId);
263		$this->queryBuilder->setParameter('var_'.$uniqueId, '%'.$textValue.'%');
264
265		break;
266	View Code Duplication	case 'doesnotcontain':
		0 ignored issues – show Duplication introduced 2017-11-21 06:15 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
267		$expr = 't_'.$locale.'.`text`'.' NOT LIKE :var_'.$uniqueId;
268		$this->queryBuilder->setParameter('var_'.$uniqueId, '%'.$textValue.'%');
269
270		break;
271		case 'startswith':
272		$expr = $this->queryBuilder->expr()->like('t_'.$locale.'.`text`', ':var_'.$uniqueId);
273		$this->queryBuilder->setParameter('var_'.$uniqueId, $textValue.'%');
274
275		break;
276		case 'endswith':
277		$expr = $this->queryBuilder->expr()->like('t_'.$locale.'.`text`', ':var_'.$uniqueId);
278		$this->queryBuilder->setParameter('var_'.$uniqueId, '%'.$textValue);
279
280		break;
281		case 'empty':
282		$expr = $this->queryBuilder->expr()->orX(
283		$this->queryBuilder->expr()->isNull('t_'.$locale.'.`text`'),
284		$this->queryBuilder->expr()->eq('t_'.$locale.'.`text`', '\'-\''),
285		$this->queryBuilder->expr()->eq('t_'.$locale.'.`text`', '\'\'')
286		);
287
288		break;
289		}
290		$orX->add($expr);
		0 ignored issues – show Bug introduced 2017-11-21 06:15 UTC by Report Bug Copy Issue Report The variable `$expr` does not seem to be defined for all execution paths leading up to this point. If you define a variable conditionally, it can happen that it is not defined for all execution paths. Let’s take a look at an example: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } // $x is potentially undefined here. echo $x; } In the above example, the variable `$x` is defined if you pass “foo” or “bar” as argument for `$a`. However, since the `switch` statement has no default case statement, if you pass any other value, the variable `$x` would be undefined. Available Fixes Check for existence of the variable explicitly: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } if (isset($x)) { // Make sure it's always set. echo $x; } } Define a default value for the variable: function myFunction($a) { $x = ''; // Set a default which gets overridden for certain paths. switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } echo $x; } Add a value for the missing path: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; // We add support for the missing case. default: $x = ''; break; } echo $x; } Loading history...
291		}
292
293		$this->queryBuilder->andWhere($orX);
294		}
295
296		// Apply sorting
297	View Code Duplication	if (!empty($this->orderBy)) {
		0 ignored issues – show Duplication introduced 2017-11-21 06:15 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
298		$orderBy = $this->orderBy;
299		$this->queryBuilder->orderBy($orderBy, ($this->orderDirection == 'DESC' ? 'DESC' : 'ASC'));
300		}
301		}
302
303		return $this->queryBuilder;
304		}
305		}
306

Kunstmaan / KunstmaanBundlesCMS

Push — master ( 9cc4a0...6da605 )

TranslationAdminListConfigurator::canExport() A

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like