Add options params on aggregate function

[abnegate]

Summary by CodeRabbit

• New Features
  • Aggregation queries now accept optional parameters, enabling advanced MongoDB options (e.g., collation, allowDiskUse, read concern) for greater flexibility while remaining backward compatible.
• Documentation
  • Updated guidance to describe the new optional parameters and their usage.

[coderabbitai]

Walkthrough

The aggregate method in src/Client.php now accepts an optional options array. The method merges these options into the aggregate command payload before invoking query. Docblock updated to document the new parameter. No other public interfaces are changed.

Changes

Cohort / File(s)	Summary
Aggregate options support src/Client.php	Expanded signature to aggregate(string $collection, array $pipeline, array $options = []): stdClass. Implementation now merges $options via array_merge into the command payload passed to query. Updated docblock to include $options.

Sequence Diagram(s)

sequenceDiagram
  autonumber
  actor Caller
  participant Client
  participant MongoDB as MongoDB Server

  Caller->>Client: aggregate(collection, pipeline, options?)
  rect rgba(200, 230, 255, 0.3)
    note right of Client: Build command payload
    Client->>Client: base = { aggregate, pipeline, cursor: {} }
    Client->>Client: payload = merge(base, options)
  end
  Client->>MongoDB: query(payload)
  MongoDB-->>Client: result (stdClass)
  Client-->>Caller: result

Loading

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

I twitch my whiskers, code in sight,
A sprinkle of options—now it’s right.
Pipelines hop with lighter feet,
Merged arrays make queries neat.
In burrows deep the docs now sing—
One small change, a smarter spring. 🐇✨

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title Check	✅ Passed	The title accurately describes the primary change in the PR, namely adding an options parameter to the aggregate function, and it concisely summarizes the update without extraneous details.
Docstring Coverage	✅ Passed	Docstring coverage is 100.00% which is sufficient. The required threshold is 80.00%.

✨ Finishing touches

• 📝 Generate Docstrings

🧪 Generate unit tests

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch feat-aggregate-options

---

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 589e329 and e6931a0.

📒 Files selected for processing (1)

• src/Client.php (1 hunks)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)

• GitHub Check: Tests (8.3)

🔇 Additional comments (4)

src/Client.php (4)

759-759: LGTM: Documentation updated correctly.

The docblock now accurately reflects the new optional $options parameter.

---

764-764: LGTM: Method signature enhancement.

The addition of the optional $options parameter with a default empty array is backward compatible and follows the established pattern used by other methods in this class.

---

766-770: LGTM: Consistent options merging pattern.

The implementation correctly uses array_merge to combine the base aggregate command with user-provided options, following the same pattern used throughout the codebase (e.g., dropDatabase, createCollection, find, etc.).

---

764-771: aggregate() calls remain compatible
All existing usages invoke aggregate() with two arguments, relying on the default $options array. No call sites require updates.

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}