feat: efficient count() methods on Activity, Address, Estate, and User

CHANGELOG.md

@@ -3,6 +3,9 @@
 ## main
 - TODO: Remove old activity repository code in next major release
 
+## v1.6.0
+- feat: add efficient count() to ActivityRepository, AddressRepository, EstateRepository, and SettingsRepository::user()
+
 ## v1.5.10
 - allow passing strings to relation trait so new relations do not have to be added every time they are used
 - add missing relation type to trait
@@ -36,7 +39,7 @@
 - fixes issue where requests with strings as resource types could not be processed when generating the hmac
 
 ## v1.5.0
-- feat: enable withCredentials call_ on Builder so config is not needed to set runtime credentials
+- feat: enable withCredentials call on Builder so config is not needed to set runtime credentials
 
 ## v1.4.4
 - fix type annotation for upload function on file repository

docs/repositories/activity-repository.md

@@ -27,6 +27,10 @@ ActivityRepository::query()
     ->each(function (array $estates) {
         // First page
     });
+
+$count = ActivityRepository::query()
+    ->addressIds([1, 2])
+    ->count();
 ```
 
 ## Create

docs/repositories/estate-repository.md

@@ -40,6 +40,13 @@ $estate = EstateRepository::query()
     ]);
 ```
 
+### Count
+
+```php
+$count = EstateRepository::query()
+    ->count();
+```
+
 ### Search
 
 ::: tip

docs/repositories/setting-repository.md

@@ -17,6 +17,9 @@ SettingRepository::users()
     ->each(function (array $settings) {
         // First page
     });
