Passed
Push — master ( cc3f84...4a930e )
by Timo
23:43
created

BigramPhraseFields::initializeFromString()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 4
Code Lines 2

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 3
CRAP Score 1

Importance

Changes 0
Metric Value
eloc 2
dl 0
loc 4
ccs 3
cts 3
cp 1
rs 10
c 0
b 0
f 0
cc 1
nc 1
nop 2
crap 1
1
<?php
2
namespace ApacheSolrForTypo3\Solr\Domain\Search\Query\ParameterBuilder;
3
4
/***************************************************************
5
 *  Copyright notice
6
 *
7
 *  (c) 2010-2017 dkd Internet Service GmbH <[email protected]>
8
 *  All rights reserved
9
 *
10
 *  This script is part of the TYPO3 project. The TYPO3 project is
11
 *  free software; you can redistribute it and/or modify
12
 *  it under the terms of the GNU General Public License as published by
13
 *  the Free Software Foundation; either version 3 of the License, or
14
 *  (at your option) any later version.
15
 *
16
 *  The GNU General Public License can be found at
17
 *  http://www.gnu.org/copyleft/gpl.html.
18
 *
19
 *  This script is distributed in the hope that it will be useful,
20
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
21
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
22
 *  GNU General Public License for more details.
23
 *
24
 *  This copyright notice MUST APPEAR in all copies of the script!
25
 ***************************************************************/
26
27
use ApacheSolrForTypo3\Solr\Domain\Search\Query\AbstractQueryBuilder;
28
use ApacheSolrForTypo3\Solr\System\Configuration\TypoScriptConfiguration;
29
30
/**
31
 * The BigramPhraseFields class
32
 */
33
class BigramPhraseFields extends AbstractFieldList implements ParameterBuilder
34
{
35
    /**
36
     * Parameter key which should be used for Apache Solr URL query
37
     *
38
     * @var string
39
     */
40
    protected $parameterKey = 'pf2';
41
42
    /**
43
     * Parses the string representation of the fieldList (e.g. content^100, title^10) to the object representation.
44
     *
45
     * @param string $fieldListString
46
     * @param string $delimiter
47
     * @return BigramPhraseFields
48
     */
49 4
    public static function fromString(string $fieldListString, string $delimiter = ',') : BigramPhraseFields
50
    {
51 4
        return self::initializeFromString($fieldListString, $delimiter);
52
    }
53
54
    /**
55
     * @param TypoScriptConfiguration $solrConfiguration
56
     * @return BigramPhraseFields
57
     */
58 136
    public static function fromTypoScriptConfiguration(TypoScriptConfiguration $solrConfiguration)
59
    {
60 136
        $isEnabled = $solrConfiguration->getBigramPhraseSearchIsEnabled();
61 136
        if (!$isEnabled) {
62 134
            return new BigramPhraseFields(false);
63
        }
64
65 2
        return self::fromString((string)$solrConfiguration->getSearchQueryBigramPhraseFields());
66
    }
67
68
    /**
69
     * Parses the string representation of the fieldList (e.g. content^100, title^10) to the object representation.
70
     *
71
     * @param string $fieldListString
72
     * @param string $delimiter
73
     * @return BigramPhraseFields
74
     */
75 4
    protected static function initializeFromString(string $fieldListString, string $delimiter = ',') : BigramPhraseFields
76
    {
77 4
        $fieldList = self::buildFieldList($fieldListString, $delimiter);
78 4
        return new BigramPhraseFields(true, $fieldList);
79
    }
80
81
    /**
82
     * @param AbstractQueryBuilder $parentBuilder
83
     * @return AbstractQueryBuilder
84
     */
85 137
    public function build(AbstractQueryBuilder $parentBuilder): AbstractQueryBuilder
86
    {
87 137
        $bigramPhraseFieldsString = $this->toString();
88 137
        if ($bigramPhraseFieldsString === '' || !$this->getIsEnabled()) {
89 135
            return $parentBuilder;
90
        }
91
92 3
        $parentBuilder->getQuery()->getEDisMax()->setPhraseBigramFields($bigramPhraseFieldsString);
93 3
        return $parentBuilder;
94
    }
95
}
96