Completed
Push — master ( cefe26...80523f )
by Timo
23:41
created

OptionsFacetParser   A

Complexity

Total Complexity 14

Size/Duplication

Total Lines 106
Duplicated Lines 0 %

Coupling/Cohesion

Components 1
Dependencies 6

Test Coverage

Coverage 98.11%

Importance

Changes 0
Metric Value
wmc 14
lcom 1
cbo 6
dl 0
loc 106
ccs 52
cts 53
cp 0.9811
rs 10
c 0
b 0
f 0

3 Methods

Rating   Name   Duplication   Size   Complexity  
B parse() 0 50 6
A getOptionsFromSolrResponse() 0 15 3
B getMetricsFromSolrResponse() 0 20 5
1
<?php
2
namespace ApacheSolrForTypo3\Solr\Domain\Search\ResultSet\Facets\OptionBased\Options;
3
4
/*
5
 * This file is part of the TYPO3 CMS project.
6
 *
7
 * It is free software; you can redistribute it and/or modify it under
8
 * the terms of the GNU General Public License, either version 2
9
 * of the License, or any later version.
10
 *
11
 * For the full copyright and license information, please read the
12
 * LICENSE.txt file that was distributed with this source code.
13
 *
14
 * The TYPO3 project - inspiring people to share!
15
 */
16
17
use ApacheSolrForTypo3\Solr\Domain\Search\ResultSet\Facets\AbstractFacetParser;
18
use ApacheSolrForTypo3\Solr\Domain\Search\ResultSet\SearchResultSet;
19
20
/**
21
 * Class OptionsFacetParser
22
 */
23
class OptionsFacetParser extends AbstractFacetParser
24
{
25
    /**
26
     * @param SearchResultSet $resultSet
27
     * @param string $facetName
28
     * @param array $facetConfiguration
29
     * @return OptionsFacet|null
30
     */
31 50
    public function parse(SearchResultSet $resultSet, $facetName, array $facetConfiguration)
32
    {
33 50
        $response = $resultSet->getResponse();
34 50
        $fieldName = $facetConfiguration['field'];
35 50
        $label = $this->getPlainLabelOrApplyCObject($facetConfiguration);
36 50
        $optionsFromSolrResponse = $this->getOptionsFromSolrResponse($facetName, $response);
37 50
        $metricsFromSolrResponse = $this->getMetricsFromSolrResponse($facetName, $response);
38 50
        $optionsFromRequest = $this->getActiveFacetValuesFromRequest($resultSet, $facetName);
39 50
        $hasOptionsInResponse = !empty($optionsFromSolrResponse);
40 50
        $hasSelectedOptionsInRequest = count($optionsFromRequest) > 0;
41 50
        $hasNoOptionsToShow = !$hasOptionsInResponse && !$hasSelectedOptionsInRequest;
42 50
        $hideEmpty = !$resultSet->getUsedSearchRequest()->getContextTypoScriptConfiguration()->getSearchFacetingShowEmptyFacetsByName($facetName);
43
44 50
        if ($hasNoOptionsToShow && $hideEmpty) {
45 5
            return null;
46
        }
47
48
        /** @var $facet OptionsFacet */
49 48
        $facet = $this->objectManager->get(
50 48
            OptionsFacet::class,
51 48
            $resultSet,
0 ignored issues
show
Unused Code introduced by
The call to ObjectManagerInterface::get() has too many arguments starting with $resultSet.

This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue.

If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress.

In this case you can add the @ignore PhpDoc annotation to the duplicate definition and it will be ignored.

Loading history...
52 48
            $facetName,
53 48
            $fieldName,
54 48
            $label,
55 48
            $facetConfiguration
56
        );
57
58 48
        $hasActiveOptions = count($optionsFromRequest) > 0;
59 48
        $facet->setIsUsed($hasActiveOptions);
60 48
        $facet->setIsAvailable($hasOptionsInResponse);
61
62 48
        $optionsToCreate = $this->getMergedFacetValueFromSearchRequestAndSolrResponse($optionsFromSolrResponse, $optionsFromRequest);
63 48
        foreach ($optionsToCreate as $optionsValue => $count) {
64 46
            if ($this->getIsExcludedFacetValue($optionsValue, $facetConfiguration)) {
65 1
                continue;
66
            }
67
68 46
            $isOptionsActive = in_array($optionsValue, $optionsFromRequest);
69 46
            $label = $this->getLabelFromRenderingInstructions($optionsValue, $count, $facetName, $facetConfiguration);
70 46
            $facet->addOption(new Option($facet, $label, $optionsValue, $count, $isOptionsActive, $metricsFromSolrResponse[$optionsValue]));
71
        }
72
73
        // after all options have been created we apply a manualSortOrder if configured
74
        // the sortBy (lex,..) is done by the solr server and triggered by the query, therefore it does not
75
        // need to be handled in the frontend.
76 48
        $this->applyManualSortOrder($facet, $facetConfiguration);
77 48
        $this->applyReverseOrder($facet, $facetConfiguration);
78
79 48
        return $facet;
80
    }
81
82
    /**
83
     * @param string $facetName
84
     * @param \Apache_Solr_Response $response
85
     * @return array
86
     */
87 50
    protected function getOptionsFromSolrResponse($facetName, \Apache_Solr_Response $response)
88
    {
89 50
        $optionsFromSolrResponse = [];
90 50
        if (!isset($response->facets->{$facetName})) {
91 9
            return $optionsFromSolrResponse;
92
        }
93
94 47
        foreach ($response->facets->{$facetName}->buckets as $bucket) {
95 44
            $optionValue = $bucket->val;
96 44
            $optionCount = $bucket->count;
97 44
            $optionsFromSolrResponse[$optionValue] = $optionCount;
98
        }
99
100 47
        return $optionsFromSolrResponse;
101
    }
102
103
    /**
104
     * @param string $facetName
105
     * @param \Apache_Solr_Response $response
106
     * @return array
107
     */
108 50
    protected function getMetricsFromSolrResponse($facetName, \Apache_Solr_Response $response)
109
    {
110 50
        $metricsFromSolrResponse = [];
111
112 50
        if (!isset($response->facets->{$facetName}->buckets)) {
113 9
            return [];
114
        }
115
116 47
        foreach ($response->facets->{$facetName}->buckets as $bucket) {
117 44
            $bucketVariables = get_object_vars($bucket);
118 44
            foreach ($bucketVariables as $key => $value) {
119 44
                if (strpos($key, 'metrics_') === 0) {
120
                    $metricsKey = str_replace('metrics_', '', $key);
121 44
                    $metricsFromSolrResponse[$bucket->val][$metricsKey] = $value;
122
                }
123
            }
124
        }
125
126 47
        return $metricsFromSolrResponse;
127
    }
128
}
129