RequireUpdateDryRunCommand Class Reference

Public Member Functions
	__construct (MagentoComposerApplication $magentoComposerApplication, InfoCommand $infoCommand)
	run ($packages, $workingDir=null)

Protected Member Functions
	generateAdditionalErrorMessage ($message, $inputPackages)
	explodePackagesAndVersions ($packages)

Protected Attributes
	$magentoComposerApplication
	$infoCommand

Detailed Description

Class RequireUpdateDryRunCommand calls composer require and update –dry-run commands

Definition at line 12 of file RequireUpdateDryRunCommand.php.

Constructor & Destructor Documentation

__construct()

__construct	(	MagentoComposerApplication	$magentoComposerApplication,
		InfoCommand	$infoCommand
	)

Constructor

Parameters

MagentoComposerApplication	$magentoComposerApplication
InfoCommand	$infoCommand

Definition at line 30 of file RequireUpdateDryRunCommand.php.

      {
        $this->magentoComposerApplication = $magentoComposerApplication;
        $this->infoCommand = $infoCommand;
    }

Member Function Documentation

explodePackagesAndVersions()

explodePackagesAndVersions (   $packages )

protected

Returns array that contains package as key and version as value

Parameters

array

$packages

Returns

array

Definition at line 143 of file RequireUpdateDryRunCommand.php.

    {
        $packagesAndVersions = [];
        foreach ($packages as $package) {
            $package = explode(' ', $package);
            $packagesAndVersions[$package[0]] = $package[1];
        }

        return $packagesAndVersions;
    }

generateAdditionalErrorMessage()

generateAdditionalErrorMessage (   $message,   $inputPackages  )

protected

Generates additional explanation for error message

Parameters

array	$message
array	$inputPackages

Returns

string

Definition at line 79 of file RequireUpdateDryRunCommand.php.

    {
        $matches  = [];
        $errorMessage = '';
        $packages = [];
        $rawLines = explode(PHP_EOL, $message);

        foreach ($rawLines as $line) {
            if (preg_match('/- (.*) requires (.*) -> no matching package/', $line, $matches)) {
                $packages[] = $matches[1];
                $packages[] = $matches[2];
            }
        }

        if (!empty($packages)) {
            $packages = array_unique($packages);
            $packages = $this->explodePackagesAndVersions($packages);
            $inputPackages = $this->explodePackagesAndVersions($inputPackages);

            $update = [];
            $conflicts = [];

            foreach ($inputPackages as $package => $version) {
                if (isset($packages[$package])) {
                    $update[] = $package . ' to ' . $version;
                }
            }

            foreach (array_diff_key($packages, $inputPackages) as $package => $version) {

                if (!$packageInfo = $this->infoCommand->run($package, true)) {
                    return false;
                }

                $currentVersion = $packageInfo[InfoCommand::CURRENT_VERSION];

                if (empty($packageInfo[InfoCommand::AVAILABLE_VERSIONS])) {
                    $packageInfo = $this->infoCommand->run($package);
                    if (empty($packageInfo[InfoCommand::AVAILABLE_VERSIONS])) {
                        return false;
                    }
                }

                $conflicts[] = ' - ' . $package . ' version ' . $currentVersion . '. '
                    . 'Please try to update it to one of the following package versions: '
                    . implode(', ', $packageInfo['available_versions']);
            }

            $errorMessage = 'You are trying to update package(s) '
                . implode(', ', $update) . PHP_EOL
                . "We've detected conflicts with the following packages:" . PHP_EOL
                . implode(PHP_EOL, $conflicts)
                . PHP_EOL;
        }

        return $errorMessage;
    }

run()

run	(		$packages,
			$workingDir = null
	)

Runs composer update –dry-run command

Parameters

array	$packages
string | null	$workingDir

Returns

string

Exceptions

Definition at line 46 of file RequireUpdateDryRunCommand.php.

    {
        try {
            // run require
            $this->magentoComposerApplication->runComposerCommand(
                ['command' => 'require', 'packages' => $packages, '--no-update' => true],
                $workingDir
            );

            $output = $this->magentoComposerApplication->runComposerCommand(
                ['command' => 'update', '--dry-run' => true],
                $workingDir
            );
        } catch (\RuntimeException $e) {
            $errorMessage = $this->generateAdditionalErrorMessage($e->getMessage(), $packages);
            if ($errorMessage) {
                throw new \RuntimeException($errorMessage, $e->getCode(), $e);
            } else {
                throw new \RuntimeException($e->getMessage(), $e->getCode(), $e);
            }

        }

        return $output;
    }

Field Documentation

$infoCommand

$infoCommand

protected

Definition at line 22 of file RequireUpdateDryRunCommand.php.

$magentoComposerApplication

$magentoComposerApplication

protected

Definition at line 17 of file RequireUpdateDryRunCommand.php.

---

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

• vendor/magento/composer/src/RequireUpdateDryRunCommand.php