DataProvider.php

<?php declare(strict_types=1);
/*
 * This file is part of PHPUnit.
 *
 * (c) Sebastian Bergmann <sebastian@phpunit.de>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */
namespace PHPUnit\Metadata;

/**
 * @immutable
 *
 * @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
 */
final readonly class DataProvider extends Metadata
{
    /**
     * @var class-string
     */
    private string $className;

    /**
     * @var non-empty-string
     */
    private string $methodName;
    private bool $validateArgumentCount;
    private bool $skipWhenEmpty;

    /**
     * @param class-string     $className
     * @param non-empty-string $methodName
     */
    protected function __construct(Level $level, string $className, string $methodName, bool $validateArgumentCount, bool $skipWhenEmpty)
    {
        parent::__construct($level);

        $this->className             = $className;
        $this->methodName            = $methodName;
        $this->validateArgumentCount = $validateArgumentCount;
        $this->skipWhenEmpty         = $skipWhenEmpty;
    }

    public function isDataProvider(): true
    {
        return true;
    }

    /**
     * @return class-string
     */
    public function className(): string
    {
        return $this->className;
    }

    /**
     * @return non-empty-string
     */
    public function methodName(): string
    {
        return $this->methodName;
    }

    public function validateArgumentCount(): bool
    {
        return $this->validateArgumentCount;
    }

    public function skipWhenEmpty(): bool
    {
        return $this->skipWhenEmpty;
    }
}