HEX
Server: Apache
System: Linux WWW 6.1.0-40-amd64 #1 SMP PREEMPT_DYNAMIC Debian 6.1.153-1 (2025-09-20) x86_64
User: web11 (1011)
PHP: 8.2.29
Disabled: NONE
Upload Files
File: /var/www/payments-gateway/vendor/symfony/maker-bundle/src/Maker/MakeStimulusController.php
<?php

/*
 * This file is part of the Symfony MakerBundle package.
 *
 * (c) Fabien Potencier <fabien@symfony.com>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Symfony\Bundle\MakerBundle\Maker;

use Symfony\Bundle\MakerBundle\ConsoleStyle;
use Symfony\Bundle\MakerBundle\DependencyBuilder;
use Symfony\Bundle\MakerBundle\Generator;
use Symfony\Bundle\MakerBundle\InputConfiguration;
use Symfony\Bundle\MakerBundle\Str;
use Symfony\Component\Console\Command\Command;
use Symfony\Component\Console\Input\InputArgument;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Input\InputOption;
use Symfony\Component\Console\Question\Question;
use Symfony\UX\StimulusBundle\StimulusBundle;
use Symfony\WebpackEncoreBundle\WebpackEncoreBundle;

/**
 * @author Abdelilah Jabri <jbrabdelilah@gmail.com>
 *
 * @internal
 */
final class MakeStimulusController extends AbstractMaker
{
    public static function getCommandName(): string
    {
        return 'make:stimulus-controller';
    }

    public static function getCommandDescription(): string
    {
        return 'Create a new Stimulus controller';
    }

    public function configureCommand(Command $command, InputConfiguration $inputConfig): void
    {
        $command
            ->addArgument('name', InputArgument::REQUIRED, 'The name of the Stimulus controller (e.g. <fg=yellow>hello</>)')
            ->addOption('typescript', 'ts', InputOption::VALUE_NONE, 'Create a TypeScript controller (default is JavaScript)')
            ->setHelp($this->getHelpFileContents('MakeStimulusController.txt'))
        ;

        $inputConfig->setArgumentAsNonInteractive('typescript');
    }

    public function interact(InputInterface $input, ConsoleStyle $io, Command $command): void
    {
        $command->addArgument('extension', InputArgument::OPTIONAL);
        $command->addArgument('targets', InputArgument::OPTIONAL);
        $command->addArgument('values', InputArgument::OPTIONAL);
        $command->addArgument('classes', InputArgument::OPTIONAL);

        if ($input->getOption('typescript')) {
            $input->setArgument('extension', 'ts');
        } else {
            $chosenExtension = $io->choice(
                'Language (<fg=yellow>JavaScript</> or <fg=yellow>TypeScript</>)',
                [
                    'js' => 'JavaScript',
                    'ts' => 'TypeScript',
                ],
                'js',
            );

            $input->setArgument('extension', $chosenExtension);
        }

        if ($io->confirm('Do you want to include targets?')) {
            $targets = [];
            $isFirstTarget = true;

            while (true) {
                $newTarget = $this->askForNextTarget($io, $targets, $isFirstTarget);
                $isFirstTarget = false;

                if (null === $newTarget) {
                    break;
                }

                $targets[] = $newTarget;
            }

            $input->setArgument('targets', $targets);
        }

        if ($io->confirm('Do you want to include values?')) {
            $values = [];
            $isFirstValue = true;
            while (true) {
                $newValue = $this->askForNextValue($io, $values, $isFirstValue);
                $isFirstValue = false;

                if (null === $newValue) {
                    break;
                }

                $values[$newValue['name']] = $newValue;
            }

            $input->setArgument('values', $values);
        }

        if ($io->confirm('Do you want to add classes?', false)) {
            $classes = [];
            $isFirstClass = true;

            while (true) {
                $newClass = $this->askForNextClass($io, $classes, $isFirstClass);
                if (null === $newClass) {
                    break;
                }

                $isFirstClass = false;
                $classes[] = $newClass;
            }

            $input->setArgument('classes', $classes);
        }
    }

    public function generate(InputInterface $input, ConsoleStyle $io, Generator $generator): void
    {
        $controllerName = Str::asSnakeCase($input->getArgument('name'));
        $chosenExtension = $input->getArgument('extension');
        $targets = $targetArgs = $input->getArgument('targets') ?? [];
        $values = $valuesArg = $input->getArgument('values') ?? [];
        $classes = $classesArgs = $input->getArgument('classes') ?? [];

        $targets = empty($targets) ? $targets : \sprintf("['%s']", implode("', '", $targets));
        $classes = $classes ? \sprintf("['%s']", implode("', '", $classes)) : null;

        $fileName = \sprintf('%s_controller.%s', $controllerName, $chosenExtension);
        $filePath = \sprintf('assets/controllers/%s', $fileName);

        $generator->generateFile(
            $filePath,
            'stimulus/Controller.tpl.php',
            [
                'targets' => $targets,
                'values' => $values,
                'classes' => $classes,
            ]
        );

        $generator->writeChanges();

        $this->writeSuccessMessage($io);

        $io->text([
            'Next:',
            \sprintf('- Open <info>%s</info> and add the code you need', $filePath),
            '- Use the controller in your templates:',
            ...array_map(
                fn (string $line): string => "    $line",
                explode("\n", $this->generateUsageExample($controllerName, $targetArgs, $valuesArg, $classesArgs)),
            ),
            'Find the documentation at <fg=yellow>https://symfony.com/bundles/StimulusBundle</>',
        ]);
    }

