SolrSearchAdapter::getSearchQueryWriter() - Code Metrics - Inspection of "WIP: Add nested filtering via Criteria and Criteri..." - silverstripe/silverstripe-fulltextsearch - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#150)

unknown

created 2018-07-12 01:27 UTC

SolrSearchAdapter::getSearchQueryWriter() C

↳ Parent: SolrSearchAdapter

Complexity

Conditions	13
Paths	13

Size

Total Lines	27
Code Lines	20

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	13
eloc	20
nc	13
nop	1
dl	0
loc	27
rs	6.6166
c	0
b	0
f	0

How to fix Complexity

<?php

namespace SilverStripe\FullTextSearch\Search\Adapters;

use SilverStripe\FullTextSearch\Search\Criteria\SearchCriteria;
use SilverStripe\FullTextSearch\Search\Criteria\SearchCriterion;
use SilverStripe\FullTextSearch\Search\Queries\AbstractSearchQueryWriter;
use SilverStripe\FullTextSearch\Solr\Writers\SolrSearchQueryWriterBasic;
use SilverStripe\FullTextSearch\Solr\Writers\SolrSearchQueryWriterIn;
use SilverStripe\FullTextSearch\Solr\Writers\SolrSearchQueryWriterRange;
use InvalidArgumentException;

/**
 * Class SolrSearchAdapter
 * @package SilverStripe\FullTextSearch\Search\Adapters
 */
class SolrSearchAdapter implements SearchAdapterInterface
{
    /**
     * @param SearchCriterion $criterion
     * @return string
     * @throws InvalidArgumentException
     */
    public function generateQueryString(SearchCriterion $criterion)
    {
        $writer = $this->getSearchQueryWriter($criterion);

        return $writer->generateQueryString($criterion);
    }

    /**
     * @param string $conjunction
     * @return string
     * @throws InvalidArgumentException
     */
    public function getConjunctionFor($conjunction)
    {
        switch ($conjunction) {
            case SearchCriteria::CONJUNCTION_AND:
            case SearchCriteria::CONJUNCTION_OR:
                return sprintf(' %s ', $conjunction);
            default:
                throw new InvalidArgumentException(
                    sprintf('Invalid conjunction supplied to SolrSearchAdapter: "%s".', $conjunction)
                );
        }
    }

    /**
     * @return string
     */
    public function getPrependToCriteriaComponent()
    {
        return '+';
    }

    /**
     * @return string
     */
    public function getAppendToCriteriaComponent()
    {
        return '';
    }

    /**
     * @return string
     */
    public function getOpenComparisonContainer()
    {
        return '(';
    }

    /**
     * @return string
     */
    public function getCloseComparisonContainer()
    {
        return ')';
    }

    /**
     * @param SearchCriterion $searchCriterion
     * @return AbstractSearchQueryWriter
     * @throws InvalidArgumentException
     */
    protected function getSearchQueryWriter(SearchCriterion $searchCriterion)
    {
        if ($searchCriterion->getSearchQueryWriter() instanceof AbstractSearchQueryWriter) {

            // The user has defined their own SearchQueryWriter, so we should just return it.
            return $searchCriterion->getSearchQueryWriter();
        }

        switch ($searchCriterion->getComparison()) {
            case SearchCriterion::EQUAL:
            case SearchCriterion::NOT_EQUAL:
                return SolrSearchQueryWriterBasic::create();
            case SearchCriterion::IN:
            case SearchCriterion::NOT_IN:
                return SolrSearchQueryWriterIn::create();
            case SearchCriterion::GREATER_EQUAL:
            case SearchCriterion::GREATER_THAN:
            case SearchCriterion::LESS_EQUAL:
            case SearchCriterion::LESS_THAN:
            case SearchCriterion::ISNULL:
            case SearchCriterion::ISNOTNULL:
                return SolrSearchQueryWriterRange::create();
            case SearchCriterion::CUSTOM:
                // CUSTOM requires a SearchQueryWriter be provided. One can't have been provided, or it would have been
                // picked up at the top of the method.
                throw new InvalidArgumentException('SearchQueryWriter undefined or unsupported in SearchCriterion');
            default:
                throw new InvalidArgumentException('Unsupported comparison type in SolrSearchAdapter');
        }
    }
}


