Support for counting results

Author: pascalbaljet

CHANGELOG.md

@@ -2,6 +2,10 @@
 
 All notable changes to `laravel-cross-eloquent-search` will be documented in this file
 
+## 1.7.0 - 2020-12-16
+
+- Added a `count` method.
+
 ## 1.6.0 - 2020-12-16
 
 - Allow empty search terms without selecting columns

README.md

@@ -172,6 +172,16 @@ Search::add(Post::class)
     ->get();
 ```
 
+### Counting records
+
+You can count the number of results with the `count` method:
+
+```php
+Search::add(Post::published(), 'title')
+    ->add(Video::where('views', '>', 2500), 'title')
+    ->count('compile');
+```
+
 ### Standalone parser
 
 You can use the parser with the `parseTerms` method:

src/Searcher.php

@@ -4,6 +4,7 @@
 
 use Illuminate\Database\Eloquent\Builder;
 use Illuminate\Database\Eloquent\Collection as EloquentCollection;
+use Illuminate\Database\Query\Builder as QueryBuilder;
 use Illuminate\Pagination\Paginator;
 use Illuminate\Support\Collection;
 use Illuminate\Support\Facades\DB;
@@ -287,12 +288,12 @@ private function buildQueries(): Collection
     }
 
     /**
-     * Compiles all queries to one big one which binds everything together
-     * using UNION statements.
-     *
-     * @return \Illuminate\Support\Collection|\Illuminate\Contracts\Pagination\LengthAwarePaginator
-     */
-    private function getIdAndOrderAttributes()
+      * Compiles all queries to one big one which binds everything together
+      * using UNION statements.
+      *
+      * @return
+      */
+    private function getCompiledQueryBuilder(): QueryBuilder
     {
         $queries = $this->buildQueries();
 
@@ -303,12 +304,22 @@ private function getIdAndOrderAttributes()
         $queries->each(fn (Builder $query) => $firstQuery->union($query));
 
         // sort by the given columns and direction
-        $firstQuery->orderBy(DB::raw($this->makeOrderBy()), $this->orderByDirection);
+        return $firstQuery->orderBy(DB::raw($this->makeOrderBy()), $this->orderByDirection);
+    }
+
+    /**
+     * Paginates the compiled query or fetches all results.
+     *
+     * @return \Illuminate\Support\Collection|\Illuminate\Contracts\Pagination\LengthAwarePaginator
+     */
+    private function getIdAndOrderAttributes()
+    {
+        $query = $this->getCompiledQueryBuilder();
 
         // get all results or limit the results by pagination
         return $this->perPage
-            ? $firstQuery->paginate($this->perPage, ['*'], $this->pageName, $this->page)
-            : $firstQuery->get();
+            ? $query->paginate($this->perPage, ['*'], $this->pageName, $this->page)
+            : $query->get();
 
         // the collection will be something like:
         //
@@ -358,6 +369,19 @@ private function getModelsPerType($results)
         // ]
     }
 
+    /**
+     * Retrieve the "count" result of the query.
+     *
+     * @param string $terms
+     * @return integer
+     */
+    public function count(string $terms = null): int
+    {
+        $this->initializeTerms($terms ?: '');
+
+        return $this->getCompiledQueryBuilder()->count();
+    }
+
     /**
      * Initialize the search terms, execute the search query and retrieve all
      * models per type. Map the results to a Eloquent collection and set

tests/SearchTest.php

@@ -54,6 +54,21 @@ public function it_can_search_in_multiple_columns()
         $this->assertFalse($results->contains($postB));
     }
 
+    /** @test */
+    public function it_can_count_the_results()
+    {
+        $postA  = Post::create(['title' => 'foo']);
+        $postB  = Post::create(['title' => 'bar']);
+        $videoA = Video::create(['title' => 'foo']);
+        $videoB = Video::create(['title' => 'bar', 'subtitle' => 'foo']);
+
+        $count = Search::add(Post::class, 'title')
+            ->add(Video::class, ['title', 'subtitle'])
+            ->count('foo');
+
+        $this->assertEquals(3, $count);
+    }
+
     /** @test */
     public function it_can_search_for_a_phrase()
     {