    /** @param string[] $targets */
    private function askForNextTarget(ConsoleStyle $io, array $targets, bool $isFirstTarget): ?string
    {
        $questionText = 'New target name (press <return> to stop adding targets)';

        if (!$isFirstTarget) {
            $questionText = 'Add another target? Enter the target name (or press <return> to stop adding targets)';
        }

        $targetName = $io->ask($questionText, validator: function (?string $name) use ($targets) {
            if (\in_array($name, $targets)) {
                throw new \InvalidArgumentException(\sprintf('The "%s" target already exists.', $name));
            }

            return $name;
        });

        return !$targetName ? null : $targetName;
    }

    /**
     * @param array<string, array<string, string>> $values
     *
     * @return array<string, string>|null
     */
    private function askForNextValue(ConsoleStyle $io, array $values, bool $isFirstValue): ?array
    {
        $questionText = 'New value name (press <return> to stop adding values)';

        if (!$isFirstValue) {
            $questionText = 'Add another value? Enter the value name (or press <return> to stop adding values)';
        }

        $valueName = $io->ask($questionText, null, function ($name) use ($values) {
            if (\array_key_exists($name, $values)) {
                throw new \InvalidArgumentException(\sprintf('The "%s" value already exists.', $name));
            }

            return $name;
        });

        if (!$valueName) {
            return null;
        }

        $defaultType = 'String';
        // try to guess the type by the value name prefix/suffix
        // convert to snake case for simplicity
        $snakeCasedField = Str::asSnakeCase($valueName);

        if (str_ends_with($snakeCasedField, '_id')) {
            $defaultType = 'Number';
        } elseif (str_starts_with($snakeCasedField, 'is_')) {
            $defaultType = 'Boolean';
        } elseif (str_starts_with($snakeCasedField, 'has_')) {
            $defaultType = 'Boolean';
        }

        $type = null;
        $types = $this->getValuesTypes();

        while (null === $type) {
            $question = new Question('Value type (enter <comment>?</comment> to see all types)', $defaultType);
            $question->setAutocompleterValues($types);
            $type = $io->askQuestion($question);

            if ('?' === $type) {
                $this->printAvailableTypes($io);
                $io->writeln('');

                $type = null;
            } elseif (!\in_array($type, $types)) {
                $this->printAvailableTypes($io);
                $io->error(\sprintf('Invalid type "%s".', $type));
                $io->writeln('');

                $type = null;
            }
        }

        return ['name' => $valueName, 'type' => $type];
    }

    /** @param string[] $classes */
    private function askForNextClass(ConsoleStyle $io, array $classes, bool $isFirstClass): ?string
    {
        $questionText = 'New class name (press <return> to stop adding classes)';

        if (!$isFirstClass) {
            $questionText = 'Add another class? Enter the class name (or press <return> to stop adding classes)';
        }

        $className = $io->ask($questionText, validator: function (?string $name) use ($classes) {
            if (str_contains($name, ' ')) {
                throw new \InvalidArgumentException('Class name cannot contain spaces.');
            }
            if (\in_array($name, $classes, true)) {
                throw new \InvalidArgumentException(\sprintf('The "%s" class already exists.', $name));
            }

            return $name;
        });

        return $className ?: null;
    }

    private function printAvailableTypes(ConsoleStyle $io): void
    {
        foreach ($this->getValuesTypes() as $type) {
            $io->writeln(\sprintf('<info>%s</info>', $type));
        }
    }

    /** @return string[] */
    private function getValuesTypes(): array
    {
        return [
            'Array',
            'Boolean',
            'Number',
            'Object',
            'String',
        ];
    }

    /**
     * @param array<int, string>                       $targets
     * @param array<array{name: string, type: string}> $values
     * @param array<int, string>                       $classes
     */
    private function generateUsageExample(string $name, array $targets, array $values, array $classes): string
    {
        $slugify = fn (string $name) => str_replace('_', '-', Str::asSnakeCase($name));
        $controller = $slugify($name);

        $htmlTargets = [];
        foreach ($targets as $target) {
            $htmlTargets[] = \sprintf('<div data-%s-target="%s"></div>', $controller, $target);
        }

        $htmlValues = [];
        foreach ($values as ['name' => $name, 'type' => $type]) {
            $value = match ($type) {
                'Array' => '[]',
                'Boolean' => 'false',
                'Number' => '123',
                'Object' => '{}',
                'String' => 'abc',
                default => '',
            };
            $htmlValues[] = \sprintf('data-%s-%s-value="%s"', $controller, $slugify($name), $value);
        }

        $htmlClasses = [];
        foreach ($classes as $class) {
            $value = Str::asLowerCamelCase($class);
            $htmlClasses[] = \sprintf('data-%s-%s-class="%s"', $controller, $slugify($class), $value);
        }

        return \sprintf(
            '<div data-controller="%s"%s%s%s>%s%s</div>',
            $controller,
            $htmlValues ? ("\n    ".implode("\n    ", $htmlValues)) : '',
            $htmlClasses ? ("\n    ".implode("\n    ", $htmlClasses)) : '',
            ($htmlValues || $htmlClasses) ? "\n" : '',
            $htmlTargets ? ("\n        ".implode("\n        ", $htmlTargets)) : '',
            "\n        <!-- ... -->\n",
        );
    }

    public function configureDependencies(DependencyBuilder $dependencies): void
    {
        // lower than 8.1, allow WebpackEncoreBundle
        if (\PHP_VERSION_ID < 80100) {
            $dependencies->addClassDependency(
                WebpackEncoreBundle::class,
                'symfony/webpack-encore-bundle'
            );

            return;
        }

        // else: encourage StimulusBundle by requiring it
        $dependencies->addClassDependency(
            StimulusBundle::class,
            'symfony/stimulus-bundle'
        );
    }
}