1			<?php
2
3			namespace SilverStripe\FullTextSearch\Search\Adapters;
4
5			use SilverStripe\FullTextSearch\Search\Criteria\SearchCriteria;
6			use SilverStripe\FullTextSearch\Search\Criteria\SearchCriterion;
7			use SilverStripe\FullTextSearch\Search\Queries\AbstractSearchQueryWriter;
8			use SilverStripe\FullTextSearch\Solr\Writers\SolrSearchQueryWriterBasic;
9			use SilverStripe\FullTextSearch\Solr\Writers\SolrSearchQueryWriterIn;
10			use SilverStripe\FullTextSearch\Solr\Writers\SolrSearchQueryWriterRange;
11			use InvalidArgumentException;
12
13			/**
14			* Class SolrSearchAdapter
15			* @package SilverStripe\FullTextSearch\Search\Adapters
16			*/
17			class SolrSearchAdapter implements SearchAdapterInterface
18			{
19			/**
20			* @param SearchCriterion $criterion
21			* @return string
22			* @throws InvalidArgumentException
23			*/
24			public function generateQueryString(SearchCriterion $criterion)
25			{
26			$writer = $this->getSearchQueryWriter($criterion);
27
28			return $writer->generateQueryString($criterion);
29			}
30
31			/**
32			* @param string $conjunction
33			* @return string
34			* @throws InvalidArgumentException
35			*/
36			public function getConjunctionFor($conjunction)
37			{
38			switch ($conjunction) {
39			case SearchCriteria::CONJUNCTION_AND:
40			case SearchCriteria::CONJUNCTION_OR:
41			return sprintf(' %s ', $conjunction);
42			default:
43			throw new InvalidArgumentException(
44			sprintf('Invalid conjunction supplied to SolrSearchAdapter: "%s".', $conjunction)
45			);
46			}
47			}
48
49			/**
50			* @return string
51			*/
52			public function getPrependToCriteriaComponent()
53			{
54			return '+';
55			}
56
57			/**
58			* @return string
59			*/
60			public function getAppendToCriteriaComponent()
61			{
62			return '';
63			}
64
65			/**
66			* @return string
67			*/
68			public function getOpenComparisonContainer()
69			{
70			return '(';
71			}
72
73			/**
74			* @return string
75			*/
76			public function getCloseComparisonContainer()
77			{
78			return ')';
79			}
80
81			/**
82			* @param SearchCriterion $searchCriterion
83			* @return AbstractSearchQueryWriter
84			* @throws InvalidArgumentException
85			*/
86			protected function getSearchQueryWriter(SearchCriterion $searchCriterion)
87			{
88			if ($searchCriterion->getSearchQueryWriter() instanceof AbstractSearchQueryWriter) {
			0 ignored issues – show introduced 2018-07-11 22:53 UTC by Report Bug Copy Issue Report `$searchCriterion->getSearchQueryWriter()` is always a sub-type of `SilverStripe\FullTextSea...stractSearchQueryWriter`. Loading history...
89			// The user has defined their own SearchQueryWriter, so we should just return it.
90			return $searchCriterion->getSearchQueryWriter();
91			}
92
93			switch ($searchCriterion->getComparison()) {
94			case SearchCriterion::EQUAL:
95			case SearchCriterion::NOT_EQUAL:
96			return SolrSearchQueryWriterBasic::create();
97			case SearchCriterion::IN:
98			case SearchCriterion::NOT_IN:
99			return SolrSearchQueryWriterIn::create();
100			case SearchCriterion::GREATER_EQUAL:
101			case SearchCriterion::GREATER_THAN:
102			case SearchCriterion::LESS_EQUAL:
103			case SearchCriterion::LESS_THAN:
104			case SearchCriterion::ISNULL:
105			case SearchCriterion::ISNOTNULL:
106			return SolrSearchQueryWriterRange::create();
107			case SearchCriterion::CUSTOM:
108			// CUSTOM requires a SearchQueryWriter be provided. One can't have been provided, or it would have been
109			// picked up at the top of the method.
110			throw new InvalidArgumentException('SearchQueryWriter undefined or unsupported in SearchCriterion');
111			default:
112			throw new InvalidArgumentException('Unsupported comparison type in SolrSearchAdapter');
113			}
114			}
115			}
116

silverstripe / silverstripe-fulltextsearch

Pull Request — master (#150)

SolrSearchAdapter::getSearchQueryWriter() C

Complexity

Size

Duplication

Importance

How to fix Complexity

Long Method

Duplication Side-by-Side

Filter issues like