Update MocksMixins.php

jarektkaczyk · May 19, 2020 · ac17457 · ac17457
1 parent 6137862
commit ac17457
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/src/MocksMixins.php b/src/MocksMixins.php
@@ -19,6 +19,13 @@
  */
 trait MocksMixins
 {
+    /**
+     * Creates PHPUnit mock that mimics EloquentBuilder by allowing methods from QueryBuilder as well.
+     * By default PHPUnit mocks don't allow that, for EloquentBuilder is not extending QueryBuilder,
+     * and thus PHPUnit fails with error because the methods we try to mock or assert don't exist.
+     *
+     * @return MockObject|EloquentBuilder|QueryBuilder
+     */
     protected function mockEloquentBuilder(): MockObject
     {
         return $this->createMixinMock(EloquentBuilder::class, QueryBuilder::class);