Skip to content

Improve phpdoc for non empty list #1037

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: 2.x
Choose a base branch
from
Open

Improve phpdoc for non empty list #1037

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e778f04
Improve phpdoc for non empty list
VincentLanglet Dec 1, 2025
eff0984
Update stubs
VincentLanglet Dec 1, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions src/Factory.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,7 @@ public static function createOne(array|callable $attributes = []): mixed
* @phpstan-param Attributes $attributes
*
* @return list<T>
* @phpstan-return ($number is positive-int ? non-empty-list<T> : list<T>)
*/
final public static function createMany(int $number, array|callable $attributes = []): array
{
Expand All @@ -80,6 +81,7 @@ final public static function createMany(int $number, array|callable $attributes
* @phpstan-param Attributes $attributes
*
* @return list<T>
* @phpstan-return ($min is positive-int ? non-empty-list<T> : list<T>)
*/
final public static function createRange(int $min, int $max, array|callable $attributes = []): array
{
Expand Down
10 changes: 6 additions & 4 deletions src/Persistence/PersistentObjectFactory.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -100,9 +100,9 @@ public static function randomOrCreate(array $criteria = []): object

/**
* @param positive-int $count
* @phpstan-param Parameters $criteria
* @phpstan-param Parameters $criteria
*
* @return list<T>
* @return non-empty-list<T>
*/
public static function randomSet(int $count, array $criteria = []): array
{
Expand All @@ -112,9 +112,10 @@ public static function randomSet(int $count, array $criteria = []): array
/**
* @param int<0, max> $min
* @param int<0, max> $max
* @phpstan-param Parameters $criteria
* @phpstan-param Parameters $criteria
*
* @return list<T>
* @phpstan-return ($min is positive-int ? non-empty-list<T> : list<T>)
*/
public static function randomRange(int $min, int $max, array $criteria = []): array
{
Expand All @@ -124,9 +125,10 @@ public static function randomRange(int $min, int $max, array $criteria = []): ar
/**
* @param int<0, max> $min
* @param int<0, max> $max
* @phpstan-param Parameters $criteria
* @phpstan-param Parameters $criteria
*
* @return list<T>
* @phpstan-return ($min is positive-int ? non-empty-list<T> : list<T>)
*/
public static function randomRangeOrCreate(int $min, int $max, array $criteria = []): array
{
Expand Down
4 changes: 2 additions & 2 deletions stubs/psalm/ObjectFactory.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,9 +43,9 @@ protected function defaults(): array|callable
$var = UserObjectFactory::new()->with()->create();

// methods returning a list of objects
/** @psalm-check-type-exact $var = list<UserForObjectFactory> */
/** @psalm-check-type-exact $var = non-empty-list<UserForObjectFactory> */
$var = UserObjectFactory::createMany(1);
/** @psalm-check-type-exact $var = list<UserForObjectFactory> */
/** @psalm-check-type-exact $var = non-empty-list<UserForObjectFactory> */
$var = UserObjectFactory::createRange(1, 2);
/** @psalm-check-type-exact $var = list<UserForObjectFactory> */
$var = UserObjectFactory::createSequence([]);
Expand Down
8 changes: 4 additions & 4 deletions stubs/psalm/PersistentObjectFactory.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,15 +57,15 @@ protected function defaults(): array|callable
// methods returning a list of objects
/** @psalm-check-type-exact $var = list<UserForPersistentFactory> */
$var = UserFactory::all();
/** @psalm-check-type-exact $var = list<UserForPersistentFactory> */
/** @psalm-check-type-exact $var = non-empty-list<UserForPersistentFactory> */
$var = UserFactory::createMany(1);
/** @psalm-check-type-exact $var = list<UserForPersistentFactory> */
/** @psalm-check-type-exact $var = non-empty-list<UserForPersistentFactory> */
$var = UserFactory::createRange(1, 2);
/** @psalm-check-type-exact $var = list<UserForPersistentFactory> */
$var = UserFactory::createSequence([]);
/** @psalm-check-type-exact $var = list<UserForPersistentFactory> */
/** @psalm-check-type-exact $var = non-empty-list<UserForPersistentFactory> */
$var = UserFactory::randomRange(1, 2);
/** @psalm-check-type-exact $var = list<UserForPersistentFactory> */
/** @psalm-check-type-exact $var = non-empty-list<UserForPersistentFactory> */
$var = UserFactory::randomSet(2);
/** @psalm-check-type-exact $var = list<UserForPersistentFactory> */
$var = UserFactory::findBy(['name' => 'foo']);
Expand Down
Loading