Merge pull request #305 from lptn/more-stubs

Add More stubs: `lang_path`, `Eloquent\Builder::chunk`, `Database\Connection::transaction`

src/Plugin.php

@@ -51,6 +51,7 @@ protected function getCommonStubs(): array
  {
  return array_merge(
  glob(dirname(__DIR__) . '/stubs/Contracts/*.stubphp'),
+ glob(dirname(__DIR__) . '/stubs/Database/*.stubphp'),
  glob(dirname(__DIR__) . '/stubs/*.stubphp')
  );
  }

stubs/Database/ManagesTransactions.stub

@@ -0,0 +1,19 @@
+<?php
+
+namespace Illuminate\Database\Concerns;
+
+trait ManagesTransactions
+{
+ /**
+ * Execute a Closure within a transaction.
+ *
+ * @template TCallbackReturnType
+ *
+ * @param \Closure($this): TCallbackReturnType $callback
+ * @param positive-int $attempts
+ * @return TCallbackReturnType
+ *
+ * @throws \Throwable
+ */
+ public function transaction(\Closure $callback, $attempts = 1) {}
+}

stubs/EloquentBuilder.stubphp

@@ -119,6 +119,13 @@ class Builder
  */
  public function whereRelation($relation, $column, $operator = null, $value = null) {}
 
+ /**
+ * @param positive-int $count
+ * @param callable(\Illuminate\Database\Eloquent\Collection<int, TModel>, int): mixed $callback
+ * @return bool
+ */
+ public function chunk($count, $callback) {}
+
  /**
  * @param string $relation
  * @param \Closure|string|array<int, string>|\Illuminate\Database\Query\Expression $column

tests/acceptance/EloquentBuilderTypes.feature

@@ -274,3 +274,24 @@ Feature: Eloquent Builder types
  """
  When I run Psalm
  Then I see no errors
+
+ Scenario: call chunk returns templated Collection
+ Given I have the following code
+ """
+ use \Illuminate\Database\Eloquent\Collection;
+
+ class Post extends \Illuminate\Database\Eloquent\Model {};
+
+ /** @psalm-return \Illuminate\Database\Eloquent\Collection<int, Post> */
+ function test_chunk(Builder $builder): Collection {
+ /** @var \Illuminate\Database\Eloquent\Collection<int, Post> $firstChunk */
+ $firstChunk = collect();
+ Post::query()->chunk(10, function (Collection $collection) use ($firstChunk) {
+ $firstChunk->merge($collection);
+ });
+
+ return $firstChunk;
+ }
+ """
+ When I run Psalm
+ Then I see no errors