Add example for pivot table alias

README.md

@@ -363,7 +363,7 @@ You can specify a custom pivot model as the third argument and a custom accessor
 public function permissions()
 {
     return $this->hasManyDeep('App\Permission', ['role_user', 'App\Role'])
-        ->withPivot('role_user', ['expires_at'], 'App\RoleUserPivot', 'pivot');
+        ->withPivot('role_user', ['expires_at'], 'App\RoleUser', 'pivot');
 }
 
 foreach ($user->permissions as $permission) {
@@ -396,6 +396,25 @@ class Comment extends Model
 }
 ```
 
+For pivot tables, this requires custom models:
+
+```php
+class User extends Model
+{
+    use \Staudenmeir\EloquentHasManyDeep\HasRelationships;
+
+    public function permissions()
+    {
+        return $this->hasManyDeep('App\Permission', ['App\RoleUser as alias', 'App\Role']);
+    }
+}
+
+class RoleUser extends Pivot
+{
+    use \Staudenmeir\EloquentHasManyDeep\HasTableAlias;
+}
+```
+
 ### Soft Deleting
 
 By default, soft-deleted intermediate models will be excluded from the result. Use `withTrashed()` to include them:

tests/HasManyDeepTest.php

@@ -8,7 +8,7 @@
 use Tests\Models\Comment;
 use Tests\Models\Country;
 use Tests\Models\Post;
-use Tests\Models\RoleUserPivot;
+use Tests\Models\RoleUser;
 use Tests\Models\Tag;
 use Tests\Models\User;
 
@@ -271,10 +271,10 @@ public function testWithPivot()
     public function testWithPivotClass()
     {
         $permissions = User::first()->permissions()
-            ->withPivot('role_user', ['role_role_pk'], RoleUserPivot::class, 'pivot')
+            ->withPivot('role_user', ['role_role_pk'], RoleUser::class, 'pivot')
             ->get();
 
-        $this->assertInstanceOf(RoleUserPivot::class, $pivot = $permissions[0]->pivot);
+        $this->assertInstanceOf(RoleUser::class, $pivot = $permissions[0]->pivot);
         $this->assertEquals(['role_role_pk' => 1], $pivot->getAttributes());
     }
 

tests/Models/Country.php

@@ -38,7 +38,7 @@ public function permissions()
 
     public function permissionsWithPivotAlias()
     {
-        return $this->hasManyDeep(Permission::class, [User::class, RoleUserPivot::class.' as alias', Role::class]);
+        return $this->hasManyDeep(Permission::class, [User::class, RoleUser::class.' as alias', Role::class]);
     }
 
     public function posts()

tests/Models/RoleUserPivot.php → tests/Models/RoleUser.php

@@ -5,9 +5,7 @@
 use Illuminate\Database\Eloquent\Relations\Pivot;
 use Staudenmeir\EloquentHasManyDeep\HasTableAlias;
 
-class RoleUserPivot extends Pivot
+class RoleUser extends Pivot
 {
     use HasTableAlias;
-
-    protected $table = 'role_user';
 }