]> BookStack Code Mirror - bookstack/commitdiff
Added missing comments or types
authorDan Brown <redacted>
Tue, 9 Nov 2021 15:13:15 +0000 (15:13 +0000)
committerDan Brown <redacted>
Tue, 9 Nov 2021 15:13:15 +0000 (15:13 +0000)
Checked over latest changes for potential SQL injection, all variable
usages are either (from trusted sourced AND case) or using
parameters/bindings to ensure it's handled at driver/lib level.

app/Entities/Tools/SearchRunner.php

index 3bcd6c0549838a9d5163878bc477e4ba68e30ca9..afe5e9f191a4b92d8895319f6d1f82266bef48b0 100644 (file)
@@ -237,6 +237,8 @@ class SearchRunner
      * Create a select statement, with prepared bindings, for the given
      * set of scored search terms.
      *
+     * @param array<string, float> $scoredTerms
+     *
      * @return array{statement: string, bindings: string[]}
      */
     protected function selectForScoredTerms(array $scoredTerms): array
@@ -258,6 +260,13 @@ class SearchRunner
         ];
     }
 
+    /**
+     * For the terms in the given search options, query their popularity across all
+     * search terms then provide that back as score adjustment multiplier applicable
+     * for their rarity. Returns an array of float multipliers, keyed by term.
+     *
+     * @return array<string, float>
+     */
     protected function getTermAdjustments(SearchOptions $options): array
     {
         if (isset($this->termAdjustmentCache[$options])) {