TestDirectoryCollection.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\TextUI\Configuration;

use function count;
use Countable;
use IteratorAggregate;

/**
 * @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
 *
 * @psalm-immutable
 *
 * @template-implements IteratorAggregate<int, TestDirectory>
 */
final class TestDirectoryCollection implements Countable, IteratorAggregate {
    
    /**
     * @psalm-var list<TestDirectory>
     */
    private readonly array $directories;
    
    /**
     * @psalm-param list<TestDirectory> $directories
     */
    public static function fromArray(array $directories) : self {
        return new self(...$directories);
    }
    private function __construct(TestDirectory ...$directories) {
        $this->directories = $directories;
    }
    
    /**
     * @psalm-return list<TestDirectory>
     */
    public function asArray() : array {
        return $this->directories;
    }
    public function count() : int {
        return count($this->directories);
    }
    public function getIterator() : TestDirectoryCollectionIterator {
        return new TestDirectoryCollectionIterator($this);
    }
    public function isEmpty() : bool {
        return $this->count() === 0;
    }

}