Plugin Class Reference

Inheritance diagram for Plugin:

Public Member Functions
	activate (Composer $composer, IOInterface $io)
	onPackageUnistall (\Composer\Installer\PackageEvent $event)
	onCommandEvent (\Composer\Plugin\CommandEvent $event)
	onNewCodeEvent (\Composer\Script\Event $event)

Static Public Member Functions
static	getSubscribedEvents ()

Protected Member Functions
	initDeployManager (Composer $composer, IOInterface $io)
	copyRecursive ($source, $target)

Protected Attributes
	$io
	$config
	$deployManager
	$composer
	$filesystem

Detailed Description

Definition at line 27 of file Plugin.php.

Member Function Documentation

activate()

activate	(	Composer	$composer,
		IOInterface	$io
	)

Definition at line 84 of file Plugin.php.

    {
        $this->io = $io;
        $this->composer = $composer;
        $this->filesystem = new Filesystem();
        $this->config = new ProjectConfig($composer->getPackage()->getExtra());
        $this->installer = new Installer($io, $composer);
        $this->initDeployManager($composer, $io);
        $this->installer->setDeployManager($this->deployManager);
        $this->installer->setConfig($this->config);
        if ($this->io->isDebug()) {
            $this->io->write('activate magento plugin');
        }
        $composer->getInstallationManager()->addInstaller($this->installer);
    }

copyRecursive()

copyRecursive (   $source,   $target  )

protected

Copy then delete is a non-atomic version of rename.

Some systems can't rename and also don't have proc_open, which requires this solution.

copied from \Composer\Util\Filesystem::copyThenRemove and removed the remove part

Parameters

string	$source
string	$target

Definition at line 283 of file Plugin.php.

    {
        $it = new RecursiveDirectoryIterator($source, RecursiveDirectoryIterator::SKIP_DOTS);
        $ri = new RecursiveIteratorIterator($it, RecursiveIteratorIterator::SELF_FIRST);
        $this->filesystem->ensureDirectoryExists($target);

        foreach ($ri as $file) {
            $targetPath = $target . DIRECTORY_SEPARATOR . $ri->getSubPathName();
            if ($file->isDir()) {
                $this->filesystem->ensureDirectoryExists($targetPath);
            } else {
                copy($file->getPathname(), $targetPath);
            }
        }

    }

getSubscribedEvents()

static getSubscribedEvents ( )

static

Definition at line 100 of file Plugin.php.

    {
        return array(
            PluginEvents::COMMAND => array(
                array('onCommandEvent', 0),
            ),
            ScriptEvents::POST_INSTALL_CMD => array(
                array('onNewCodeEvent', 0),
            ),
            ScriptEvents::POST_UPDATE_CMD => array(
                array('onNewCodeEvent', 0),
            ),
            PackageEvents::POST_PACKAGE_UNINSTALL => array(
                array('onPackageUnistall', 0),
            )
        );
    }

initDeployManager()

initDeployManager ( Composer  $composer, IOInterface  $io  )

protected

Definition at line 73 of file Plugin.php.

    {
        $this->deployManager = new DeployManager($io);

        $extra = $composer->getPackage()->getExtra();
        $sortPriority = isset($extra['magento-deploy-sort-priority']) ? $extra['magento-deploy-sort-priority'] : array();
        $this->deployManager->setSortPriority($sortPriority);

    }

onCommandEvent()

onCommandEvent

(

\Composer\Plugin\CommandEvent

$event

)

actually is triggered before anything got executed

Parameters

\Composer\Plugin\CommandEvent

$event

Definition at line 140 of file Plugin.php.

    {
        $command = $event->getCommandName();
    }

onNewCodeEvent()

onNewCodeEvent

(

\Composer\Script\Event

$event

)

event listener is named this way, as it listens for events leading to changed code files

Parameters

\Composer\Script\Event

$event

Definition at line 150 of file Plugin.php.

    {
        if ($this->io->isDebug()) {
            $this->io->write('start magento deploy via deployManager');
        }

        $this->deployManager->doDeploy();
        $this->deployLibraries();
        $this->saveVendorDirPath($event->getComposer());
        $this->requestRegeneration();
        $this->setFilePermissions();
    }

onPackageUnistall()

onPackageUnistall

(

\Composer\Installer\PackageEvent

$event

)

Definition at line 118 of file Plugin.php.

    {
        $ds = DIRECTORY_SEPARATOR;
        $package = $event->getOperation()->getPackage();
        list($vendor, $packageName) = explode('/', $package->getPrettyName());
        $packageName = trim(str_replace('module-', '', $packageName));
        $packageInstallationPath = $packageInstallationPath = $this->installer->getTargetDir();
        $packagePath = ucfirst($vendor) . $ds . str_replace(' ', '', ucwords(str_replace('-', ' ', $packageName)));
        $this->io->write("Removing $packagePath");
        $libPath = 'lib' . $ds . 'internal' . $ds . $packagePath;
        $magentoPackagePath = 'app' . $ds . 'code' . $ds . $packagePath;
        $deployStrategy = $this->installer->getDeployStrategy($package);
        $deployStrategy->rmdirRecursive($packageInstallationPath . $ds . $libPath);
        $deployStrategy->rmdirRecursive($packageInstallationPath . $ds . $magentoPackagePath);
        $this->requestRegeneration();
    }

Field Documentation

$composer

$composer

protected

Definition at line 51 of file Plugin.php.

$config

$config

protected

Definition at line 39 of file Plugin.php.

$deployManager

$deployManager

protected

Definition at line 45 of file Plugin.php.

$filesystem

$filesystem

protected

Definition at line 61 of file Plugin.php.

$io

$io

protected

Definition at line 33 of file Plugin.php.

---

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

• vendor/magento/magento-composer-installer/src/MagentoHackathon/Composer/Magento/Plugin.php