From 2633b94deb760dc2f183a612b68e311f57795ce5 Mon Sep 17 00:00:00 2001 From: Dan Brown Date: Sat, 13 Nov 2021 13:28:17 +0000 Subject: [PATCH] Applied StyleCI changes --- app/Entities/Tools/SearchIndex.php | 9 ++++----- app/Entities/Tools/SearchOptions.php | 3 +-- app/Entities/Tools/SearchResultsFormatter.php | 15 ++++++++------- app/Entities/Tools/SearchRunner.php | 6 +++--- app/Http/Controllers/SearchController.php | 3 ++- tests/Entity/EntitySearchTest.php | 2 -- 6 files changed, 18 insertions(+), 20 deletions(-) diff --git a/app/Entities/Tools/SearchIndex.php b/app/Entities/Tools/SearchIndex.php index 3c4b5a247..702606be9 100644 --- a/app/Entities/Tools/SearchIndex.php +++ b/app/Entities/Tools/SearchIndex.php @@ -175,7 +175,7 @@ class SearchIndex $names = []; $values = []; - foreach($tags as $tag) { + foreach ($tags as $tag) { $names[] = $tag->name; $values[] = $tag->value; } @@ -233,17 +233,16 @@ class SearchIndex $entityType = $entity->getMorphClass(); foreach ($mergedScoreMap as $term => $score) { $dataArray[] = [ - 'term' => $term, - 'score' => $score, + 'term' => $term, + 'score' => $score, 'entity_type' => $entityType, - 'entity_id' => $entityId, + 'entity_id' => $entityId, ]; } return $dataArray; } - /** * For the given term data arrays, Merge their contents by term * while combining any scores. diff --git a/app/Entities/Tools/SearchOptions.php b/app/Entities/Tools/SearchOptions.php index 9f1b9742d..99271058e 100644 --- a/app/Entities/Tools/SearchOptions.php +++ b/app/Entities/Tools/SearchOptions.php @@ -124,7 +124,6 @@ class SearchOptions return $terms; } - /** * Parse a standard search term string into individual search terms and * extract any exact terms searches to be made. @@ -136,7 +135,7 @@ class SearchOptions $terms = explode(' ', $termString); $indexDelimiters = SearchIndex::$delimiters; $parsed = [ - 'terms' => [], + 'terms' => [], 'exacts' => [], ]; diff --git a/app/Entities/Tools/SearchResultsFormatter.php b/app/Entities/Tools/SearchResultsFormatter.php index 1ddee5830..2898520ab 100644 --- a/app/Entities/Tools/SearchResultsFormatter.php +++ b/app/Entities/Tools/SearchResultsFormatter.php @@ -8,10 +8,10 @@ use Illuminate\Support\HtmlString; class SearchResultsFormatter { - /** * For the given array of entities, Prepare the models to be shown in search result * output. This sets a series of additional attributes. + * * @param Entity[] $results */ public function format(array $results, SearchOptions $options): void @@ -32,7 +32,7 @@ class SearchResultsFormatter $terms = array_merge($options->exacts, $options->searches); $originalContentByNewAttribute = [ - 'preview_name' => $entity->name, + 'preview_name' => $entity->name, 'preview_content' => $textContent, ]; @@ -49,7 +49,8 @@ class SearchResultsFormatter /** * Highlight tags which match the given terms. - * @param Tag[] $tags + * + * @param Tag[] $tags * @param string[] $terms */ protected function highlightTagsContainingTerms(array $tags, array $terms): void @@ -104,6 +105,7 @@ class SearchResultsFormatter * adjacent or where they overlap. * * @param array $matchPositions + * * @return array */ protected function sortAndMergeMatchPositions(array $matchPositions): array @@ -118,7 +120,7 @@ class SearchResultsFormatter $mergedRefs[$start] = $end; $lastStart = $start; $lastEnd = $end; - } else if ($end > $lastEnd) { + } elseif ($end > $lastEnd) { $mergedRefs[$lastStart] = $end; $lastEnd = $end; } @@ -194,7 +196,7 @@ class SearchResultsFormatter $firstStart = $firstStart ?: 0; if ($remainder > 10 && $firstStart !== 0) { $padStart = max(0, $firstStart - $remainder); - $content = ($padStart === 0 ? '' : '...') . e(substr($originalText, $padStart, $firstStart - $padStart)) . substr($content, 4); + $content = ($padStart === 0 ? '' : '...') . e(substr($originalText, $padStart, $firstStart - $padStart)) . substr($content, 4); } // Add ellipsis if we're not at the end @@ -204,5 +206,4 @@ class SearchResultsFormatter return $content; } - -} \ No newline at end of file +} diff --git a/app/Entities/Tools/SearchRunner.php b/app/Entities/Tools/SearchRunner.php index afe5e9f19..f6da871f4 100644 --- a/app/Entities/Tools/SearchRunner.php +++ b/app/Entities/Tools/SearchRunner.php @@ -141,13 +141,13 @@ class SearchRunner $relations = ['tags']; if ($entityModelInstance instanceof BookChild) { - $relations['book'] = function(BelongsTo $query) { + $relations['book'] = function (BelongsTo $query) { $query->visible(); }; } if ($entityModelInstance instanceof Page) { - $relations['chapter'] = function(BelongsTo $query) { + $relations['chapter'] = function (BelongsTo $query) { $query->visible(); }; } @@ -310,7 +310,7 @@ class SearchRunner if (empty($termCounts)) { return []; } - + $multipliers = []; $max = max(array_values($termCounts)); diff --git a/app/Http/Controllers/SearchController.php b/app/Http/Controllers/SearchController.php index 040c04ece..6b2be5a2d 100644 --- a/app/Http/Controllers/SearchController.php +++ b/app/Http/Controllers/SearchController.php @@ -14,7 +14,8 @@ class SearchController extends Controller protected $searchRunner; protected $entityContextManager; - public function __construct(SearchRunner $searchRunner) { + public function __construct(SearchRunner $searchRunner) + { $this->searchRunner = $searchRunner; } diff --git a/tests/Entity/EntitySearchTest.php b/tests/Entity/EntitySearchTest.php index 95d474629..f935f1331 100644 --- a/tests/Entity/EntitySearchTest.php +++ b/tests/Entity/EntitySearchTest.php @@ -7,7 +7,6 @@ use BookStack\Entities\Models\Book; use BookStack\Entities\Models\Bookshelf; use BookStack\Entities\Models\Chapter; use BookStack\Entities\Models\Page; -use BookStack\Entities\Models\SearchTerm; use Tests\TestCase; class EntitySearchTest extends TestCase @@ -410,5 +409,4 @@ class EntitySearchTest extends TestCase $search->assertSee('My <cool> TestPageContent', false); $search->assertSee('My supercool <great> TestPageContent page', false); } - }