Xml Class Reference

Inheritance diagram for Xml:

Public Member Functions
	__construct (FileSystem $filesystem, TemplateEnginePool $templateEnginePool, Generator $generator)
	render (UiComponentInterface $view, $template='')
Public Member Functions inherited from AbstractContentType
	__construct (FileSystem $filesystem, TemplateEnginePool $templateEnginePool)

Protected Member Functions
	getDataXml (UiComponentInterface $view)
	objectToXml (\Magento\Framework\DataObject $object)

Protected Attributes
	$filesystem
	$templateEnginePool
	$generator
Protected Attributes inherited from AbstractContentType
	$filesystem
	$templateEnginePool

Detailed Description

Class Xml

Definition at line 16 of file Xml.php.

Constructor & Destructor Documentation

__construct()

__construct	(	FileSystem	$filesystem,
		TemplateEnginePool	$templateEnginePool,
		Generator	$generator
	)

Constructor

Parameters

FileSystem	$filesystem
TemplateEnginePool	$templateEnginePool
Generator	$generator

Definition at line 40 of file Xml.php.

      {
        $this->generator = $generator;
        parent::__construct($filesystem, $templateEnginePool);
    }

Member Function Documentation

getDataXml()

getDataXml ( UiComponentInterface  $view )

protected

Parameters

UiComponentInterface

$view

Returns

string

Definition at line 78 of file Xml.php.

    {
        $result = [
            'configuration' => $view->getRenderContext()->getStorage()->getComponentsData($view->getName())->getData(),
            'data' => [],
        ];
        foreach ($view->getRenderContext()->getStorage()->getData($view->getName()) as $key => $value) {
            if (is_object($value)) {
                if (method_exists($value, 'toXml')) {
                    $result['data'][$key] = $value->toXml();
                } else {
                    $result['data'][$key] = $this->objectToXml($value);
                }
            } else {
                $result['data'][$key] = $value;
            }
        }
        return $this->generator->arrayToXml($result);
    }

objectToXml()

objectToXml ( \Magento\Framework\DataObject  $object )

protected

Convert object to xml format

Parameters

\Magento\Framework\DataObject

$object

Returns

string

Definition at line 104 of file Xml.php.

    {
        return (string)$object;
    }

render()

render	(	UiComponentInterface	$view,
			$template = ''
	)

Render data

Parameters

UiComponentInterface	$view
string	$template

Returns

string

Exceptions

Implements ContentTypeInterface.

Definition at line 57 of file Xml.php.

    {
        $templateEngine = false;
        if ($template) {
            $extension = pathinfo($template, PATHINFO_EXTENSION);
            $templateEngine = $this->templateEnginePool->get($extension);
        }
        if ($templateEngine) {
            $path = $this->filesystem->getTemplateFileName($template);
            $result = $templateEngine->render($view, $path);
        } else {
            $result = $this->getDataXml($view);
        }

        throw new \Exception('Please implement XML renderer');
    }

Field Documentation

$filesystem

$filesystem

protected

Definition at line 21 of file Xml.php.

$generator

$generator

protected

Definition at line 31 of file Xml.php.

$templateEnginePool

$templateEnginePool

protected

Definition at line 26 of file Xml.php.

---

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

• vendor/magento/framework/View/Element/UiComponent/ContentType/Xml.php