Skip to content

Commit 0d17918

Browse files
committed
[BUGFIX] Add missing inline documetation
1 parent 2ba7d7a commit 0d17918

1 file changed

Lines changed: 19 additions & 1 deletion

File tree

Classes/Flowpack/ElasticSearch/ContentRepositoryAdaptor/Eel/ElasticSearchQueryBuilder.php

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -373,7 +373,7 @@ public function appendAtPath($path, array $data) {
373373
/**
374374
* Add multiple filters to query.filtered.filter
375375
*
376-
* Example Usage::
376+
* Example Usage:
377377
*
378378
* searchFilter = TYPO3.TypoScript:RawArray {
379379
* author = 'Max'
@@ -407,6 +407,11 @@ public function queryFilterMultiple($data, $clauseType = 'must') {
407407
* This method adds a field based aggregation configuration. This can be used for simple
408408
* aggregations like terms
409409
*
410+
* Example Usage to create a terms aggregation for a property color:
411+
* nodes = ${Search....fieldBasedAggregation("colors", "color").execute()}
412+
*
413+
* Access all aggregation data with {nodes.aggregations} in your fluid template
414+
*
410415
* @param $name
411416
* @param $field
412417
* @param string $type
@@ -425,6 +430,19 @@ public function fieldBasedAggregation($name, $field, $type = "terms", $parentPat
425430
}
426431

427432
/**
433+
* This method is used to create any kind of aggregation.
434+
*
435+
* Example Usage to create a terms aggregation for a property color:
436+
*
437+
* aggregationDefinition = TYPO3.TypoScript:RawArray {
438+
* terms = TYPO3.TypoScript:RawArray {
439+
* field = "color"
440+
* }
441+
*
442+
* nodes = ${Search....aggregation("color", this.aggregationDefinition).execute()}
443+
*
444+
* Access all aggregation data with {nodes.aggregations} in your fluid template
445+
*
428446
* @param string $name
429447
* @param array $aggregationDefinition
430448
* @param null $parentPath

0 commit comments

Comments
 (0)