|
1
|
|
|
<?php |
|
2
|
|
|
namespace ApacheSolrForTypo3\Solr\ViewHelpers; |
|
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\System\Url\UrlHelper; |
|
18
|
|
|
use ApacheSolrForTypo3\Solr\System\Util\SiteUtility; |
|
19
|
|
|
use ApacheSolrForTypo3\Solr\Util; |
|
20
|
|
|
use TYPO3\CMS\Core\Utility\GeneralUtility; |
|
21
|
|
|
use TYPO3\CMS\Frontend\Controller\TypoScriptFrontendController; |
|
22
|
|
|
|
|
23
|
|
|
|
|
24
|
|
|
/** |
|
25
|
|
|
* Class SearchFormViewHelper |
|
26
|
|
|
* |
|
27
|
|
|
* @author Frans Saris <[email protected]> |
|
28
|
|
|
* @author Timo Hund <[email protected]> |
|
29
|
|
|
*/ |
|
30
|
|
|
class SearchFormViewHelper extends AbstractSolrFrontendTagBasedViewHelper |
|
31
|
|
|
{ |
|
32
|
|
|
|
|
33
|
|
|
/** |
|
34
|
|
|
* @var string |
|
35
|
|
|
*/ |
|
36
|
|
|
protected $tagName = 'form'; |
|
37
|
|
|
|
|
38
|
|
|
/** |
|
39
|
|
|
* @var TypoScriptFrontendController |
|
40
|
|
|
*/ |
|
41
|
|
|
protected $frontendController; |
|
42
|
|
|
|
|
43
|
|
|
/** |
|
44
|
|
|
* @var bool |
|
45
|
|
|
*/ |
|
46
|
|
|
protected $escapeChildren = true; |
|
47
|
|
|
|
|
48
|
|
|
/** |
|
49
|
|
|
* @var bool |
|
50
|
|
|
*/ |
|
51
|
|
|
protected $escapeOutput = false; |
|
52
|
|
|
|
|
53
|
|
|
/** |
|
54
|
|
|
* Constructor |
|
55
|
|
|
*/ |
|
56
|
6 |
|
public function __construct() |
|
57
|
|
|
{ |
|
58
|
6 |
|
parent::__construct(); |
|
59
|
6 |
|
$this->frontendController = $GLOBALS['TSFE']; |
|
60
|
6 |
|
} |
|
61
|
|
|
|
|
62
|
|
|
/** |
|
63
|
|
|
* Initialize arguments. |
|
64
|
|
|
* |
|
65
|
|
|
* @return void |
|
66
|
|
|
*/ |
|
67
|
|
|
public function initializeArguments() |
|
68
|
|
|
{ |
|
69
|
|
|
parent::initializeArguments(); |
|
70
|
|
|
$this->registerTagAttribute('enctype', 'string', 'MIME type with which the form is submitted'); |
|
71
|
|
|
$this->registerTagAttribute('method', 'string', 'Transfer type (GET or POST)', false, 'get'); |
|
72
|
|
|
$this->registerTagAttribute('name', 'string', 'Name of form'); |
|
73
|
|
|
$this->registerTagAttribute('onreset', 'string', 'JavaScript: On reset of the form'); |
|
74
|
|
|
$this->registerTagAttribute('onsubmit', 'string', 'JavaScript: On submit of the form'); |
|
75
|
|
|
$this->registerUniversalTagAttributes(); |
|
76
|
|
|
|
|
77
|
|
|
$this->registerArgument('pageUid', 'integer', 'When not set current page is used', false); |
|
78
|
|
|
$this->registerArgument('additionalFilters', 'array', 'Additional filters', false); |
|
79
|
|
|
$this->registerArgument('additionalParams', 'array', 'Query parameters to be attached to the resulting URI', false, []); |
|
80
|
|
|
$this->registerArgument('pageType', 'integer', 'Type of the target page. See typolink.parameter', false, 0); |
|
81
|
|
|
|
|
82
|
|
|
$this->registerArgument('noCache', 'boolean', 'Set this to disable caching for the target page. You should not need this.', false, false); |
|
83
|
|
|
$this->registerArgument('noCacheHash', 'boolean', 'Set this to supress the cHash query parameter created by TypoLink. You should not need this.', false, false); |
|
84
|
|
|
$this->registerArgument('section', 'string', 'The anchor to be added to the action URI (only active if $actionUri is not set)', false, ''); |
|
85
|
|
|
$this->registerArgument('absolute', 'boolean', 'If set, the URI of the rendered link is absolute', false, false); |
|
86
|
|
|
$this->registerArgument('addQueryString', 'boolean', 'If set, the current query parameters will be kept in the URI', false, false); |
|
87
|
|
|
$this->registerArgument('argumentsToBeExcludedFromQueryString', 'array', 'arguments to be removed from the URI. Only active if $addQueryString = TRUE', false, []); |
|
88
|
|
|
$this->registerArgument('addQueryStringMethod', 'string', 'Set which parameters will be kept. Only active if $addQueryString = TRUE', false); |
|
89
|
|
|
$this->registerArgument('addSuggestUrl', 'boolean', 'Indicates if suggestUrl should be rendered or not', false, true); |
|
90
|
|
|
$this->registerArgument('suggestHeader', 'string', 'The header for the top results', false, 'Top Results'); |
|
91
|
|
|
$this->registerArgument('suggestPageType', 'integer', 'The page type that should be used for the suggest', false, 7384); |
|
92
|
|
|
|
|
93
|
|
|
} |
|
94
|
|
|
|
|
95
|
|
|
/** |
|
96
|
|
|
* Render search form tag |
|
97
|
|
|
* |
|
98
|
|
|
* @return string |
|
99
|
|
|
*/ |
|
100
|
6 |
|
public function render() |
|
101
|
|
|
{ |
|
102
|
6 |
|
$pageUid = $this->arguments['pageUid']; |
|
103
|
6 |
|
if ($pageUid === null && !empty($this->getTypoScriptConfiguration()->getSearchTargetPage())) { |
|
104
|
2 |
|
$pageUid = $this->getTypoScriptConfiguration()->getSearchTargetPage(); |
|
105
|
|
|
} |
|
106
|
|
|
|
|
107
|
6 |
|
$uri = $this->buildUriFromPageUidAndArguments($pageUid); |
|
108
|
|
|
|
|
109
|
6 |
|
$this->tag->addAttribute('action', trim($uri)); |
|
110
|
6 |
|
if ($this->arguments['addSuggestUrl']) { |
|
111
|
|
|
$this->tag->addAttribute('data-suggest', $this->getSuggestUrl($this->arguments['additionalFilters'], $pageUid)); |
|
112
|
|
|
} |
|
113
|
6 |
|
$this->tag->addAttribute('data-suggest-header', htmlspecialchars($this->arguments['suggestHeader'])); |
|
114
|
6 |
|
$this->tag->addAttribute('accept-charset', $this->frontendController->metaCharset); |
|
115
|
|
|
|
|
116
|
|
|
// Get search term |
|
117
|
|
|
// @extensionScannerIgnoreLine |
|
118
|
6 |
|
$this->getTemplateVariableContainer()->add('q', $this->getQueryString()); |
|
119
|
|
|
// @extensionScannerIgnoreLine |
|
120
|
6 |
|
$this->getTemplateVariableContainer()->add('pageUid', $pageUid); |
|
121
|
|
|
// @extensionScannerIgnoreLine |
|
122
|
6 |
|
$this->getTemplateVariableContainer()->add('languageUid', Util::getLanguageUid()); |
|
123
|
|
|
// @extensionScannerIgnoreLine |
|
124
|
6 |
|
$this->getTemplateVariableContainer()->add('existingParameters', $this->getExistingSearchParameters()); |
|
125
|
|
|
// @extensionScannerIgnoreLine |
|
126
|
6 |
|
$this->getTemplateVariableContainer()->add('addPageAndLanguageId', !$this->getIsSiteManagedSite($pageUid)); |
|
127
|
6 |
|
$formContent = $this->renderChildren(); |
|
128
|
|
|
// @extensionScannerIgnoreLine |
|
129
|
6 |
|
$this->getTemplateVariableContainer()->remove('addPageAndLanguageId'); |
|
130
|
|
|
// @extensionScannerIgnoreLine |
|
131
|
6 |
|
$this->getTemplateVariableContainer()->remove('q'); |
|
132
|
|
|
// @extensionScannerIgnoreLine |
|
133
|
6 |
|
$this->getTemplateVariableContainer()->remove('pageUid'); |
|
134
|
|
|
// @extensionScannerIgnoreLine |
|
135
|
6 |
|
$this->getTemplateVariableContainer()->remove('languageUid'); |
|
136
|
|
|
// @extensionScannerIgnoreLine |
|
137
|
6 |
|
$this->getTemplateVariableContainer()->remove('existingParameters'); |
|
138
|
|
|
|
|
139
|
6 |
|
$this->tag->setContent($formContent); |
|
140
|
|
|
|
|
141
|
6 |
|
return $this->tag->render(); |
|
142
|
|
|
} |
|
143
|
|
|
|
|
144
|
|
|
/** |
|
145
|
|
|
* Get the existing search parameters in an array |
|
146
|
|
|
* Returns an empty array if search.keepExistingParametersForNewSearches is not set |
|
147
|
|
|
* |
|
148
|
|
|
* @return array |
|
149
|
|
|
*/ |
|
150
|
6 |
|
protected function getExistingSearchParameters() |
|
151
|
|
|
{ |
|
152
|
6 |
|
$searchParameters = []; |
|
153
|
6 |
|
if ($this->getTypoScriptConfiguration()->getSearchKeepExistingParametersForNewSearches()) { |
|
154
|
|
|
$arguments = GeneralUtility::_GPmerged($this->getTypoScriptConfiguration()->getSearchPluginNamespace()); |
|
155
|
|
|
unset($arguments['q'], $arguments['id'], $arguments['L']); |
|
156
|
|
|
$searchParameters = $this->translateSearchParametersToInputTagAttributes($arguments); |
|
157
|
|
|
} |
|
158
|
6 |
|
return $searchParameters; |
|
159
|
|
|
} |
|
160
|
|
|
|
|
161
|
|
|
/** |
|
162
|
|
|
* Translate the multi-dimensional array of existing arguments into a flat array of name-value pairs for the input tags |
|
163
|
|
|
* |
|
164
|
|
|
* @param $arguments |
|
165
|
|
|
* @param string $nameAttributePrefix |
|
166
|
|
|
* @return array |
|
167
|
|
|
*/ |
|
168
|
|
|
protected function translateSearchParametersToInputTagAttributes($arguments, $nameAttributePrefix = '') |
|
169
|
|
|
{ |
|
170
|
|
|
$attributes = []; |
|
171
|
|
|
foreach ($arguments as $key => $value) { |
|
172
|
|
|
$name = $nameAttributePrefix . '[' . $key . ']'; |
|
173
|
|
|
if (is_array($value)) { |
|
174
|
|
|
$attributes = array_merge( |
|
175
|
|
|
$attributes, |
|
176
|
|
|
$this->translateSearchParametersToInputTagAttributes($value, $name) |
|
177
|
|
|
); |
|
178
|
|
|
} else { |
|
179
|
|
|
$attributes[$name] = $value; |
|
180
|
|
|
} |
|
181
|
|
|
} |
|
182
|
|
|
return $attributes; |
|
183
|
|
|
} |
|
184
|
|
|
|
|
185
|
|
|
/** |
|
186
|
|
|
* When a site is managed with site management the language and the id are encoded in the path segment of the url. |
|
187
|
|
|
* When no speaking urls are active (e.g. with TYPO3 8 and no realurl) this information is passed as query parameter |
|
188
|
|
|
* and would get lost when it is only part of the query arguments in the action parameter of the form. |
|
189
|
|
|
* |
|
190
|
|
|
* @return boolean |
|
191
|
|
|
*/ |
|
192
|
|
|
protected function getIsSiteManagedSite($pageId) |
|
193
|
|
|
{ |
|
194
|
|
|
return SiteUtility::getIsSiteManagedSite($pageId); |
|
195
|
|
|
} |
|
196
|
|
|
|
|
197
|
|
|
/** |
|
198
|
|
|
* @return \TYPO3Fluid\Fluid\Core\Variables\VariableProviderInterface |
|
199
|
|
|
*/ |
|
200
|
|
|
protected function getTemplateVariableContainer() |
|
201
|
|
|
{ |
|
202
|
|
|
return $this->templateVariableContainer; |
|
203
|
|
|
} |
|
204
|
|
|
|
|
205
|
|
|
/** |
|
206
|
|
|
* @return string |
|
207
|
|
|
*/ |
|
208
|
6 |
|
protected function getQueryString() |
|
209
|
|
|
{ |
|
210
|
6 |
|
$resultSet = $this->getSearchResultSet(); |
|
211
|
6 |
|
if ($resultSet === null) { |
|
212
|
6 |
|
return ''; |
|
213
|
|
|
} |
|
214
|
|
|
return trim($this->getSearchResultSet()->getUsedSearchRequest()->getRawUserQuery()); |
|
215
|
|
|
} |
|
216
|
|
|
|
|
217
|
|
|
/** |
|
218
|
|
|
* @param NULL|array $additionalFilters |
|
219
|
|
|
* @param int $pageUid |
|
220
|
|
|
* @return string |
|
221
|
|
|
*/ |
|
222
|
|
|
protected function getSuggestUrl($additionalFilters, $pageUid) |
|
223
|
|
|
{ |
|
224
|
|
|
$uriBuilder = $this->getControllerContext()->getUriBuilder(); |
|
225
|
|
|
$pluginNamespace = $this->getTypoScriptConfiguration()->getSearchPluginNamespace(); |
|
226
|
|
|
$suggestUrl = $uriBuilder->reset()->setTargetPageUid($pageUid)->setTargetPageType($this->arguments['suggestPageType'])->setUseCacheHash(false)->setArguments([$pluginNamespace => ['additionalFilters' => $additionalFilters]])->build(); |
|
|
|
|
|
|
227
|
|
|
|
|
228
|
|
|
/* @var UrlHelper $urlService */ |
|
229
|
|
|
$urlService = GeneralUtility::makeInstance(UrlHelper::class, $suggestUrl); |
|
230
|
|
|
$suggestUrl = $urlService->removeQueryParameter('cHash')->getUrl(); |
|
|
|
|
|
|
231
|
|
|
|
|
232
|
|
|
return $suggestUrl; |
|
233
|
|
|
} |
|
234
|
|
|
|
|
235
|
|
|
/** |
|
236
|
|
|
* @param int|null $pageUid |
|
237
|
|
|
* @return string |
|
238
|
|
|
*/ |
|
239
|
6 |
|
protected function buildUriFromPageUidAndArguments($pageUid): string |
|
240
|
|
|
{ |
|
241
|
6 |
|
$uriBuilder = $this->getControllerContext()->getUriBuilder(); |
|
242
|
|
|
$uri = $uriBuilder |
|
243
|
6 |
|
->reset() |
|
244
|
6 |
|
->setTargetPageUid($pageUid) |
|
|
|
|
|
|
245
|
6 |
|
->setTargetPageType($this->arguments['pageType'] ?? 0) |
|
246
|
6 |
|
->setNoCache($this->arguments['noCache'] ?? false) |
|
247
|
6 |
|
->setUseCacheHash(!$this->arguments['noCacheHash']) |
|
|
|
|
|
|
248
|
6 |
|
->setArguments($this->arguments['additionalParams'] ?? []) |
|
249
|
6 |
|
->setCreateAbsoluteUri($this->arguments['absolute'] ?? false) |
|
250
|
6 |
|
->setAddQueryString($this->arguments['addQueryString'] ?? false) |
|
251
|
6 |
|
->setArgumentsToBeExcludedFromQueryString($this->arguments['argumentsToBeExcludedFromQueryString'] ?? []) |
|
252
|
6 |
|
->setAddQueryStringMethod($this->arguments['addQueryStringMethod'] ?? '') |
|
253
|
6 |
|
->setSection($this->arguments['section'] ?? '') |
|
254
|
6 |
|
->build(); |
|
255
|
6 |
|
return $uri; |
|
256
|
|
|
} |
|
257
|
|
|
} |
|
258
|
|
|
|
TYPO3-Solr /
ext-solr
Loading history...
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. Please note the @ignore annotation hint above.