DrupalInstalledTemplate.php

Namespace

Drupal\Composer\Plugin\Scaffold

File

composer/Plugin/Scaffold/DrupalInstalledTemplate.php

View source
<?php

namespace Drupal\Composer\Plugin\Scaffold;

use Composer\Package\PackageInterface;
use Composer\Repository\InstalledRepositoryInterface;

/**
 * Produces code for the DrupalInstalled file.
 *
 * @internal
 */
class DrupalInstalledTemplate {
  
  /**
   * Gets the code for the DrupalInstalled class.
   *
   * @param \Composer\Package\PackageInterface $root_package
   *   The root package.
   * @param \Composer\Repository\InstalledRepositoryInterface $repository
   *   The local installed repository.
   *
   * @return string
   *   The PHP code to write to the DrupalInstalled class.
   */
  public static function getCode(PackageInterface $root_package, InstalledRepositoryInterface $repository) : string {
    // Write out a hash of the version information to a file so we can use it.
    $versions = array_reduce($repository->getPackages(), fn(string $carry, PackageInterface $package) => $carry . $package->getUniqueName() . '-' . $package->getSourceReference() . '|', '');
    // Add the root_package package version info so custom code changes and root_package
    // package version changes result in the hash changing.
    $versions .= $root_package->getUniqueName() . '-' . $root_package->getSourceReference();
    $version_hash = hash('xxh3', $versions);
    return <<<EOF
    <?php
    
    namespace Drupal;
    
    /**
     * A class containing information determined during composer installation.
     *
     * This file is generated automatically by the
     * drupal/core-composer-scaffold Composer plugin, and should not be
     * edited.
     *
     * @see \\Drupal\\Composer\\Plugin\\Scaffold\\Plugin::preAutoloadDump()
     */
    class DrupalInstalled {
    
      /**
       * A hash of all the installed packages and their versions.
       */
      public const string VERSIONS_HASH = '{<span class="php-variable">$version_hash</span>}';
    
    }
    
    EOF;
  }

}

Classes

Title Deprecated Summary
DrupalInstalledTemplate Produces code for the DrupalInstalled file.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.