MagentoComposerApplication Class Reference

Public Member Functions
	__construct ( $pathToComposerHome, $pathToComposerJson, Application $consoleApplication=null, ConsoleArrayInputFactory $consoleArrayInputFactory=null, BufferedOutput $consoleOutput=null)
	createComposer ()
	runComposerCommand (array $commandParams, $workingDir=null)

Data Fields
const	COMPOSER_WORKING_DIR = '--working-dir'

Detailed Description

Class MagentoComposerApplication

This class provides ability to set composer application settings and run any composer command. Also provides method to get Composer instance so you can have access composer properties lie Locker

Definition at line 20 of file MagentoComposerApplication.php.

Constructor & Destructor Documentation

__construct()

__construct	(		$pathToComposerHome,
			$pathToComposerJson,
		Application	$consoleApplication = null,
		ConsoleArrayInputFactory	$consoleArrayInputFactory = null,
		BufferedOutput	$consoleOutput = null
	)

Constructs class

Parameters

string	$pathToComposerHome
string	$pathToComposerJson
Application	$consoleApplication
ConsoleArrayInputFactory	$consoleArrayInputFactory
BufferedOutput	$consoleOutput

Definition at line 65 of file MagentoComposerApplication.php.

      {
        $this->consoleApplication = $consoleApplication ? $consoleApplication : new Application();
        $this->consoleArrayInputFactory = $consoleArrayInputFactory ? $consoleArrayInputFactory
            : new ConsoleArrayInputFactory();
        $this->consoleOutput = $consoleOutput ? $consoleOutput : new BufferedOutput();

        $this->composerJson = $pathToComposerJson;
        $this->composerHome = $pathToComposerHome;

        putenv('COMPOSER_HOME=' . $pathToComposerHome);

        $this->consoleApplication->setAutoExit(false);
    }

Member Function Documentation

createComposer()

createComposer

(

)

Creates composer object

Returns

\Composer\Composer

Exceptions

Definition at line 91 of file MagentoComposerApplication.php.

    {
        return ComposerFactory::create(new BufferIO(), $this->composerJson);
    }

runComposerCommand()

runComposerCommand	(	array	$commandParams,
			$workingDir = null
	)

Runs composer command

Parameters

array	$commandParams
string | null	$workingDir

Returns

bool

Exceptions

Definition at line 104 of file MagentoComposerApplication.php.

    {
        $this->consoleApplication->resetComposer();

        if ($workingDir) {
            $commandParams[self::COMPOSER_WORKING_DIR] = $workingDir;
        } else {
            $commandParams[self::COMPOSER_WORKING_DIR] = dirname($this->composerJson);
        }

        $input = $this->consoleArrayInputFactory->create($commandParams);

        $exitCode = $this->consoleApplication->run($input, $this->consoleOutput);

        if ($exitCode) {
            throw new \RuntimeException(
                sprintf('Command "%s" failed: %s', $commandParams['command'], $this->consoleOutput->fetch())
            );
        }

        return $this->consoleOutput->fetch();
    }

Field Documentation

COMPOSER_WORKING_DIR

const COMPOSER_WORKING_DIR = '--working-dir'

Definition at line 23 of file MagentoComposerApplication.php.

---

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

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