Skip to content
This repository was archived by the owner on Aug 22, 2023. It is now read-only.

Commit ff796da

Browse files
committed
Add header documentation for classes & traits that can be used in applications
1 parent 4658d54 commit ff796da

File tree

4 files changed

+13
-0
lines changed

4 files changed

+13
-0
lines changed

src/Collection.php

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,9 @@
66
use MongoDB\BSON\ObjectID;
77
use MongoDB\Collection as MongoCollection;
88

9+
/**
10+
* @mixin MongoCollection
11+
*/
912
class Collection
1013
{
1114
/**

src/Connection.php

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,9 @@
1212
use MongoDB\Database;
1313
use Throwable;
1414

15+
/**
16+
* @mixin Database
17+
*/
1518
class Connection extends BaseConnection
1619
{
1720
use ManagesTransactions;

src/Eloquent/EmbedsRelations.php

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,9 @@
66
use Jenssegers\Mongodb\Relations\EmbedsMany;
77
use Jenssegers\Mongodb\Relations\EmbedsOne;
88

9+
/**
10+
* Embeds relations for MongoDB models.
11+
*/
912
trait EmbedsRelations
1013
{
1114
/**

src/Eloquent/HybridRelations.php

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,10 @@
1212
use Jenssegers\Mongodb\Relations\MorphMany;
1313
use Jenssegers\Mongodb\Relations\MorphTo;
1414

15+
/**
16+
* Cross-database relationships between SQL and MongoDB.
17+
* Use this trait in SQL models to define relationships with MongoDB models.
18+
*/
1519
trait HybridRelations
1620
{
1721
/**

0 commit comments

Comments
 (0)