XmlConverterCommand Class Reference

Inheritance diagram for XmlConverterCommand:

Public Member Functions
	__construct (Formatter $formatter, DomDocumentFactory $domFactory, XsltProcessorFactory $xsltProcessorFactory)

Data Fields
const	XML_FILE_ARGUMENT = 'xml-file'
const	PROCESSOR_ARGUMENT = 'processor'
const	OVERWRITE_OPTION = 'overwrite'

Protected Member Functions
	configure ()
	execute (InputInterface $input, OutputInterface $output)

Detailed Description

Class XmlConverterCommand Converts XML file using XSL style sheets

Definition at line 22 of file XmlConverterCommand.php.

Constructor & Destructor Documentation

__construct()

__construct	(	Formatter	$formatter,
		DomDocumentFactory	$domFactory,
		XsltProcessorFactory	$xsltProcessorFactory
	)

Inject dependencies

Parameters

Formatter	$formatter
DomDocumentFactory	$domFactory
XsltProcessorFactory	$xsltProcessorFactory

Definition at line 61 of file XmlConverterCommand.php.

      {
        $this->formatter = $formatter;
        $this->domFactory = $domFactory;
        $this->xsltProcessorFactory = $xsltProcessorFactory;

        parent::__construct();
    }

Member Function Documentation

configure()

configure ( )

protected

{}

Definition at line 76 of file XmlConverterCommand.php.

    {
        $this->setName('dev:xml:convert')
            ->setDescription('Converts XML file using XSL style sheets')
            ->setDefinition([
                new InputArgument(
                    self::XML_FILE_ARGUMENT,
                    InputArgument::REQUIRED,
                    'Path to XML file that going to be transformed'
                ),
                new InputArgument(
                    self::PROCESSOR_ARGUMENT,
                    InputArgument::REQUIRED,
                    'Path to XSL style sheet that going to be applied to XML file'
                ),
                new InputOption(
                    self::OVERWRITE_OPTION,
                    '-o',
                    InputOption::VALUE_NONE,
                    'Overwrite XML file'
                ),

            ]);

        parent::configure();
    }

execute()

execute ( InputInterface  $input, OutputInterface  $output  )

protected

{}

Definition at line 106 of file XmlConverterCommand.php.

    {
        try {
            $domXml = $this->domFactory->create();
            $domXsl = $this->domFactory->create();
            $xsltProcessor = $this->xsltProcessorFactory->create();

            $xmlFile = $input->getArgument(self::XML_FILE_ARGUMENT);
            $domXml->preserveWhiteSpace = true;
            $domXml->load($xmlFile);

            $domXsl->preserveWhiteSpace = true;
            $domXsl->load($input->getArgument(self::PROCESSOR_ARGUMENT));

            $xsltProcessor->registerPHPFunctions();
            $xsltProcessor->importStylesheet($domXsl);
            $transformedDoc = $xsltProcessor->transformToXml($domXml);
            $result = $this->formatter->format($transformedDoc);

            if ($input->getOption(self::OVERWRITE_OPTION)) {
                file_put_contents($input->getArgument(self::XML_FILE_ARGUMENT), $result);
                $output->writeln("<info>You saved converted XML into $xmlFile</info>");
            } else {
                $output->write($result);
            }

            return \Magento\Framework\Console\Cli::RETURN_SUCCESS;
        } catch (\Exception $exception) {
            $errorMessage = $exception->getMessage();
            $output->writeln("<error>$errorMessage</error>");
            // we must have an exit code higher than zero to indicate something was wrong
            return \Magento\Framework\Console\Cli::RETURN_FAILURE;
        }
    }

Field Documentation

OVERWRITE_OPTION

const OVERWRITE_OPTION = 'overwrite'

Overwrite option constant

Definition at line 37 of file XmlConverterCommand.php.

PROCESSOR_ARGUMENT

const PROCESSOR_ARGUMENT = 'processor'

Processor argument constant

Definition at line 32 of file XmlConverterCommand.php.

XML_FILE_ARGUMENT

const XML_FILE_ARGUMENT = 'xml-file'

XML file argument name constant

Definition at line 27 of file XmlConverterCommand.php.

---

The documentation for this class was generated from the following file:

• vendor/magento/module-developer/Console/Command/XmlConverterCommand.php