Skip to content

Commit 1b38df6

Browse files
committed
Improve documentation to recommend wrapping internal modules
Instead of directly using internal modules, recommend creating a custom module that wraps MediaQueryBaseModule and MediaQueryDbModule for advanced use cases. This promotes better encapsulation.
1 parent 4025b54 commit 1b38df6

File tree

1 file changed

+11
-2
lines changed

1 file changed

+11
-2
lines changed

src/MediaQuerySqlModule.php

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,17 @@
2222
* ));
2323
* ```
2424
*
25-
* For advanced use cases requiring explicit query class selection, use MediaQueryBaseModule
26-
* and MediaQueryDbModule directly.
25+
* For advanced use cases requiring explicit query class selection or custom configuration,
26+
* create your own module that wraps the internal modules:
27+
* ```php
28+
* class MyQueryModule extends AbstractModule {
29+
* protected function configure(): void {
30+
* $queries = Queries::fromClasses([UserInterface::class, OrderInterface::class]);
31+
* $this->install(new MediaQueryBaseModule($queries));
32+
* $this->install(new MediaQueryDbModule(new DbQueryConfig('/path/to/sql')));
33+
* }
34+
* }
35+
* ```
2736
*/
2837
final class MediaQuerySqlModule extends AbstractModule
2938
{

0 commit comments

Comments
 (0)