Fixes for CodeStyle vol.2

[bookstack] / app / Entities / Tools / SearchRunner.php

diff --git a/app/Entities/Tools/SearchRunner.php b/app/Entities/Tools/SearchRunner.php
index fc127f9068a49075d8cd14c2ad0e87968f96dd5b..8e18408bd70b10864dbaea09fac3f8c902cd638c 100644 (file)
--- a/app/Entities/Tools/SearchRunner.php
+++ b/app/Entities/Tools/SearchRunner.php
@@ -1,4 +1,6 @@
-<?php namespace BookStack\Entities\Tools;
+<?php
+
+namespace BookStack\Entities\Tools;

 
 use BookStack\Auth\Permissions\PermissionService;
 use BookStack\Auth\User;
 
 use BookStack\Auth\Permissions\PermissionService;
 use BookStack\Auth\User;


@@ -13,7 +15,6 @@ use Illuminate\Support\Str;
 
 class SearchRunner
 {
 
 class SearchRunner
 {

-

     /**
      * @var EntityProvider
      */
     /**
      * @var EntityProvider
      */


@@ -29,14 +30,13 @@ class SearchRunner
      */
     protected $permissionService;
 
      */
     protected $permissionService;
 

-

     /**
     /**

-     * Acceptable operators to be used in a query
+     * Acceptable operators to be used in a query.
+     *

      * @var array
      */
     protected $queryOperators = ['<=', '>=', '=', '<', '>', 'like', '!='];
 
      * @var array
      */
     protected $queryOperators = ['<=', '>=', '=', '<', '>', 'like', '!='];
 

-

     public function __construct(EntityProvider $entityProvider, Connection $db, PermissionService $permissionService)
     {
         $this->entityProvider = $entityProvider;
     public function __construct(EntityProvider $entityProvider, Connection $db, PermissionService $permissionService)
     {
         $this->entityProvider = $entityProvider;


@@ -56,7 +56,7 @@ class SearchRunner
 
         if ($entityType !== 'all') {
             $entityTypesToSearch = $entityType;
 
         if ($entityType !== 'all') {
             $entityTypesToSearch = $entityType;

-        } else if (isset($searchOpts->filters['type'])) {
+        } elseif (isset($searchOpts->filters['type'])) {

             $entityTypesToSearch = explode('|', $searchOpts->filters['type']);
         }
 
             $entityTypesToSearch = explode('|', $searchOpts->filters['type']);
         }
 


@@ -78,16 +78,15 @@ class SearchRunner
         }
 
         return [
         }
 
         return [

-            'total' => $total,
-            'count' => count($results),
+            'total'    => $total,
+            'count'    => count($results),

             'has_more' => $hasMore,
             'has_more' => $hasMore,

-            'results' => $results->sortByDesc('score')->values(),
+            'results'  => $results->sortByDesc('score')->values(),

         ];
     }
 
         ];
     }
 

-

     /**
     /**

-     * Search a book for entities
+     * Search a book for entities.

      */
     public function searchBook(int $bookId, string $searchString): Collection
     {
      */
     public function searchBook(int $bookId, string $searchString): Collection
     {


@@ -108,12 +107,13 @@ class SearchRunner
     }
 
     /**
     }
 
     /**

-     * Search a chapter for entities
+     * Search a chapter for entities.

      */
     public function searchChapter(int $chapterId, string $searchString): Collection
     {
         $opts = SearchOptions::fromString($searchString);
         $pages = $this->buildEntitySearchQuery($opts, 'page')->where('chapter_id', '=', $chapterId)->take(20)->get();
      */
     public function searchChapter(int $chapterId, string $searchString): Collection
     {
         $opts = SearchOptions::fromString($searchString);
         $pages = $this->buildEntitySearchQuery($opts, 'page')->where('chapter_id', '=', $chapterId)->take(20)->get();

+

         return $pages->sortByDesc('score');
     }
 
         return $pages->sortByDesc('score');
     }
 


@@ -121,6 +121,7 @@ class SearchRunner
      * Search across a particular entity type.
      * Setting getCount = true will return the total
      * matching instead of the items themselves.
      * Search across a particular entity type.
      * Setting getCount = true will return the total
      * matching instead of the items themselves.

+     *

      * @return \Illuminate\Database\Eloquent\Collection|int|static[]
      */
     protected function searchEntityTable(SearchOptions $searchOpts, string $entityType = 'page', int $page = 1, int $count = 20, string $action = 'view', bool $getCount = false)
      * @return \Illuminate\Database\Eloquent\Collection|int|static[]
      */
     protected function searchEntityTable(SearchOptions $searchOpts, string $entityType = 'page', int $page = 1, int $count = 20, string $action = 'view', bool $getCount = false)


@@ -130,12 +131,13 @@ class SearchRunner
             return $query->count();
         }
 
             return $query->count();
         }
 

