Issues in SortedCmsPageQueryExpanderPlugin.php (master) - Issues in master - spryker/spryker-core - Measure and Improve Code Quality continuously with Scrutinizer

Issues (3641)

QueryExpander/SortedCmsPageQueryExpanderPlugin.php (1 issue)

Labels

Severity

Major 1

gechetspr 1

<?php

/**
 * Copyright © 2016-present Spryker Systems GmbH. All rights reserved.
 * Use of this software requires acceptance of the Evaluation License Agreement. See LICENSE file.
 */

namespace Spryker\Client\CmsPageSearch\Plugin\Elasticsearch\QueryExpander;

use Elastica\Query;
use Spryker\Client\Kernel\AbstractPlugin;
use Spryker\Client\Search\Dependency\Plugin\QueryExpanderPluginInterface;
use Spryker\Client\Search\Dependency\Plugin\QueryInterface;

/**
 * @method \Spryker\Client\CmsPageSearch\CmsPageSearchFactory getFactory()
 */
class SortedCmsPageQueryExpanderPlugin extends AbstractPlugin implements QueryExpanderPluginInterface
{
    /**
     * {@inheritDoc}
     * - Adds possibility to sort cms pages search result. Options are provided by cms page sort config builder.
     *
     * @api
     *
     * @param \Spryker\Client\Search\Dependency\Plugin\QueryInterface $searchQuery
     * @param array<string, mixed> $requestParameters
     *
     * @return \Spryker\Client\Search\Dependency\Plugin\QueryInterface
     */
    public function expandQuery(QueryInterface $searchQuery, array $requestParameters = []): QueryInterface
    {
        $this->addSortingToQuery(
            $searchQuery->getSearchQuery(),
            $requestParameters,
        );

        return $searchQuery;
interface HasName {
    /** @return string */
    public function getName();
}

class Name {
    public $name;
}

class User implements HasName {
    /** @return string|Name */
    public function getName() {
        return new Name('foo'); // This is a violation of the ``HasName`` interface
                                // which only allows a string value to be returned.
    }
}
    }

    /**
     * @param \Elastica\Query $query
     * @param array<string, mixed> $requestParameters
     *
     * @return void
     */
    protected function addSortingToQuery(Query $query, array $requestParameters): void
    {
        $sortConfig = $this->getFactory()->createSortConfigBuilder();
        $sortParamName = $sortConfig->getActiveParamName($requestParameters);
        $sortConfigTransfer = $sortConfig->getSortConfigTransfer($sortParamName);

        if ($sortConfigTransfer === null) {
            return;
        }

        $nestedSortField = $sortConfigTransfer->getFieldName() . '.' . $sortConfigTransfer->getName();
        $query->addSort(
            [
                $nestedSortField => [
                    'order' => $sortConfig->getSortDirection($sortParamName),
                ],
            ],
        );
    }
}


1			<?php
2
3			/**
4			* Copyright © 2016-present Spryker Systems GmbH. All rights reserved.
5			* Use of this software requires acceptance of the Evaluation License Agreement. See LICENSE file.
6			*/
7
8			namespace Spryker\Client\CmsPageSearch\Plugin\Elasticsearch\QueryExpander;
9
10			use Elastica\Query;
11			use Spryker\Client\Kernel\AbstractPlugin;
12			use Spryker\Client\Search\Dependency\Plugin\QueryExpanderPluginInterface;
13			use Spryker\Client\Search\Dependency\Plugin\QueryInterface;
14
15			/**
16			* @method \Spryker\Client\CmsPageSearch\CmsPageSearchFactory getFactory()
17			*/
18			class SortedCmsPageQueryExpanderPlugin extends AbstractPlugin implements QueryExpanderPluginInterface
19			{
20			/**
21			* {@inheritDoc}
22			* - Adds possibility to sort cms pages search result. Options are provided by cms page sort config builder.
23			*
24			* @api
25			*
26			* @param \Spryker\Client\Search\Dependency\Plugin\QueryInterface $searchQuery
27			* @param array<string, mixed> $requestParameters
28			*
29			* @return \Spryker\Client\Search\Dependency\Plugin\QueryInterface
30			*/
31			public function expandQuery(QueryInterface $searchQuery, array $requestParameters = []): QueryInterface
32			{
33			$this->addSortingToQuery(
34			$searchQuery->getSearchQuery(),
35			$requestParameters,
36			);
37
38			return $searchQuery;
			0 ignored issues – show Bug Best Practice introduced 2020-01-15 11:45 UTC by Report Bug Copy Issue Report Show Similar Issues like this The expression `return $searchQuery` returns the type `Spryker\Client\Search\De...y\Plugin\QueryInterface` which is incompatible with the return type mandated by `Spryker\Client\SearchExt...nterface::expandQuery()` of `Spryker\Client\SearchExt...y\Plugin\QueryInterface`. In the issue above, the returned value is violating the contract defined by the mentioned interface. Let's take a look at an example: interface HasName { /** @return string / public function getName(); } class Name { public $name; } class User implements HasName { /* @return string\|Name */ public function getName() { return new Name('foo'); // This is a violation of the ``HasName`` interface // which only allows a string value to be returned. } } Loading history...
39			}
40
41			/**
42			* @param \Elastica\Query $query
43			* @param array<string, mixed> $requestParameters
44			*
45			* @return void
46			*/
47			protected function addSortingToQuery(Query $query, array $requestParameters): void
48			{
49			$sortConfig = $this->getFactory()->createSortConfigBuilder();
50			$sortParamName = $sortConfig->getActiveParamName($requestParameters);
51			$sortConfigTransfer = $sortConfig->getSortConfigTransfer($sortParamName);
52
53			if ($sortConfigTransfer === null) {
54			return;
55			}
56
57			$nestedSortField = $sortConfigTransfer->getFieldName() . '.' . $sortConfigTransfer->getName();
58			$query->addSort(
59			[
60			$nestedSortField => [
61			'order' => $sortConfig->getSortDirection($sortParamName),
62			],
63			],
64			);
65			}
66			}
67

spryker / spryker-core

Issues (3641)

QueryExpander/SortedCmsPageQueryExpanderPlugin.php (1 issue)

Labels

Severity

Introduced By

Duplication Side-by-Side

Filter issues like