interface BuilderInterface

Same name in other branches
  1. 9 composer/Generator/BuilderInterface.php \Drupal\Composer\Generator\BuilderInterface
  2. 8.9.x composer/Generator/BuilderInterface.php \Drupal\Composer\Generator\BuilderInterface
  3. 10 composer/Generator/BuilderInterface.php \Drupal\Composer\Generator\BuilderInterface

Produce the output for a metapackage.

BuilderInterface provides an interface for builder classes which are called by the PackageGenerator in order to produce a derived metapackage from the provided source package.

See the README.txt file in composer/Metapackage for a description of what a metapackage is, and an explanation of the metapackages produced by the generator.

Hierarchy

Expanded class hierarchy of BuilderInterface

All classes that implement BuilderInterface

1 file declares its use of BuilderInterface
DrupalPackageBuilder.php in composer/Generator/Builder/DrupalPackageBuilder.php

File

composer/Generator/BuilderInterface.php, line 18

Namespace

Drupal\Composer\Generator
View source 
interface BuilderInterface {
    
    /**
     * BuilderInterface constructor.
     *
     * @param \Drupal\Composer\Generator\Util\DrupalCoreComposer $drupalCoreInfo
     *   Information about the composer.json, composer.lock, and repository path.
     */
    public function __construct(DrupalCoreComposer $drupalCoreInfo);
    
    /**
     * Return the path to where the metapackage should be written.
     *
     * @return string
     *   Path to the metapackage.
     */
    public function getPath();
    
    /**
     * Generate the Composer.json data for the current tag or branch.
     *
     * @return array
     *   Composer json data.
     */
    public function getPackage();

}

Members

Title Modifiers Object type Summary Overrides
BuilderInterface::getPackage public function Generate the Composer.json data for the current tag or branch. 3
BuilderInterface::getPath public function Return the path to where the metapackage should be written. 3
BuilderInterface::__construct public function BuilderInterface constructor. 1

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