Skip to main content
Drupal API
User account menu
  • Log in

Breadcrumb

  1. Drupal Core 11.1.x
  2. DebugCommand.php

class DebugCommand

Same name in this branch
  1. 11.1.x vendor/symfony/validator/Command/DebugCommand.php \Symfony\Component\Validator\Command\DebugCommand

A console command to debug Serializer information.

@author Loïc Frémont <lc.fremont@gmail.com>

Hierarchy

  • class \Symfony\Component\Console\Command\Command
    • class \Symfony\Component\Serializer\Command\DebugCommand extends \Symfony\Component\Console\Command\Command

Expanded class hierarchy of DebugCommand

File

vendor/symfony/serializer/Command/DebugCommand.php, line 30

Namespace

Symfony\Component\Serializer\Command
View source
class DebugCommand extends Command {
    public function __construct(ClassMetadataFactoryInterface $serializer) {
        parent::__construct();
    }
    protected function configure() : void {
        $this->addArgument('class', InputArgument::REQUIRED, 'A fully qualified class name')
            ->setHelp("The <info>%command.name% 'App\\Entity\\Dummy'</info> command dumps the serializer groups for the dummy class.");
    }
    protected function execute(InputInterface $input, OutputInterface $output) : int {
        $class = $input->getArgument('class');
        if (!class_exists($class)) {
            $io = new SymfonyStyle($input, $output);
            $io->error(\sprintf('Class "%s" was not found.', $class));
            return Command::FAILURE;
        }
        $this->dumpSerializerDataForClass($input, $output, $class);
        return Command::SUCCESS;
    }
    private function dumpSerializerDataForClass(InputInterface $input, OutputInterface $output, string $class) : void {
        $io = new SymfonyStyle($input, $output);
        $title = \sprintf('<info>%s</info>', $class);
        $rows = [];
        $dump = new Dumper($output);
        $classMetadata = $this->serializer
            ->getMetadataFor($class);
        foreach ($this->getAttributesData($classMetadata) as $propertyName => $data) {
            $rows[] = [
                $propertyName,
                $dump($data),
            ];
        }
        $io->section($title);
        if (!$rows) {
            $io->text('No Serializer data were found for this class.');
            return;
        }
        $table = new Table($output);
        $table->setHeaders([
            'Property',
            'Options',
        ]);
        $table->setRows($rows);
        $table->render();
    }
    
    /**
     * @return array<string, array<string, mixed>>
     */
    private function getAttributesData(ClassMetadataInterface $classMetadata) : array {
        $data = [];
        foreach ($classMetadata->getAttributesMetadata() as $attributeMetadata) {
            $data[$attributeMetadata->getName()] = [
                'groups' => $attributeMetadata->getGroups(),
                'maxDepth' => $attributeMetadata->getMaxDepth(),
                'serializedName' => $attributeMetadata->getSerializedName(),
                'serializedPath' => $attributeMetadata->getSerializedPath() ? (string) $attributeMetadata->getSerializedPath() : null,
                'ignore' => $attributeMetadata->isIgnored(),
                'normalizationContexts' => $attributeMetadata->getNormalizationContexts(),
                'denormalizationContexts' => $attributeMetadata->getDenormalizationContexts(),
            ];
        }
        return $data;
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
Command::$aliases private property 1
Command::$application private property
Command::$code private property
Command::$definition private property
Command::$description private property 1
Command::$fullDefinition private property
Command::$help private property
Command::$helperSet private property
Command::$hidden private property
Command::$ignoreValidationErrors private property 2
Command::$name private property
Command::$processTitle private property
Command::$synopsis private property
Command::$usages private property
Command::addArgument public function Adds an argument. 2
Command::addOption public function Adds an option. 2
Command::addUsage public function Add a command usage example, it&#039;ll be prefixed with the command name. 2
Command::complete public function Supplies suggestions when resolving possible completion options for input (e.g. option or argument). 5
Command::FAILURE public constant
Command::getAliases public function Returns the aliases for the command.
Command::getApplication public function Gets the application instance for this command. 2
Command::getDefaultDescription public static function
Command::getDefaultName public static function
Command::getDefinition public function Gets the InputDefinition attached to this Command. 2
Command::getDescription public function Returns the description for the command.
Command::getHelp public function Returns the help for the command. 2
Command::getHelper public function Gets a helper instance by name. 2
Command::getHelperSet public function Gets the helper set. 1
Command::getName public function Returns the command name.
Command::getNativeDefinition public function Gets the InputDefinition to be used to create representations of this Command. 2
Command::getProcessedHelp public function Returns the processed help for the command replacing the %command.name% and
%command.full_name% patterns with the real values dynamically.
2
Command::getSynopsis public function Returns the synopsis for the command. 2
Command::getUsages public function Returns alternative usages of the command. 2
Command::ignoreValidationErrors public function Ignores validation errors. 2
Command::initialize protected function Initializes the command after the input has been bound and before the input
is validated.
4
Command::interact protected function Interacts with the user. 5
Command::INVALID public constant
Command::isEnabled public function Checks whether the command is enabled or not in the current environment. 2
Command::isHidden public function
Command::mergeApplicationDefinition public function Merges the application definition with the command definition. 2
Command::run public function Runs the command. 4
Command::setAliases public function Sets the aliases for the command.
Command::setApplication public function 2
Command::setCode public function Sets the code to execute when running this command. 2
Command::setDefinition public function Sets an array of argument and option instances. 2
Command::setDescription public function Sets the description for the command.
Command::setHelp public function Sets the help for the command. 2
Command::setHelperSet public function 2
Command::setHidden public function
Command::setName public function Sets the name of the command.
Command::setProcessTitle public function Sets the process title of the command. 2
Command::SUCCESS public constant
Command::validateName private function Validates a command name.
DebugCommand::configure protected function Configures the current command. Overrides Command::configure
DebugCommand::dumpSerializerDataForClass private function
DebugCommand::execute protected function Executes the current command. Overrides Command::execute
DebugCommand::getAttributesData private function
DebugCommand::__construct public function Overrides Command::__construct

API Navigation

  • Drupal Core 11.1.x
  • Topics
  • Classes
  • Functions
  • Constants
  • Globals
  • Files
  • Namespaces
  • Deprecated
  • Services
RSS feed
Powered by Drupal