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

Breadcrumb

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

class PerforceDownloader

@author Matt Whittom <Matt.Whittom@veteransunited.com>

Hierarchy

  • class \Composer\Downloader\VcsDownloader implements \Composer\Downloader\DownloaderInterface, \Composer\Downloader\ChangeReportInterface, \Composer\Downloader\VcsCapableDownloaderInterface
    • class \Composer\Downloader\PerforceDownloader extends \Composer\Downloader\VcsDownloader

Expanded class hierarchy of PerforceDownloader

File

vendor/composer/composer/src/Composer/Downloader/PerforceDownloader.php, line 23

Namespace

Composer\Downloader
View source
class PerforceDownloader extends VcsDownloader {
    
    /** @var Perforce|null */
    protected $perforce;
    
    /**
     * @inheritDoc
     */
    protected function doDownload(PackageInterface $package, string $path, string $url, ?PackageInterface $prevPackage = null) : PromiseInterface {
        return \React\Promise\resolve(null);
    }
    
    /**
     * @inheritDoc
     */
    public function doInstall(PackageInterface $package, string $path, string $url) : PromiseInterface {
        $ref = $package->getSourceReference();
        $label = $this->getLabelFromSourceReference((string) $ref);
        $this->io
            ->writeError('Cloning ' . $ref);
        $this->initPerforce($package, $path, $url);
        $this->perforce
            ->setStream($ref);
        $this->perforce
            ->p4Login();
        $this->perforce
            ->writeP4ClientSpec();
        $this->perforce
            ->connectClient();
        $this->perforce
            ->syncCodeBase($label);
        $this->perforce
            ->cleanupClientSpec();
        return \React\Promise\resolve(null);
    }
    private function getLabelFromSourceReference(string $ref) : ?string {
        $pos = strpos($ref, '@');
        if (false !== $pos) {
            return substr($ref, $pos + 1);
        }
        return null;
    }
    public function initPerforce(PackageInterface $package, string $path, string $url) : void {
        if (!empty($this->perforce)) {
            $this->perforce
                ->initializePath($path);
            return;
        }
        $repository = $package->getRepository();
        $repoConfig = null;
        if ($repository instanceof VcsRepository) {
            $repoConfig = $this->getRepoConfig($repository);
        }
        $this->perforce = Perforce::create($repoConfig, $url, $path, $this->process, $this->io);
    }
    
    /**
     * @return array<string, mixed>
     */
    private function getRepoConfig(VcsRepository $repository) : array {
        return $repository->getRepoConfig();
    }
    
    /**
     * @inheritDoc
     */
    protected function doUpdate(PackageInterface $initial, PackageInterface $target, string $path, string $url) : PromiseInterface {
        return $this->doInstall($target, $path, $url);
    }
    
    /**
     * @inheritDoc
     */
    public function getLocalChanges(PackageInterface $package, string $path) : ?string {
        $this->io
            ->writeError('Perforce driver does not check for local changes before overriding');
        return null;
    }
    
    /**
     * @inheritDoc
     */
    protected function getCommitLogs(string $fromReference, string $toReference, string $path) : string {
        return $this->perforce
            ->getCommitLogs($fromReference, $toReference);
    }
    public function setPerforce(Perforce $perforce) : void {
        $this->perforce = $perforce;
    }
    
    /**
     * @inheritDoc
     */
    protected function hasMetadataRepository(string $path) : bool {
        return true;
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
PerforceDownloader::$perforce protected property @var Perforce|null
PerforceDownloader::doDownload protected function @inheritDoc Overrides VcsDownloader::doDownload
PerforceDownloader::doInstall public function @inheritDoc Overrides VcsDownloader::doInstall
PerforceDownloader::doUpdate protected function @inheritDoc Overrides VcsDownloader::doUpdate
PerforceDownloader::getCommitLogs protected function @inheritDoc Overrides VcsDownloader::getCommitLogs
PerforceDownloader::getLabelFromSourceReference private function
PerforceDownloader::getLocalChanges public function @inheritDoc Overrides ChangeReportInterface::getLocalChanges
PerforceDownloader::getRepoConfig private function
PerforceDownloader::hasMetadataRepository protected function @inheritDoc Overrides VcsDownloader::hasMetadataRepository
PerforceDownloader::initPerforce public function
PerforceDownloader::setPerforce public function
VcsDownloader::$config protected property @var Config
VcsDownloader::$filesystem protected property @var Filesystem
VcsDownloader::$hasCleanedChanges protected property @var array&lt;string, true&gt;
VcsDownloader::$io protected property @var IOInterface
VcsDownloader::$process protected property @var ProcessExecutor
VcsDownloader::cleanChanges protected function Prompt the user to check if changes should be stashed/removed or the operation aborted 2
VcsDownloader::cleanup public function @inheritDoc Overrides DownloaderInterface::cleanup
VcsDownloader::download public function @inheritDoc Overrides DownloaderInterface::download
VcsDownloader::getInstallationSource public function @inheritDoc Overrides DownloaderInterface::getInstallationSource
VcsDownloader::getVcsReference public function @inheritDoc Overrides VcsCapableDownloaderInterface::getVcsReference
VcsDownloader::install public function @inheritDoc Overrides DownloaderInterface::install
VcsDownloader::prepare public function @inheritDoc Overrides DownloaderInterface::prepare
VcsDownloader::prepareUrls private function
VcsDownloader::reapplyChanges protected function Reapply previously stashes changes if applicable, only called after an update (regardless if successful or not) 1
VcsDownloader::remove public function @inheritDoc Overrides DownloaderInterface::remove
VcsDownloader::update public function @inheritDoc Overrides DownloaderInterface::update
VcsDownloader::__construct public function 1

API Navigation

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