Builder Class Reference

Inheritance diagram for Builder:

Public Member Functions
	__construct (ParserInterface $dependenciesParser, WriterInterface $reportWriter, ParserInterface $configParser)
Public Member Functions inherited from AbstractBuilder
	__construct (ParserInterface $dependenciesParser, WriterInterface $reportWriter)
	build (array $options)

Protected Member Functions
	checkOptions ($options)
	buildData ($modulesData)
	getAllowedModules ()
Protected Member Functions inherited from AbstractBuilder
	checkOptions ($options)
	buildData ($modulesData)

Protected Attributes
	$configParser
Protected Attributes inherited from AbstractBuilder
	$dependenciesParser
	$reportWriter
	$options = []

Detailed Description

Framework dependencies report builder

Definition at line 15 of file Builder.php.

Constructor & Destructor Documentation

__construct()

__construct	(	ParserInterface	$dependenciesParser,
		WriterInterface	$reportWriter,
		ParserInterface	$configParser
	)

Builder constructor

Parameters

ParserInterface	$dependenciesParser
WriterInterface	$reportWriter
ParserInterface	$configParser

Definition at line 31 of file Builder.php.

      {
        parent::__construct($dependenciesParser, $reportWriter);

        $this->configParser = $configParser;
    }

Member Function Documentation

buildData()

buildData (   $modulesData )

protected

Template method. Prepare data for writer step

Parameters

array

$modulesData

Returns

\Magento\Setup\Module\Dependency\Report\Framework\Data\Config

Definition at line 63 of file Builder.php.

    {
        $allowedModules = $this->getAllowedModules();

        $modules = [];
        foreach ($modulesData as $moduleData) {
            $dependencies = [];
            foreach ($moduleData['dependencies'] as $dependencyData) {
                if (!in_array($dependencyData['lib'], $allowedModules)) {
                    $dependencies[] = new Data\Dependency($dependencyData['lib'], $dependencyData['count']);
                }
            }
            $modules[] = new Data\Module($moduleData['name'], $dependencies);
        }
        return new Data\Config($modules);
    }

checkOptions()

checkOptions (   $options )

protected

Template method. Check passed options step

Parameters

array

$options

Returns

void

Exceptions

Definition at line 48 of file Builder.php.

    {
        parent::checkOptions($options);

        if (!isset($options['parse']['config_files']) || empty($options['parse']['config_files'])) {
            throw new \InvalidArgumentException('Parse error. Passed option "config_files" is wrong.');
        }
    }

getAllowedModules()

getAllowedModules ( )

protected

Get allowed modules

Returns

array

Definition at line 85 of file Builder.php.

    {
        return $this->configParser->parse(['files_for_parse' => $this->options['parse']['config_files']]);
    }

Field Documentation

$configParser

$configParser

protected

Definition at line 22 of file Builder.php.

---

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

• vendor/magento/magento2-base/setup/src/Magento/Setup/Module/Dependency/Report/Framework/Builder.php