File "FixerOption.php"

Full Path: /var/www/html/back/vendor/friendsofphp/php-cs-fixer/src/FixerConfiguration/FixerOption.php
File size: 3.68 KB
MIME-type: text/x-php
Charset: utf-8

<?php

declare(strict_types=1);

/*
 * This file is part of PHP CS Fixer.
 *
 * (c) Fabien Potencier <fabien@symfony.com>
 *     Dariusz Rumiński <dariusz.ruminski@gmail.com>
 *
 * This source file is subject to the MIT license that is bundled
 * with this source code in the file LICENSE.
 */

namespace PhpCsFixer\FixerConfiguration;

/**
 * @readonly
 *
 * @no-named-arguments Parameter names are not covered by the backward compatibility promise.
 */
final class FixerOption implements FixerOptionInterface
{
    private string $name;

    private string $description;

    private bool $isRequired;

    /**
     * @var mixed
     */
    private $default;

    /**
     * @var null|list<string>
     */
    private ?array $allowedTypes;

    /**
     * @var null|non-empty-list<null|(callable(mixed): bool)|scalar>
     */
    private ?array $allowedValues;

    private ?\Closure $normalizer;

    /**
     * @param mixed                                                    $default
     * @param null|list<string>                                        $allowedTypes
     * @param null|non-empty-list<null|(callable(mixed): bool)|scalar> $allowedValues
     */
    public function __construct(
        string $name,
        string $description,
        bool $isRequired = true,
        $default = null,
        ?array $allowedTypes = null,
        ?array $allowedValues = null,
        ?\Closure $normalizer = null
    ) {
        if ($isRequired && null !== $default) {
            throw new \LogicException('Required options cannot have a default value.');
        }

        if (null !== $allowedValues) {
            $allowedValues = array_map(
                fn ($allowedValue) => $allowedValue instanceof \Closure ? $this->unbind($allowedValue) : $allowedValue,
                $allowedValues,
            );
        }

        $this->name = $name;
        $this->description = $description;
        $this->isRequired = $isRequired;
        $this->default = $default;
        $this->allowedTypes = $allowedTypes;
        $this->allowedValues = $allowedValues;

        if (null !== $normalizer) {
            $this->normalizer = $this->unbind($normalizer);
        } else {
            $this->normalizer = null;
        }
    }

    public function getName(): string
    {
        return $this->name;
    }

    public function getDescription(): string
    {
        return $this->description;
    }

    public function hasDefault(): bool
    {
        return !$this->isRequired;
    }

    /**
     * @return mixed
     */
    public function getDefault()
    {
        if (!$this->hasDefault()) {
            throw new \LogicException('No default value defined.');
        }

        return $this->default;
    }

    public function getAllowedTypes(): ?array
    {
        return $this->allowedTypes;
    }

    public function getAllowedValues(): ?array
    {
        return $this->allowedValues;
    }

    public function getNormalizer(): ?\Closure
    {
        return $this->normalizer;
    }

    /**
     * Unbinds the given closure to avoid memory leaks.
     *
     * The closures provided to this class were probably defined in a fixer
     * class and thus bound to it by default. The configuration will then be
     * stored in {@see AbstractFixer::$configurationDefinition}, leading to the
     * following cyclic reference:
     *
     *     fixer -> configuration definition -> options -> closures -> fixer
     *
     * This cyclic reference prevent the garbage collector to free memory as
     * all elements are still referenced.
     *
     * See {@see https://bugs.php.net/bug.php?id=69639 Bug #69639} for details.
     */
    private function unbind(\Closure $closure): \Closure
    {
        return $closure->bindTo(null);
    }
}