-
-
Notifications
You must be signed in to change notification settings - Fork 248
/
SearchRequest.php
634 lines (546 loc) · 18.5 KB
/
SearchRequest.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
<?php
declare(strict_types=1);
/*
* This file is part of the TYPO3 CMS project.
*
* It is free software; you can redistribute it and/or modify it under
* the terms of the GNU General Public License, either version 2
* of the License, or any later version.
*
* For the full copyright and license information, please read the
* LICENSE.txt file that was distributed with this source code.
*
* The TYPO3 project - inspiring people to share!
*/
namespace ApacheSolrForTypo3\Solr\Domain\Search;
use ApacheSolrForTypo3\Solr\Domain\Search\ResultSet\Facets\UrlFacetContainer;
use ApacheSolrForTypo3\Solr\System\Configuration\TypoScriptConfiguration;
use ApacheSolrForTypo3\Solr\System\Util\ArrayAccessor;
use TYPO3\CMS\Core\Utility\ArrayUtility;
use TYPO3\CMS\Core\Utility\GeneralUtility;
/**
* The searchRequest is used to act as an api to the arguments that have been passed
* with GET and POST.
*/
class SearchRequest
{
public const DEFAULT_PLUGIN_NAMESPACE = 'tx_solr';
protected string $id;
/**
* Default namespace overwritten with the configured plugin namespace.
*/
protected string $argumentNameSpace = self::DEFAULT_PLUGIN_NAMESPACE;
/**
* Arguments that should be kept for sub requests.
* Default values, overwritten in the constructor with the namespaced arguments
*/
protected array $persistentArgumentsPaths = [
'tx_solr:q',
'tx_solr:filter',
'tx_solr:sort',
'tx_solr:groupPage',
];
protected bool $stateChanged = false;
protected ?ArrayAccessor $argumentsAccessor = null;
/**
* The sys_language_uid that was used in the context where the request was build.
* This could be different from the "L" parameter and not relevant for urls,
* because typolink itself will handle it.
*/
protected int $contextSystemLanguageUid = 0;
/**
* The page_uid that was used in the context where the request was build.
*
* The pageUid is not relevant for the typolink additionalArguments and therefore
* a separate property.
*/
protected int $contextPageUid;
protected ?TypoScriptConfiguration $contextTypoScriptConfiguration;
/**
* Container for all active facets inside the URL(TYPO3/FE)
*/
protected ?UrlFacetContainer $activeFacetContainer;
protected array $persistedArguments = [];
public function __construct(
array $argumentsArray = [],
int $pageUid = 0,
int $sysLanguageUid = 0,
TypoScriptConfiguration $typoScriptConfiguration = null,
) {
$this->stateChanged = true;
$this->persistedArguments = $argumentsArray;
$this->contextPageUid = $pageUid;
$this->contextSystemLanguageUid = $sysLanguageUid;
$this->contextTypoScriptConfiguration = $typoScriptConfiguration;
$this->id = spl_object_hash($this);
// overwrite the plugin namespace and the persistentArgumentsPaths
if (!is_null($typoScriptConfiguration)) {
$this->argumentNameSpace = $typoScriptConfiguration->getSearchPluginNamespace();
}
$this->persistentArgumentsPaths = [$this->argumentNameSpace . ':q', $this->argumentNameSpace . ':filter', $this->argumentNameSpace . ':sort', $this->argumentNameSpace . ':grouping', $this->argumentNameSpace . ':groupPage'];
if (!is_null($typoScriptConfiguration)) {
$additionalPersistentArgumentsNames = $typoScriptConfiguration->getSearchAdditionalPersistentArgumentNames();
foreach ($additionalPersistentArgumentsNames as $additionalPersistentArgumentsName) {
$this->persistentArgumentsPaths[] = $this->argumentNameSpace . ':' . $additionalPersistentArgumentsName;
}
$this->persistentArgumentsPaths = array_unique($this->persistentArgumentsPaths);
}
$this->reset();
}
public function getId(): string
{
return $this->id;
}
/**
* Can be used do merge arguments into the request arguments
*/
public function mergeArguments(array $argumentsToMerge): SearchRequest
{
ArrayUtility::mergeRecursiveWithOverrule(
$this->persistedArguments,
$argumentsToMerge
);
$this->reset();
return $this;
}
/**
* Helper method to prefix an accessor with the argument's namespace.
*/
protected function prefixWithNamespace(string $path): string
{
return $this->argumentNameSpace . ':' . $path;
}
/**
* Returns active facet names
*/
public function getActiveFacetNames(): array
{
return $this->activeFacetContainer->getActiveFacetNames();
}
/**
* Returns all facet values for a certain facetName
*/
public function getActiveFacetValuesByName(string $facetName): array
{
return $this->activeFacetContainer->getActiveFacetValuesByName($facetName);
}
/**
* Returns active facets
*/
public function getActiveFacets(): array
{
return $this->activeFacetContainer->getActiveFacets();
}
/**
* Enable sorting of URL parameters
*
* @noinspection PhpUnused
*/
public function sortActiveFacets(): void
{
$this->activeFacetContainer->enableSort();
}
public function isActiveFacetsSorted(): bool
{
return $this->activeFacetContainer->isSorted();
}
public function getActiveFacetsUrlParameterStyle(): string
{
return $this->activeFacetContainer->getParameterStyle();
}
/**
* Returns the active count of facets
*/
public function getActiveFacetCount(): int
{
return $this->activeFacetContainer->count();
}
/**
* Sets active facets for current result set
*
* @noinspection PhpUnused
*/
protected function setActiveFacets(array $activeFacets = []): SearchRequest
{
$this->activeFacetContainer->setActiveFacets($activeFacets);
return $this;
}
/**
* Adds a facet value to the request.
*/
public function addFacetValue(string $facetName, $facetValue): SearchRequest
{
$this->activeFacetContainer->addFacetValue($facetName, $facetValue);
if ($this->activeFacetContainer->hasChanged()) {
$this->stateChanged = true;
$this->activeFacetContainer->acknowledgeChange();
}
return $this;
}
/**
* Removes a facet value from the request.
*/
public function removeFacetValue(string $facetName, mixed $facetValue): SearchRequest
{
$this->activeFacetContainer->removeFacetValue($facetName, $facetValue);
if ($this->activeFacetContainer->hasChanged()) {
$this->stateChanged = true;
$this->activeFacetContainer->acknowledgeChange();
}
return $this;
}
/**
* Removes all facet values from the request by a certain facet name
*/
public function removeAllFacetValuesByName(string $facetName): SearchRequest
{
$this->activeFacetContainer->removeAllFacetValuesByName($facetName);
if ($this->activeFacetContainer->hasChanged()) {
$this->stateChanged = true;
$this->activeFacetContainer->acknowledgeChange();
}
return $this;
}
/**
* Removes all active facets from the request.
*/
public function removeAllFacets(): SearchRequest
{
$this->activeFacetContainer->removeAllFacets();
if ($this->activeFacetContainer->hasChanged()) {
$this->stateChanged = true;
$this->activeFacetContainer->acknowledgeChange();
}
return $this;
}
/**
* Check if an active facet has a given value
*/
public function getHasFacetValue(string $facetName, mixed $facetValue): bool
{
return $this->activeFacetContainer->hasFacetValue($facetName, $facetValue);
}
/**
* Returns all sortings in the sorting string e.g. ['title' => 'asc', 'relevance' => 'desc']
*/
public function getSeperatedSortings(): array
{
$parsedSortings = [];
$explodedSortings = GeneralUtility::trimExplode(',', $this->getSorting(), true);
foreach ($explodedSortings as $sorting) {
$sortingSeperated = explode(' ', $sorting);
if (count($sortingSeperated) === 2) {
$parsedSortings[$sortingSeperated[0]] = $sortingSeperated[1];
}
}
return $parsedSortings;
}
public function getHasSorting(): bool
{
$path = $this->prefixWithNamespace('sort');
return $this->argumentsAccessor->has($path);
}
/**
* Returns the sorting string in the url e.g. title asc.
*/
public function getSorting(): string
{
$path = $this->prefixWithNamespace('sort');
return $this->argumentsAccessor->get($path, '');
}
/**
* Helper function to get the sorting configuration name or direction.
*/
protected function getSortingPart(int $index): ?string
{
$sorting = $this->getSorting();
if ($sorting === '') {
return null;
}
$parts = explode(' ', $sorting);
return $parts[$index] ?? null;
}
/**
* Returns the sorting configuration name that is currently used.
*/
public function getSortingName(): ?string
{
return $this->getSortingPart(0);
}
/**
* Returns the sorting direction that is currently used.
*/
public function getSortingDirection(): string
{
return mb_strtolower($this->getSortingPart(1) ?? '');
}
public function removeSorting(): SearchRequest
{
$path = $this->prefixWithNamespace('sort');
$this->argumentsAccessor->reset($path);
$this->stateChanged = true;
return $this;
}
public function setSorting(string $sortingName, string $direction = 'asc'): SearchRequest
{
$value = $sortingName . ' ' . $direction;
$path = $this->prefixWithNamespace('sort');
$this->argumentsAccessor->set($path, $value);
$this->stateChanged = true;
return $this;
}
/**
* Method to set the paginated page of the search
*/
public function setPage(int $page): SearchRequest
{
$this->stateChanged = true;
$path = $this->prefixWithNamespace('page');
$this->argumentsAccessor->set($path, $page);
// use initial url by switching back to page 0
if ($page === 0) {
$this->argumentsAccessor->reset($path);
}
return $this;
}
/**
* Returns the passed page.
*/
public function getPage(): ?int
{
$path = $this->prefixWithNamespace('page');
return $this->argumentsAccessor->get($path);
}
/**
* Can be used to reset all groupPages.
*/
public function removeAllGroupItemPages(): SearchRequest
{
$path = $this->prefixWithNamespace('groupPage');
$this->argumentsAccessor->reset($path);
return $this;
}
/**
* Can be used to paginate within a groupItem.
*/
public function setGroupItemPage(
string $groupName,
string $groupItemValue,
int $page,
): SearchRequest {
$this->stateChanged = true;
$escapedValue = $this->getEscapedGroupItemValue($groupItemValue);
$path = $this->prefixWithNamespace('groupPage:' . $groupName . ':' . $escapedValue);
$this->argumentsAccessor->set($path, $page);
return $this;
}
/**
* Retrieves the current page for this group item.
*/
public function getGroupItemPage(string $groupName, string $groupItemValue): int
{
$escapedValue = $this->getEscapedGroupItemValue($groupItemValue);
$path = $this->prefixWithNamespace('groupPage:' . $groupName . ':' . $escapedValue);
return max(1, (int)$this->argumentsAccessor->get($path));
}
/**
* Removes all non-alphanumeric values from the groupItem value to have a valid array key.
*/
protected function getEscapedGroupItemValue(string $groupItemValue): string
{
return preg_replace('/[^A-Za-z0-9]/', '', $groupItemValue);
}
/**
* Retrieves the highest page of the groups.
*/
public function getHighestGroupPage(): int
{
$max = 1;
$path = $this->prefixWithNamespace('groupPage');
$groupPages = $this->argumentsAccessor->get($path, []);
foreach ($groupPages as $groups) {
if (!is_array($groups)) {
continue;
}
foreach ($groups as $groupItemPage) {
if ((int)$groupItemPage > $max) {
$max = (int)$groupItemPage;
}
}
}
return $max;
}
/**
* Method to overwrite the query string.
*/
public function setRawQueryString(string $rawQueryString = ''): SearchRequest
{
$this->stateChanged = true;
$path = $this->prefixWithNamespace('q');
$this->argumentsAccessor->set($path, $rawQueryString);
return $this;
}
/**
* Returns the passed rawQueryString.
*/
public function getRawUserQuery(): string
{
$path = $this->prefixWithNamespace('q');
$query = $this->argumentsAccessor->get($path);
return (string)($query ?? '');
}
/**
* Method to check if the query string is an empty string
* (also empty string or whitespaces only are handled as empty).
*
* When no query string is set (null) the method returns false.
*/
public function getRawUserQueryIsEmptyString(): bool
{
$path = $this->prefixWithNamespace('q');
$query = $this->argumentsAccessor->get($path);
if ($query === null) {
return false;
}
if (trim($query) === '') {
return true;
}
return false;
}
/**
* This method returns true when no querystring is present at all.
* Which means no search by the user was triggered
*/
public function getRawUserQueryIsNull(): bool
{
$path = $this->prefixWithNamespace('q');
$query = $this->argumentsAccessor->get($path);
return $query === null;
}
/**
* Sets the results per page that are used during search.
*/
public function setResultsPerPage(int $resultsPerPage): SearchRequest
{
$path = $this->prefixWithNamespace('resultsPerPage');
$this->argumentsAccessor->set($path, $resultsPerPage);
$this->stateChanged = true;
return $this;
}
public function getStateChanged(): bool
{
return $this->stateChanged;
}
/**
* Returns the passed resultsPerPage value
*/
public function getResultsPerPage(): int
{
$path = $this->prefixWithNamespace('resultsPerPage');
return (int)$this->argumentsAccessor->get($path);
}
/**
* Allows setting additional filters that are used on time and not transported during the request.
*/
public function setAdditionalFilters(array $additionalFilters): SearchRequest
{
$path = $this->prefixWithNamespace('additionalFilters');
$this->argumentsAccessor->set($path, $additionalFilters);
$this->stateChanged = true;
return $this;
}
/**
* Retrieves the additional filters that have been set
*/
public function getAdditionalFilters(): array
{
$path = $this->prefixWithNamespace('additionalFilters');
return $this->argumentsAccessor->get($path, []);
}
public function getContextSystemLanguageUid(): int
{
return $this->contextSystemLanguageUid;
}
public function getContextPageUid(): int
{
return $this->contextPageUid;
}
/**
* Get contextTypoScriptConfiguration
*/
public function getContextTypoScriptConfiguration(): ?TypoScriptConfiguration
{
return $this->contextTypoScriptConfiguration;
}
/**
* Assigns the last known persistedArguments and restores their state.
*/
public function reset(): SearchRequest
{
$this->argumentsAccessor = new ArrayAccessor($this->persistedArguments);
$this->stateChanged = false;
$this->activeFacetContainer = new UrlFacetContainer(
$this->argumentsAccessor,
$this->argumentNameSpace ?? self::DEFAULT_PLUGIN_NAMESPACE,
$this->contextTypoScriptConfiguration === null ?
UrlFacetContainer::PARAMETER_STYLE_INDEX :
$this->contextTypoScriptConfiguration->getSearchFacetingUrlParameterStyle()
);
// If the default of sorting parameter should be true, a modification of this condition is needed.
// If instance of contextTypoScriptConfiguration is not TypoScriptConfiguration the sort should be enabled too
if ($this->contextTypoScriptConfiguration instanceof TypoScriptConfiguration
&& $this->contextTypoScriptConfiguration->getSearchFacetingUrlParameterSort()
) {
$this->activeFacetContainer->enableSort();
}
return $this;
}
/**
* This can be used to start a new sub request, e.g. for a faceted search.
*/
public function getCopyForSubRequest(bool $onlyPersistentArguments = true): SearchRequest
{
if (!$onlyPersistentArguments) {
// create a new request with all data
$argumentsArray = $this->argumentsAccessor->getData();
return new SearchRequest(
$argumentsArray,
$this->contextPageUid,
$this->contextSystemLanguageUid,
$this->contextTypoScriptConfiguration
);
}
$arguments = new ArrayAccessor();
foreach ($this->persistentArgumentsPaths as $persistentArgumentPath) {
if ($this->argumentsAccessor->has($persistentArgumentPath)) {
$arguments->set($persistentArgumentPath, $this->argumentsAccessor->get($persistentArgumentPath));
}
}
return new SearchRequest(
$arguments->getData(),
$this->contextPageUid,
$this->contextSystemLanguageUid,
$this->contextTypoScriptConfiguration
);
}
/**
* Returns argument's namespace
*
* @noinspection PhpUnused
*/
public function getArgumentNamespace(): string
{
return $this->argumentNameSpace;
}
public function getAsArray(): array
{
return $this->argumentsAccessor->getData();
}
/**
* Returns only the arguments as array.
*/
public function getArguments(): array
{
return $this->argumentsAccessor->get($this->argumentNameSpace) ?? [];
}
}