Xml Class Reference

Inheritance diagram for Xml:

Public Member Functions
	parse (array $options)

Protected Member Functions
	checkOptions ($options)
	extractModuleName ($config)
	getModuleConfig ($file)
	prepareModuleName ($name)

Detailed Description

Config xml parser

Definition at line 13 of file Xml.php.

Member Function Documentation

checkOptions()

checkOptions (   $options )

protected

Template method. Check passed options step

Parameters

array

$options

Returns

void

Exceptions

Definition at line 39 of file Xml.php.

    {
        if (!isset(
            $options['files_for_parse']
        ) || !is_array(
            $options['files_for_parse']
        ) || !$options['files_for_parse']
        ) {
            throw new \InvalidArgumentException('Parse error: Option "files_for_parse" is wrong.');
        }
    }

extractModuleName()

extractModuleName (   $config )

protected

Template method. Extract module step

Parameters

\SimpleXMLElement

$config

Returns

string

Definition at line 57 of file Xml.php.

    {
        return $this->prepareModuleName((string)$config->attributes()->name);
    }

getModuleConfig()

getModuleConfig (   $file )

protected

Template method. Load module config step

Parameters

string

$file

Returns

\SimpleXMLElement

Definition at line 68 of file Xml.php.

    {
        return \simplexml_load_file($file)->xpath('/config/module')[0];
    }

parse()

parse

(

array

$options

)

Template method. Main algorithm

{Parse files

Parameters

array

$options

Returns

array

}

Implements ParserInterface.

Definition at line 20 of file Xml.php.

    {
        $this->checkOptions($options);

        $modules = [];
        foreach ($options['files_for_parse'] as $file) {
            $config = $this->getModuleConfig($file);
            $modules[] = $this->extractModuleName($config);
        }
        return $modules;
    }

prepareModuleName()

prepareModuleName (   $name )

protected

Prepare module name

Parameters

string

$name

Returns

string

Definition at line 79 of file Xml.php.

    {
        return str_replace('_', '\\', $name);
    }

---

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

• vendor/magento/magento2-base/setup/src/Magento/Setup/Module/Dependency/Parser/Config/Xml.php