QueryStringContainer::getKeywordsRaw() - Code Metrics - Inspection of "[TASK] Update licence to GPL3 or later in composer..." - dkd-kaehm/ext-solr - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 6ee2a7...5f60a5 )

by Rafael

created 2018-02-02 09:41 UTC

QueryStringContainer::getKeywordsRaw() A

↳ Parent: QueryStringContainer

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	4
rs	10
c	0
b	0
f	0
cc	1
eloc	2
nc	1
nop	0

<?php
namespace ApacheSolrForTypo3\Solr\Domain\Search\Query\Helper;

/***************************************************************
 *  Copyright notice
 *
 *  (c) 2010-2017 dkd Internet Service GmbH <[email protected]>
 *  All rights reserved
 *
 *  This script is part of the TYPO3 project. The TYPO3 project is
 *  free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; either version 3 of the License, or
 *  (at your option) any later version.
 *
 *  The GNU General Public License can be found at
 *  http://www.gnu.org/copyleft/gpl.html.
 *
 *  This script is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  This copyright notice MUST APPEAR in all copies of the script!
 ***************************************************************/

class QueryStringContainer {

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

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

    /**
     * @var
     */
    protected $queryString;

    /**
     * @var bool
     */
    private $rawQueryString = false;

    /**
     * QueryStrings constructor.
     * @param string $keywords
     */
    public function __construct($keywords)
    {
        $this->setKeywords($keywords);
    }

    /**
     * Builds the query string which is then used for Solr's q parameters
     *
     * @return string Solr query string
     */
    public function getQueryString()
    {
        if (!$this->rawQueryString) {
            $this->buildQueryString();
        }

        return $this->queryString;
    }

    /**
     * Sets the query string without any escaping.
     *
     * Be cautious with this function!
     * TODO remove this method as it basically just sets the q parameter / keywords
     *
     * @param string $queryString The raw query string.
     */
    public function setQueryString($queryString)
    {
        $this->queryString = $queryString;
    }

    /**
     * Creates the string that is later used as the q parameter in the solr query
     *
     * @return void
     */
    protected function buildQueryString()
    {
        // very simple for now
        $this->queryString = $this->keywords;
    }

    /**
     * Sets whether a raw query sting should be used, that is, whether the query
     * string should be escaped or not.
     *
     * @param bool $useRawQueryString TRUE to use raw queries (like Lucene Query Language) or FALSE for regular, escaped queries
     */
    public function useRawQueryString($useRawQueryString)
    {
        $this->rawQueryString = (boolean)$useRawQueryString;
    }

    /**
     * Get the query keywords, keywords are escaped.
     *
     * @return string query keywords
     */
    public function getKeywords()
    {
        return $this->keywords;
    }

    /**
     * Sets the query keywords, escapes them as needed for Solr/Lucene.
     *
     * @param string $keywords user search terms/keywords
     */
    public function setKeywords($keywords)
    {
        $this->keywords = EscapeService::escape($keywords);
class Id
{
    public $id;

    public function __construct($id)
    {
        $this->id = $id;
    }

}

class Account
{
    /** @var  Id $id */
    public $id;
}

$account_id = false;

if (starsAreRight()) {
    $account_id = new Id(42);
}

$account = new Account();
if ($account instanceof Id)
{
    $account->id = $account_id;
}
        $this->keywordsRaw = $keywords;
    }

    /**
     * Gets the cleaned keywords so that it can be used in templates f.e.
     *
     * @return string The cleaned keywords.
     */
    public function getKeywordsCleaned()
    {
        return EscapeService::clean($this->keywordsRaw);
    }

    /**
     * Gets the raw, unescaped, unencoded keywords.
     *
     * USE WITH CAUTION!
     *
     * @return string raw keywords
     */
    public function getKeywordsRaw()
    {
        return $this->keywordsRaw;
    }

    /**
     * returns a string representation of the query
     *
     * @return string the string representation of the query
     */
    public function __toString()
    {
        return $this->getQueryString();
    }
}