+
+$count = SettingRepository::users()
+    ->count();
 ```
 
 ## Regions

src/Query/ActivityBuilder.php

@@ -138,6 +138,30 @@ public function create(array $data): array
             ->json('response.results.0.data.records.0');
     }
 
+    /**
+     * Returns the number of records that match the query. This number is from the API
+     * and might be lower than the actual number of records when queried with get().
+     *
+     * @throws OnOfficeException
+     */
+    public function count(): int
+    {
+        $request = new OnOfficeRequest(
+            OnOfficeAction::Read,
+            OnOfficeResourceType::Activity,
+            parameters: [
+                ...$this->prepareEstateOrAddressParameters(),
+                OnOfficeService::DATA => [],
+                OnOfficeService::FILTER => $this->getFilters(),
+                OnOfficeService::LISTLIMIT => 1,
+                ...$this->customParameters,
+            ]
+        );
+
+        return $this->requestApi($request)
+            ->json('response.results.0.data.meta.cntabsolute', 0);
+    }
+
     /**
      * @deprecated Use estateId() instead
      */

src/Query/AddressBuilder.php

@@ -136,22 +136,21 @@ public function modify(int $id): bool
     }
 
     /**
+     * Returns the number of records that match the query. This number is from the API
+     * and might be lower than the actual number of records when queried with get().
+     *
      * @throws Throwable<OnOfficeException>
      */
     public function count(): int
     {
-        $orderBy = $this->getOrderBy();
-
         $request = new OnOfficeRequest(
             OnOfficeAction::Read,
             OnOfficeResourceType::Address,
             parameters: [
                 OnOfficeService::RECORDIDS => $this->recordIds,
-                OnOfficeService::DATA => $this->columns,
+                OnOfficeService::DATA => [],
                 OnOfficeService::FILTER => $this->getFilters(),
-                OnOfficeService::LISTLIMIT => $this->limit > 0 ? $this->limit : $this->pageSize,
-                OnOfficeService::SORTBY => data_get(array_keys($orderBy), 0),
-                OnOfficeService::SORTORDER => data_get($orderBy, 0),
+                OnOfficeService::LISTLIMIT => 1,
                 ...$this->customParameters,
             ]
         );

src/Query/EstateBuilder.php

@@ -153,4 +153,27 @@ public function search(): Collection
 
         return $this->requestAll($request);
     }
+
+    /**
+     * Returns the number of records that match the query. This number is from the API
+     * and might be lower than the actual number of records when queried with get().
+     *
+     * @throws OnOfficeException
+     */
+    public function count(): int
+    {
+        $request = new OnOfficeRequest(
+            OnOfficeAction::Read,
+            OnOfficeResourceType::Estate,
+            parameters: [
+                OnOfficeService::DATA => [],
+                OnOfficeService::FILTER => $this->getFilters(),
+                OnOfficeService::LISTLIMIT => 1,
+                ...$this->customParameters,
+            ],
+        );
+
+        return $this->requestApi($request)
+            ->json('response.results.0.data.meta.cntabsolute', 0);
+    }
 }

src/Query/UserBuilder.php

@@ -92,4 +92,27 @@ public function each(callable $callback): void
 
         $this->requestAllChunked($request, $callback);
     }
+
+    /**
+     * Returns the number of records that match the query. This number is from the API
+     * and might be lower than the actual number of records when queried with get().
+     *
+     * @throws OnOfficeException
+     */
+    public function count(): int
+    {
+        $request = new OnOfficeRequest(
+            OnOfficeAction::Read,
+            OnOfficeResourceType::User,
+            parameters: [
+                OnOfficeService::DATA => [],
+                OnOfficeService::FILTER => $this->getFilters(),
+                OnOfficeService::LISTLIMIT => 1,
+                ...$this->customParameters,
+            ],
+        );
+
+        return $this->requestApi($request)
+            ->json('response.results.0.data.meta.cntabsolute', 0);
+    }
 }

tests/Repositories/ActivityRepositoryTest.php

@@ -44,4 +44,21 @@
 
         ActivityRepository::assertSentCount(3);
     });
+
+    test('count', function () {
+        Http::preventStrayRequests();
+        Http::fake([
+            'https://api.onoffice.de/api/stable/api.php/' => Http::sequence([
+                ReadActivityResponse::make(count: 1500),
+            ]),
+        ]);
+
+        ActivityRepository::record();
+
+        $response = ActivityRepository::query()->count();
+
+        expect($response)->toBe(1500);
+
+        ActivityRepository::assertSentCount(1);
+    });
 });

tests/Repositories/AddressRepositoryTest.php

@@ -44,4 +44,21 @@
 
         AddressRepository::assertSentCount(3);
     });
+
+    test('count', function () {
+        Http::preventStrayRequests();
+        Http::fake([
+            'https://api.onoffice.de/api/stable/api.php/' => Http::sequence([
+                ReadAddressResponse::make(count: 1500),
+            ]),
+        ]);
+
+        AddressRepository::record();
+
+        $response = AddressRepository::query()->count();
+
+        expect($response)->toBe(1500);
+
+        AddressRepository::assertSentCount(1);
+    });
 });

tests/Repositories/EstateRepositoryTest.php

@@ -64,6 +64,23 @@
 
         EstateRepository::assertSentCount(3);
     });
+
+    test('count', function () {
+        Http::preventStrayRequests();
+        Http::fake([
+            'https://api.onoffice.de/api/stable/api.php/' => Http::sequence([
+                ReadEstateResponse::make(count: 1500),
+            ]),
+        ]);
+
+        EstateRepository::record();
+
+        $response = EstateRepository::query()->count();
+
+        expect($response)->toBe(1500);
+
+        EstateRepository::assertSentCount(1);
+    });
 });
 
 describe('search', function () {

tests/Repositories/UserRepositoryTest.php

@@ -42,4 +42,21 @@
 
         SettingRepository::assertSentCount(1);
     });
+
+    test('count', function () {
+        Http::preventStrayRequests();
+        Http::fake([
+            'https://api.onoffice.de/api/stable/api.php/' => Http::sequence([
+                ReadUserResponse::make(count: 1500),
+            ]),
+        ]);
+
+        SettingRepository::record();
+
+        $response = SettingRepository::users()->count();
+
+        expect($response)->toBe(1500);
+
+        SettingRepository::assertSentCount(1);
+    });
 });