Registry.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 assert;
use function file_get_contents;
use function file_put_contents;
use function serialize;
use function unserialize;
use PHPUnit\Event\Facade as EventFacade;
use PHPUnit\TextUI\CliArguments\Configuration as CliConfiguration;
use PHPUnit\TextUI\CliArguments\Exception;
use PHPUnit\TextUI\XmlConfiguration\Configuration as XmlConfiguration;
use PHPUnit\Util\VersionComparisonOperator;

/**
 * CLI options and XML configuration are static within a single PHPUnit process.
 * It is therefore okay to use a Singleton registry here.
 *
 * @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
 *
 * @internal This class is not covered by the backward compatibility promise for PHPUnit
 */
final class Registry {
    private static ?Configuration $instance = null;
    public static function saveTo(string $path) : bool {
        $result = file_put_contents($path, serialize(self::get()));
        if ($result) {
            return true;
        }
        // @codeCoverageIgnoreStart
        return false;
        // @codeCoverageIgnoreEnd
    }
    
    /**
     * This method is used by the "run test(s) in separate process" templates.
     *
     * @noinspection PhpUnused
     *
     * @codeCoverageIgnore
     */
    public static function loadFrom(string $path) : void {
        self::$instance = unserialize(file_get_contents($path), [
            'allowed_classes' => [
                Configuration::class,
                Php::class,
                ConstantCollection::class,
                Constant::class,
                IniSettingCollection::class,
                IniSetting::class,
                VariableCollection::class,
                Variable::class,
                DirectoryCollection::class,
                Directory::class,
                FileCollection::class,
                File::class,
                FilterDirectoryCollection::class,
                FilterDirectory::class,
                TestDirectoryCollection::class,
                TestDirectory::class,
                TestFileCollection::class,
                TestFile::class,
                TestSuiteCollection::class,
                TestSuite::class,
                VersionComparisonOperator::class,
                Source::class,
            ],
        ]);
    }
    public static function get() : Configuration {
        assert(self::$instance instanceof Configuration);
        return self::$instance;
    }
    
    /**
     * @throws \PHPUnit\TextUI\XmlConfiguration\Exception
     * @throws Exception
     * @throws NoCustomCssFileException
     */
    public static function init(CliConfiguration $cliConfiguration, XmlConfiguration $xmlConfiguration) : Configuration {
        self::$instance = (new Merger())->merge($cliConfiguration, $xmlConfiguration);
        EventFacade::emitter()->testRunnerConfigured(self::$instance);
        return self::$instance;
    }

}