-        $query = $query->skip(($page-1) * $count)->take($count);
+        $query = $query->skip(($page - 1) * $count)->take($count);
+

         return $query->get();
     }
 
     /**
         return $query->get();
     }
 
     /**

-     * Create a search query for an entity
+     * Create a search query for an entity.

      */
     protected function buildEntitySearchQuery(SearchOptions $searchOpts, string $entityType = 'page', string $action = 'view'): EloquentBuilder
     {
      */
     protected function buildEntitySearchQuery(SearchOptions $searchOpts, string $entityType = 'page', string $action = 'view'): EloquentBuilder
     {


@@ -149,20 +151,20 @@ class SearchRunner
             $subQuery->where('entity_type', '=', $entity->getMorphClass());
             $subQuery->where(function (Builder $query) use ($searchOpts) {
                 foreach ($searchOpts->searches as $inputTerm) {
             $subQuery->where('entity_type', '=', $entity->getMorphClass());
             $subQuery->where(function (Builder $query) use ($searchOpts) {
                 foreach ($searchOpts->searches as $inputTerm) {

-                    $query->orWhere('term', 'like', $inputTerm .'%');
+                    $query->orWhere('term', 'like', $inputTerm . '%');

                 }
             })->groupBy('entity_type', 'entity_id');
             $entitySelect->join($this->db->raw('(' . $subQuery->toSql() . ') as s'), function (JoinClause $join) {
                 $join->on('id', '=', 'entity_id');
                 }
             })->groupBy('entity_type', 'entity_id');
             $entitySelect->join($this->db->raw('(' . $subQuery->toSql() . ') as s'), function (JoinClause $join) {
                 $join->on('id', '=', 'entity_id');

-            })->selectRaw($entity->getTable().'.*, s.score')->orderBy('score', 'desc');
+            })->selectRaw($entity->getTable() . '.*, s.score')->orderBy('score', 'desc');

             $entitySelect->mergeBindings($subQuery);
         }
 
         // Handle exact term matching
         foreach ($searchOpts->exacts as $inputTerm) {
             $entitySelect->where(function (EloquentBuilder $query) use ($inputTerm, $entity) {
             $entitySelect->mergeBindings($subQuery);
         }
 
         // Handle exact term matching
         foreach ($searchOpts->exacts as $inputTerm) {
             $entitySelect->where(function (EloquentBuilder $query) use ($inputTerm, $entity) {

-                $query->where('name', 'like', '%'.$inputTerm .'%')
-                    ->orWhere($entity->textField, 'like', '%'.$inputTerm .'%');
+                $query->where('name', 'like', '%' . $inputTerm . '%')
+                    ->orWhere($entity->textField, 'like', '%' . $inputTerm . '%');

             });
         }
 
             });
         }
 


@@ -191,6 +193,7 @@ class SearchRunner
         foreach ($this->queryOperators as $operator) {
             $escapedOperators[] = preg_quote($operator);
         }
         foreach ($this->queryOperators as $operator) {
             $escapedOperators[] = preg_quote($operator);
         }

+

         return join('|', $escapedOperators);
     }
 
         return join('|', $escapedOperators);
     }
 