1			<?php
2			namespace ApacheSolrForTypo3\Solr\Domain\Search\Query\Helper;
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			class QueryStringContainer {
28
29			/**
30			* @var string
31			*/
32			protected $keywords;
33
34			/**
35			* @var string
36			*/
37			protected $keywordsRaw;
38
39			/**
40			* @var
41			*/
42			protected $queryString;
43
44			/**
45			* @var bool
46			*/
47			private $rawQueryString = false;
48
49			/**
50			* QueryStrings constructor.
51			* @param string $keywords
52			*/
53			public function __construct($keywords)
54			{
55			$this->setKeywords($keywords);
56			}
57
58			/**
59			* Builds the query string which is then used for Solr's q parameters
60			*
61			* @return string Solr query string
62			*/
63			public function getQueryString()
64			{
65			if (!$this->rawQueryString) {
66			$this->buildQueryString();
67			}
68
69			return $this->queryString;
70			}
71
72			/**
73			* Sets the query string without any escaping.
74			*
75			* Be cautious with this function!
76			* TODO remove this method as it basically just sets the q parameter / keywords
77			*
78			* @param string $queryString The raw query string.
79			*/
80			public function setQueryString($queryString)
81			{
82			$this->queryString = $queryString;
83			}
84
85			/**
86			* Creates the string that is later used as the q parameter in the solr query
87			*
88			* @return void
89			*/
90			protected function buildQueryString()
91			{
92			// very simple for now
93			$this->queryString = $this->keywords;
94			}
95
96			/**
97			* Sets whether a raw query sting should be used, that is, whether the query
98			* string should be escaped or not.
99			*
100			* @param bool $useRawQueryString TRUE to use raw queries (like Lucene Query Language) or FALSE for regular, escaped queries
101			*/
102			public function useRawQueryString($useRawQueryString)
103			{
104			$this->rawQueryString = (boolean)$useRawQueryString;
105			}
106
107			/**
108			* Get the query keywords, keywords are escaped.
109			*
110			* @return string query keywords
111			*/
112			public function getKeywords()
113			{
114			return $this->keywords;
115			}
116
117			/**
118			* Sets the query keywords, escapes them as needed for Solr/Lucene.
119			*
120			* @param string $keywords user search terms/keywords
121			*/
122			public function setKeywords($keywords)
123			{
124			$this->keywords = EscapeService::escape($keywords);
			0 ignored issues – show Documentation Bug introduced 2018-02-02 09:45 UTC by Report Bug Copy Issue Report It seems like `\ApacheSolrForTypo3\Solr...vice::escape($keywords)` can also be of type `integer` or `double`. However, the property `$keywords` is declared as type `string`. Maybe add an additional type check? Our type inference engine has found a suspicous assignment of a value to a property. This check raises an issue when a value that can be of a mixed type is assigned to a property that is type hinted more strictly. For example, imagine you have a variable `$accountId` that can either hold an Id object or false (if there is no account id yet). Your code now assigns that value to the `id` property of an instance of the `Account` class. This class holds a proper account, so the id value must no longer be false. Either this assignment is in error or a type check should be added for that assignment. class Id { public $id; public function __construct($id) { $this->id = $id; } } class Account { /** @var Id $id */ public $id; } $account_id = false; if (starsAreRight()) { $account_id = new Id(42); } $account = new Account(); if ($account instanceof Id) { $account->id = $account_id; } Loading history...
125			$this->keywordsRaw = $keywords;
126			}
127
128			/**
129			* Gets the cleaned keywords so that it can be used in templates f.e.
130			*
131			* @return string The cleaned keywords.
132			*/
133			public function getKeywordsCleaned()
134			{
135			return EscapeService::clean($this->keywordsRaw);
136			}
137
138			/**
139			* Gets the raw, unescaped, unencoded keywords.
140			*
141			* USE WITH CAUTION!
142			*
143			* @return string raw keywords
144			*/
145			public function getKeywordsRaw()
146			{
147			return $this->keywordsRaw;
148			}
149
150			/**
151			* returns a string representation of the query
152			*
153			* @return string the string representation of the query
154			*/
155			public function __toString()
156			{
157			return $this->getQueryString();
158			}
159			}

dkd-kaehm / ext-solr

Push — master ( 6ee2a7...5f60a5 )

QueryStringContainer::getKeywordsRaw() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like