humbug / php-scoper

src/Configuration/Configuration.php

<?php

declare(strict_types=1);

/*
 * This file is part of the humbug/php-scoper package.
 *
 * Copyright (c) 2017 Théo FIDRY <theo.fidry@gmail.com>,
 *                    Pádraic Brady <padraic.brady@gmail.com>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Humbug\PhpScoper\Configuration;

use Humbug\PhpScoper\Patcher\Patcher;
use InvalidArgumentException;
use function Safe\preg_match;
use function Safe\sprintf;

final class Configuration
{
    private const PREFIX_PATTERN = '/^[\p{L}\d_\\\\]+$/u';

    /**
     * @var non-empty-string|null

The doc comment non-empty-string|null at position 0 could not be parsed: Unknown type name 'non-empty-string' at position 0 in non-empty-string|null.

     */
    private ?string $path;

    /**
     * @var non-empty-string

The doc comment non-empty-string at position 0 could not be parsed: Unknown type name 'non-empty-string' at position 0 in non-empty-string.

     */
    private string $prefix;

    private array $filesWithContents;
    private array $excludedFilesWithContents;
    private Patcher $patcher;
    private SymbolsConfiguration $symbolsConfiguration;

    /**
     * @param non-empty-string|null $path   Absolute path to the configuration file loaded.

The doc comment non-empty-string|null at position 0 could not be parsed: Unknown type name 'non-empty-string' at position 0 in non-empty-string|null.

     * @param non-empty-string      $prefix The prefix applied.
     * @param array<string, array{string, string}> $filesWithContents Array of tuple with the
     *                                            first argument being the file path and the second
     *                                            its contents
     * @param array<string, array{string, string}> $excludedFilesWithContents Array of tuple
     *                                            with the first argument being the file path and
     *                                            the second its contents
     */
    public function __construct(
        ?string $path,
        string $prefix,
        array $filesWithContents,
        array $excludedFilesWithContents,
        Patcher $patcher,
        SymbolsConfiguration $symbolsConfiguration
    ) {
        self::validatePrefix($prefix);

        $this->path = $path;
        $this->prefix = $prefix;
        $this->filesWithContents = $filesWithContents;
        $this->excludedFilesWithContents = $excludedFilesWithContents;
        $this->patcher = $patcher;
        $this->symbolsConfiguration = $symbolsConfiguration;
    }

    /**
     * @return non-empty-string|null Absolute canonical path

The doc comment non-empty-string|null at position 0 could not be parsed: Unknown type name 'non-empty-string' at position 0 in non-empty-string|null.

     */
    public function getPath(): ?string
    {
        return $this->path;
    }

    /**
     * @param non-empty-string $prefix

The doc comment non-empty-string at position 0 could not be parsed: Unknown type name 'non-empty-string' at position 0 in non-empty-string.

     */
    public function withPrefix(string $prefix): self
    {
        return new self(
            $this->path,
            $prefix,
            $this->filesWithContents,
            $this->excludedFilesWithContents,
            $this->patcher,
            $this->symbolsConfiguration,
        );
    }

    /**
     * @return non-empty-string

The doc comment non-empty-string at position 0 could not be parsed: Unknown type name 'non-empty-string' at position 0 in non-empty-string.

     */
    public function getPrefix(): string
    {
        return $this->prefix;
    }

    /**
     * @return array<string, array{string, string}>
     */
    public function getFilesWithContents(): array
    {
        return $this->filesWithContents;
    }

    /**
     * @return array<string, array{string, string}>
     */
    public function getExcludedFilesWithContents(): array
    {
        return $this->excludedFilesWithContents;
    }

    public function getPatcher(): Patcher
    {
        return $this->patcher;
    }

    public function getSymbolsConfiguration(): SymbolsConfiguration
    {
        return $this->symbolsConfiguration;
    }

    private static function validatePrefix(string $prefix): void
    {
        if (1 !== preg_match(self::PREFIX_PATTERN, $prefix)) {
            throw new InvalidArgumentException(
                sprintf(

The function Safe\sprintf() has been deprecated: The Safe version of this function is no longer needed in PHP 8.0+

                    'The prefix needs to be composed solely of letters, digits and backslashes (as namespace separators). Got "%s"',
                    $prefix,
                ),
            );
        }

        if (preg_match('/\\\{2,}/', $prefix)) {
            throw new InvalidArgumentException(
                sprintf(

The function Safe\sprintf() has been deprecated: The Safe version of this function is no longer needed in PHP 8.0+

                    'Invalid namespace separator sequence. Got "%s"',
                    $prefix,
                ),
            );
        }
    }
}