@@ -199,7 +202,7 @@ class SearchRunner
      */
     protected function applyTagSearch(EloquentBuilder $query, string $tagTerm): EloquentBuilder
     {
      */
     protected function applyTagSearch(EloquentBuilder $query, string $tagTerm): EloquentBuilder
     {

-        preg_match("/^(.*?)((".$this->getRegexEscapedOperators().")(.*?))?$/", $tagTerm, $tagSplit);
+        preg_match('/^(.*?)((' . $this->getRegexEscapedOperators() . ')(.*?))?$/', $tagTerm, $tagSplit);

         $query->whereHas('tags', function (EloquentBuilder $query) use ($tagSplit) {
             $tagName = $tagSplit[1];
             $tagOperator = count($tagSplit) > 2 ? $tagSplit[3] : '';
         $query->whereHas('tags', function (EloquentBuilder $query) use ($tagSplit) {
             $tagName = $tagSplit[1];
             $tagOperator = count($tagSplit) > 2 ? $tagSplit[3] : '';


@@ -222,13 +225,13 @@ class SearchRunner
                 $query->where('name', '=', $tagName);
             }
         });
                 $query->where('name', '=', $tagName);
             }
         });

+

         return $query;
     }
 
     /**
         return $query;
     }
 
     /**

-     * Custom entity search filters
+     * Custom entity search filters.

      */
      */

-

     protected function filterUpdatedAfter(EloquentBuilder $query, Entity $model, $input)
     {
         try {
     protected function filterUpdatedAfter(EloquentBuilder $query, Entity $model, $input)
     {
         try {


@@ -298,7 +301,7 @@ class SearchRunner
 
     protected function filterInName(EloquentBuilder $query, Entity $model, $input)
     {
 
     protected function filterInName(EloquentBuilder $query, Entity $model, $input)
     {

-        $query->where('name', 'like', '%' .$input. '%');
+        $query->where('name', 'like', '%' . $input . '%');

     }
 
     protected function filterInTitle(EloquentBuilder $query, Entity $model, $input)
     }
 
     protected function filterInTitle(EloquentBuilder $query, Entity $model, $input)


@@ -308,7 +311,7 @@ class SearchRunner
 
     protected function filterInBody(EloquentBuilder $query, Entity $model, $input)
     {
 
     protected function filterInBody(EloquentBuilder $query, Entity $model, $input)
     {

-        $query->where($model->textField, 'like', '%' .$input. '%');
+        $query->where($model->textField, 'like', '%' . $input . '%');

     }
 
     protected function filterIsRestricted(EloquentBuilder $query, Entity $model, $input)
     }
 
     protected function filterIsRestricted(EloquentBuilder $query, Entity $model, $input)


@@ -338,16 +341,14 @@ class SearchRunner
         }
     }
 
         }
     }
 

-

     /**
     /**

-     * Sorting filter options
+     * Sorting filter options.

      */
      */

-

     protected function sortByLastCommented(EloquentBuilder $query, Entity $model)
     {
         $commentsTable = $this->db->getTablePrefix() . 'comments';
         $morphClass = str_replace('\\', '\\\\', $model->getMorphClass());
     protected function sortByLastCommented(EloquentBuilder $query, Entity $model)
     {
         $commentsTable = $this->db->getTablePrefix() . 'comments';
         $morphClass = str_replace('\\', '\\\\', $model->getMorphClass());

-        $commentQuery = $this->db->raw('(SELECT c1.entity_id, c1.entity_type, c1.created_at as last_commented FROM '.$commentsTable.' c1 LEFT JOIN '.$commentsTable.' c2 ON (c1.entity_id = c2.entity_id AND c1.entity_type = c2.entity_type AND c1.created_at < c2.created_at) WHERE c1.entity_type = \''. $morphClass .'\' AND c2.created_at IS NULL) as comments');
+        $commentQuery = $this->db->raw('(SELECT c1.entity_id, c1.entity_type, c1.created_at as last_commented FROM ' . $commentsTable . ' c1 LEFT JOIN ' . $commentsTable . ' c2 ON (c1.entity_id = c2.entity_id AND c1.entity_type = c2.entity_type AND c1.created_at < c2.created_at) WHERE c1.entity_type = \'' . $morphClass . '\' AND c2.created_at IS NULL) as comments');

 
         $query->join($commentQuery, $model->getTable() . '.id', '=', 'comments.entity_id')->orderBy('last_commented', 'desc');
     }
 
         $query->join($commentQuery, $model->getTable() . '.id', '=', 'comments.entity_id')->orderBy('last_commented', 'desc');
     }