class GenerateProxyClassCommand

Same name in other branches
  1. 9 core/lib/Drupal/Core/Command/GenerateProxyClassCommand.php \Drupal\Core\Command\GenerateProxyClassCommand
  2. 8.9.x core/lib/Drupal/Core/Command/GenerateProxyClassCommand.php \Drupal\Core\Command\GenerateProxyClassCommand
  3. 10 core/lib/Drupal/Core/Command/GenerateProxyClassCommand.php \Drupal\Core\Command\GenerateProxyClassCommand

Provides a console command to generate proxy classes.

Hierarchy

Expanded class hierarchy of GenerateProxyClassCommand

See also

Lazy Services

core/scripts/generate-proxy.sh

File

core/lib/Drupal/Core/Command/GenerateProxyClassCommand.php, line 17

Namespace

Drupal\Core\Command
View source
class GenerateProxyClassCommand extends Command {
    
    /**
     * The proxy builder.
     *
     * @var \Drupal\Component\ProxyBuilder\ProxyBuilder
     */
    protected $proxyBuilder;
    
    /**
     * Constructs a new GenerateProxyClassCommand instance.
     *
     * @param \Drupal\Component\ProxyBuilder\ProxyBuilder $proxy_builder
     *   The proxy builder.
     */
    public function __construct(ProxyBuilder $proxy_builder) {
        parent::__construct();
        $this->proxyBuilder = $proxy_builder;
    }
    
    /**
     * {@inheritdoc}
     */
    protected function configure() {
        $this->setName('generate-proxy-class')
            ->setDefinition([
            new InputArgument('class_name', InputArgument::REQUIRED, 'The class to be proxied'),
            new InputArgument('namespace_root_path', InputArgument::REQUIRED, 'The filepath to the root of the namespace.'),
        ])
            ->setDescription('Dumps a generated proxy class into its appropriate namespace.')
            ->addUsage('\'Drupal\\Core\\Batch\\BatchStorage\' "core/lib/Drupal/Core"')
            ->addUsage('\'Drupal\\block\\BlockRepository\' "core/modules/block/src"')
            ->addUsage('\'Drupal\\my_module\\MyClass\' "modules/contrib/my_module/src"');
    }
    
    /**
     * {@inheritdoc}
     */
    protected function execute(InputInterface $input, OutputInterface $output) : int {
        $class_name = ltrim($input->getArgument('class_name'), '\\');
        $namespace_root = $input->getArgument('namespace_root_path');
        $match = [];
        preg_match('/([a-zA-Z0-9_]+\\\\[a-zA-Z0-9_]+)\\\\(.+)/', $class_name, $match);
        if ($match) {
            $root_namespace = $match[1];
            $rest_fqcn = $match[2];
            $proxy_filename = $namespace_root . '/ProxyClass/' . str_replace('\\', '/', $rest_fqcn) . '.php';
            $proxy_class_name = $root_namespace . '\\ProxyClass\\' . $rest_fqcn;
            $proxy_class_string = $this->proxyBuilder
                ->build($class_name);
            $file_string = <<<EOF
<?php
// phpcs:ignoreFile

/**
 * This file was generated via php core/scripts/generate-proxy-class.php '{<span class="php-variable">$class_name</span>}' "{<span class="php-variable">$namespace_root</span>}".
 */
{{ proxy_class_string }}
EOF;
            $file_string = str_replace([
                '{{ proxy_class_name }}',
                '{{ proxy_class_string }}',
            ], [
                $proxy_class_name,
                $proxy_class_string,
            ], $file_string);
            mkdir(dirname($proxy_filename), 0775, TRUE);
            file_put_contents($proxy_filename, $file_string);
            $output->writeln(sprintf('Proxy of class %s written to %s', $class_name, $proxy_filename));
        }
        return 0;
    }

}

Members

Title Sort descending Modifiers Object type Summary
GenerateProxyClassCommand::$proxyBuilder protected property The proxy builder.
GenerateProxyClassCommand::configure protected function
GenerateProxyClassCommand::execute protected function
GenerateProxyClassCommand::__construct public function Constructs a new GenerateProxyClassCommand instance.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.