ComponentInstaller\Installer Class Reference

Component Installer for Composer. More...

Inheritance diagram for ComponentInstaller\Installer:

Collaboration diagram for ComponentInstaller\Installer:

Public Member Functions
	supports ($packageType)
	getComponentPath (PackageInterface $package)
	Gets the destination Component directory. More...
	getComponentDir ()
	Retrieves the Installer's provided component directory. More...
	removeCode (PackageInterface $package)
	Remove both the installed code and files from the Component directory. More...
	removeComponent (PackageInterface $package)
	Remove a Component's files from the Component directory. More...
	installCode (PackageInterface $package)
	Before installing the Component, be sure its destination is clear first. More...

Protected Member Functions
	initializeVendorDir ()
	Initialize the Component directory, as well as the vendor directory. More...

Protected Attributes
	$componentDir
	The location where Components are to be installed. More...

Detailed Description

Component Installer for Composer.

Definition at line 22 of file Installer.php.

Member Function Documentation

getComponentDir()

ComponentInstaller\Installer::getComponentDir

(

)

Retrieves the Installer's provided component directory.

Definition at line 113 of file Installer.php.

References $config.

    {
        $config = $this->composer->getConfig();
        return $config->has('component-dir') ? $config->get('component-dir') : 'components';
    }

getComponentPath()

ComponentInstaller\Installer::getComponentPath

(

PackageInterface

$package

)

Gets the destination Component directory.

Parameters

PackageInterface

$package

Returns

string The path to where the final Component should be installed.

Definition at line 69 of file Installer.php.

References array.

    {
        // Parse the pretty name for the vendor and package name.
        $name = $prettyName = $package->getPrettyName();
        if (strpos($prettyName, '/') !== false) {
            list($vendor, $name) = explode('/', $prettyName);
            unset($vendor);
        }

        // First look for an override in root package's extra, then try the package's extra
        $rootPackage = $this->composer->getPackage();
        $rootExtras = $rootPackage ? $rootPackage->getExtra() : array();
        $customComponents = isset($rootExtras['component']) ? $rootExtras['component'] : array();

        if (isset($customComponents[$prettyName]) && is_array($customComponents[$prettyName])) {
            $component = $customComponents[$prettyName];
        }
        else {
            $extra = $package->getExtra();
            $component = isset($extra['component']) ? $extra['component'] : array();
        }

        // Allow the component to define its own name.
        if (isset($component['name'])) {
            $name = $component['name'];
        }

        // Find where the package should be located.
        return $this->getComponentDir() . DIRECTORY_SEPARATOR . $name;
    }

initializeVendorDir()

ComponentInstaller\Installer::initializeVendorDir ( )

protected

Initialize the Component directory, as well as the vendor directory.

Definition at line 103 of file Installer.php.

    {
        $this->componentDir = $this->getComponentDir();
        $this->filesystem->ensureDirectoryExists($this->componentDir);
        parent::initializeVendorDir();
    }

installCode()

ComponentInstaller\Installer::installCode

(

PackageInterface

$package

)

Before installing the Component, be sure its destination is clear first.

Parameters

PackageInterface

$package

Definition at line 147 of file Installer.php.

References array.

    {
        $this->removeComponent($package);
        parent::installCode($package);
    }

removeCode()

ComponentInstaller\Installer::removeCode

(

PackageInterface

$package

)

Remove both the installed code and files from the Component directory.

Parameters

PackageInterface

$package

Definition at line 124 of file Installer.php.

    {
        $this->removeComponent($package);
        parent::removeCode($package);
    }

removeComponent()

ComponentInstaller\Installer::removeComponent

(

PackageInterface

$package

)

Remove a Component's files from the Component directory.

Parameters

PackageInterface

$package

Returns

bool

Definition at line 136 of file Installer.php.

References $path.

    {
        $path = $this->getComponentPath($package);
        return $this->filesystem->remove($path);
    }

supports()

ComponentInstaller\Installer::supports

(

$packageType

)

Components are supported by all packages. This checks wheteher or not the entire package is a "component", as well as injects the script to act on components embedded in packages that are not just "component" types.

Definition at line 37 of file Installer.php.

    {
        // Components are supported by all package types. We will just act on
        // the root package's scripts if available.
        $rootPackage = isset($this->composer) ? $this->composer->getPackage() : null;
        if (isset($rootPackage)) {
            // Ensure we get the root package rather than its alias.
            while ($rootPackage instanceof AliasPackage) {
                $rootPackage = $rootPackage->getAliasOf();
            }

            // Make sure the root package can override the available scripts.
            if (method_exists($rootPackage, 'setScripts')) {
                $scripts = $rootPackage->getScripts();
                // Act on the "post-autoload-dump" command so that we can act on all
                // the installed packages.
                $scripts['post-autoload-dump']['component-installer'] = 'ComponentInstaller\\Installer::postAutoloadDump';
                $rootPackage->setScripts($scripts);
            }
        }

        // State support for "component" package types.
        return $packageType == 'component';
    }

Field Documentation

$componentDir

ComponentInstaller\Installer::$componentDir

protected

The location where Components are to be installed.

Definition at line 28 of file Installer.php.

---

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

• libs/composer/vendor/robloach/component-installer/src/ComponentInstaller/Installer.php