Skip to content

Replace PHPDoc dataProvider with attribute syntax #21612

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

Merged
merged 1 commit into from
Dec 1, 2025
Merged

Replace PHPDoc dataProvider with attribute syntax #21612

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
9 changes: 4 additions & 5 deletions best_practices.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -403,13 +403,12 @@ checks that all application URLs load successfully::
// tests/ApplicationAvailabilityFunctionalTest.php
namespace App\Tests;

use PHPUnit\Framework\Attributes\DataProvider;
use Symfony\Bundle\FrameworkBundle\Test\WebTestCase;

class ApplicationAvailabilityFunctionalTest extends WebTestCase
{
/**
* @dataProvider urlProvider
*/
#[DataProvider('urlProvider')]
Copy link
Contributor

@OskarStark OskarStark Nov 29, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

please make the data provider itself static, thanks

Copy link
Contributor

@alamirault alamirault Dec 1, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

symfony-docs/validation/custom_constraint.rst

Line 584 in 3b6b704

* @dataProvider provideInvalidConstraints

Could also be updated ?

Copy link
Contributor

@OskarStark OskarStark Dec 1, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@alamirault shall we create a DOCtor rule for using phpunit attributes and search and report the most common ones?

Copy link
Member

@javiereguiluz javiereguiluz Dec 1, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We did this update while merging. Thanks!

Copy link
Contributor

@alamirault alamirault Dec 1, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@alamirault shall we create a DOCtor rule for using phpunit attributes and search and report the most common ones?

Not yet, not enough occurrence

public function testPageIsSuccessful($url): void
{
$client = self::createClient();
Expand All @@ -418,7 +417,7 @@ checks that all application URLs load successfully::
$this->assertResponseIsSuccessful();
}

public function urlProvider(): \Generator
public static function urlProvider(): \Generator
{
yield ['/'];
yield ['/posts'];
Expand Down
Loading