Skip to main content
Drupal API
User account menu
  • Log in

Breadcrumb

  1. Drupal Core 11.1.x
  2. ProjectInstaller.php

class ProjectInstaller

Project Installer is used to install a single package into a directory as root project.

@author Benjamin Eberlei <kontakt@beberlei.de>

Hierarchy

  • class \Composer\Installer\ProjectInstaller implements \Composer\Installer\InstallerInterface

Expanded class hierarchy of ProjectInstaller

1 file declares its use of ProjectInstaller
CreateProjectCommand.php in vendor/composer/composer/src/Composer/Command/CreateProjectCommand.php

File

vendor/composer/composer/src/Composer/Installer/ProjectInstaller.php, line 27

Namespace

Composer\Installer
View source
class ProjectInstaller implements InstallerInterface {
    
    /** @var string */
    private $installPath;
    
    /** @var DownloadManager */
    private $downloadManager;
    
    /** @var Filesystem */
    private $filesystem;
    public function __construct(string $installPath, DownloadManager $dm, Filesystem $fs) {
        $this->installPath = rtrim(strtr($installPath, '\\', '/'), '/') . '/';
        $this->downloadManager = $dm;
        $this->filesystem = $fs;
    }
    
    /**
     * Decides if the installer supports the given type
     */
    public function supports(string $packageType) : bool {
        return true;
    }
    
    /**
     * @inheritDoc
     */
    public function isInstalled(InstalledRepositoryInterface $repo, PackageInterface $package) : bool {
        return false;
    }
    
    /**
     * @inheritDoc
     */
    public function download(PackageInterface $package, ?PackageInterface $prevPackage = null) : ?PromiseInterface {
        $installPath = $this->installPath;
        if (file_exists($installPath) && !$this->filesystem
            ->isDirEmpty($installPath)) {
            throw new \InvalidArgumentException("Project directory {$installPath} is not empty.");
        }
        if (!is_dir($installPath)) {
            mkdir($installPath, 0777, true);
        }
        return $this->downloadManager
            ->download($package, $installPath, $prevPackage);
    }
    
    /**
     * @inheritDoc
     */
    public function prepare($type, PackageInterface $package, ?PackageInterface $prevPackage = null) : ?PromiseInterface {
        return $this->downloadManager
            ->prepare($type, $package, $this->installPath, $prevPackage);
    }
    
    /**
     * @inheritDoc
     */
    public function cleanup($type, PackageInterface $package, ?PackageInterface $prevPackage = null) : ?PromiseInterface {
        return $this->downloadManager
            ->cleanup($type, $package, $this->installPath, $prevPackage);
    }
    
    /**
     * @inheritDoc
     */
    public function install(InstalledRepositoryInterface $repo, PackageInterface $package) : ?PromiseInterface {
        return $this->downloadManager
            ->install($package, $this->installPath);
    }
    
    /**
     * @inheritDoc
     */
    public function update(InstalledRepositoryInterface $repo, PackageInterface $initial, PackageInterface $target) : ?PromiseInterface {
        throw new \InvalidArgumentException("not supported");
    }
    
    /**
     * @inheritDoc
     */
    public function uninstall(InstalledRepositoryInterface $repo, PackageInterface $package) : ?PromiseInterface {
        throw new \InvalidArgumentException("not supported");
    }
    
    /**
     * Returns the installation path of a package
     *
     * @return string configured install path
     */
    public function getInstallPath(PackageInterface $package) : string {
        return $this->installPath;
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title
ProjectInstaller::$downloadManager private property @var DownloadManager
ProjectInstaller::$filesystem private property @var Filesystem
ProjectInstaller::$installPath private property @var string
ProjectInstaller::cleanup public function @inheritDoc Overrides InstallerInterface::cleanup
ProjectInstaller::download public function @inheritDoc Overrides InstallerInterface::download
ProjectInstaller::getInstallPath public function Returns the installation path of a package Overrides InstallerInterface::getInstallPath
ProjectInstaller::install public function @inheritDoc Overrides InstallerInterface::install
ProjectInstaller::isInstalled public function @inheritDoc Overrides InstallerInterface::isInstalled
ProjectInstaller::prepare public function @inheritDoc Overrides InstallerInterface::prepare
ProjectInstaller::supports public function Decides if the installer supports the given type Overrides InstallerInterface::supports
ProjectInstaller::uninstall public function @inheritDoc Overrides InstallerInterface::uninstall
ProjectInstaller::update public function @inheritDoc Overrides InstallerInterface::update
ProjectInstaller::__construct public function

API Navigation

  • Drupal Core 11.1.x
  • Topics
  • Classes
  • Functions
  • Constants
  • Globals
  • Files
  • Namespaces
  • Deprecated
  • Services
RSS feed
Powered by Drupal