class ManageOptions in Drupal 8

Per-project options from the 'extras' section of the composer.json file.

Projects that describe scaffold files do so via their scaffold options. This data is pulled from the 'drupal-scaffold' portion of the extras section of the project data.

@internal

Hierarchy

• class \Drupal\Composer\Plugin\Scaffold\ManageOptions

File

composer/Plugin/Scaffold/ManageOptions.php, line 18

Namespace

Drupal\Composer\Plugin\Scaffold

class ManageOptions {

  /**
   * The Composer service.
   *
   * @var \Composer\Composer
   */
  protected $composer;

  /**
   * ManageOptions constructor.
   *
   * @param \Composer\Composer $composer
   *   The Composer service.
   */
  public function __construct(Composer $composer) {
    $this->composer = $composer;
  }

  /**
   * Gets the root-level scaffold options for this project.
   *
   * @return \Drupal\Composer\Plugin\Scaffold\ScaffoldOptions
   *   The scaffold options object.
   */
  public function getOptions() {
    return $this
      ->packageOptions($this->composer
      ->getPackage());
  }

  /**
   * Gets the scaffold options for the stipulated project.
   *
   * @param \Composer\Package\PackageInterface $package
   *   The package to fetch the scaffold options from.
   *
   * @return \Drupal\Composer\Plugin\Scaffold\ScaffoldOptions
   *   The scaffold options object.
   */
  public function packageOptions(PackageInterface $package) {
    return ScaffoldOptions::create($package
      ->getExtra());
  }

  /**
   * Creates an interpolator for the 'locations' element.
   *
   * The interpolator returned will replace a path string with the tokens
   * defined in the 'locations' element.
   *
   * Note that only the root package may define locations.
   *
   * @return \Drupal\Composer\Plugin\Scaffold\Interpolator
   *   Interpolator that will do replacements in a string using tokens in
   *   'locations' element.
   */
  public function getLocationReplacements() {
    return (new Interpolator())
      ->setData($this
      ->ensureLocations());
  }

  /**
   * Ensures that all of the locations defined in the scaffold files exist.
   *
   * Create them on the filesystem if they do not.
   */
  protected function ensureLocations() {
    $fs = new Filesystem();
    $locations = $this
      ->getOptions()
      ->locations() + [
      'web_root' => './',
    ];
    $locations = array_map(function ($location) use ($fs) {
      $fs
        ->ensureDirectoryExists($location);
      $location = realpath($location);
      return $location;
    }, $locations);
    return $locations;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ManageOptions::$composer	protected	property	The Composer service.
ManageOptions::ensureLocations	protected	function	Ensures that all of the locations defined in the scaffold files exist.
ManageOptions::getLocationReplacements	public	function	Creates an interpolator for the 'locations' element.
ManageOptions::getOptions	public	function	Gets the root-level scaffold options for this project.
ManageOptions::packageOptions	public	function	Gets the scaffold options for the stipulated project.
ManageOptions::__construct	public	function	ManageOptions constructor.