Merge pull request #61 from longlevan9x/patch-1

Update document comment for EloquentJoin.php
fico7489 · Aug 28, 2019 · ec2152a · ec2152a
2 parents 456c9ba + 53652f2
commit ec2152a
Showing 1 changed file with 16 additions and 0 deletions.
diff --git a/src/Traits/EloquentJoin.php b/src/Traits/EloquentJoin.php
@@ -4,10 +4,26 @@
 
 use Fico7489\Laravel\EloquentJoin\EloquentJoinBuilder;
 
+/**
+ * Trait EloquentJoin
+ * @package Fico7489\Laravel\EloquentJoin\Traits
+ * @method static EloquentJoinBuilder joinRelations($relations, $leftJoin = null)
+ * @method static EloquentJoinBuilder whereJoin($column, $operator, $value, $boolean = 'and')
+ * @method static EloquentJoinBuilder orWhereJoin($column, $operator, $value)
+ * @method static EloquentJoinBuilder whereInJoin($column, $values, $boolean = 'and', $not = false)
+ * @method static EloquentJoinBuilder whereNotInJoin($column, $values, $boolean = 'and')
+ * @method static EloquentJoinBuilder orWhereInJoin($column, $values)
+ * @method static EloquentJoinBuilder orWhereNotInJoin($column, $values)
+ * @method static EloquentJoinBuilder orderByJoin($column, $direction = 'asc', $aggregateMethod = null)
+ */
 trait EloquentJoin
 {
     use ExtendRelationsTrait;
 
+    /**
+     * @param $query
+     * @return EloquentJoinBuilder
+     */
     public function newEloquentBuilder($query)
     {
         $newEloquentBuilder = new EloquentJoinBuilder($query);