PieComposerRequest.php

<?php

declare(strict_types=1);

namespace Php\Pie\ComposerIntegration;

use Composer\IO\IOInterface;
use Php\Pie\DependencyResolver\RequestedPackageAndVersion;
use Php\Pie\Downloading\DownloadUrlMethod;
use Php\Pie\Platform\TargetPlatform;

use function array_map;
use function in_array;

/**
 * @internal This is not public API for PIE, so should not be depended upon unless you accept the risk of BC breaks
 *
 * @immutable
 */
final class PieComposerRequest
{
    /** @var list<string> */
    private readonly array $requestedPackageNames;

    /**
     * @param list<RequestedPackageAndVersion>      $requestedPackages
     * @param array<string, list<non-empty-string>> $configureOptions             Keyed by package name
     * @param list<DownloadUrlMethod>               $suppressedDownloadUrlMethods
     */
    public function __construct(
        public readonly IOInterface $pieOutput,
        public readonly TargetPlatform $targetPlatform,
        public readonly array $requestedPackages,
        public readonly PieOperation $operation,
        public readonly array $configureOptions,
        public readonly bool $attemptToSetupIniFile,
        public readonly bool $installAllPackages = false,
        public readonly array $suppressedDownloadUrlMethods = [],
    ) {
        $this->requestedPackageNames = array_map(static fn (RequestedPackageAndVersion $request) => $request->package, $this->requestedPackages);
    }

    /** @return list<non-empty-string> */
    public function configureOptionsFor(string $packageName): array
    {
        return $this->configureOptions[$packageName] ?? [];
    }

    /**
     * Useful for when we don't want to perform any "write" style operations;
     * for example just reading metadata about the installed system.
     */
    public static function noOperation(
        IOInterface $pieOutput,
        TargetPlatform $targetPlatform,
    ): self {
        return new PieComposerRequest(
            $pieOutput,
            $targetPlatform,
            [],
            PieOperation::Resolve,
            [],
            false,
        );
    }

    public function isFor(string $packageName): bool
    {
        if ($this->installAllPackages) {
            return true;
        }

        return in_array($packageName, $this->requestedPackageNames);
    }
}