class SkipOp

Same name and namespace in other branches
  1. 10 composer/Plugin/Scaffold/Operations/SkipOp.php \Drupal\Composer\Plugin\Scaffold\Operations\SkipOp
  2. 11.x composer/Plugin/Scaffold/Operations/SkipOp.php \Drupal\Composer\Plugin\Scaffold\Operations\SkipOp
  3. 8.9.x composer/Plugin/Scaffold/Operations/SkipOp.php \Drupal\Composer\Plugin\Scaffold\Operations\SkipOp

Scaffold operation to skip a scaffold file (do nothing).

@internal

Hierarchy

Expanded class hierarchy of SkipOp

2 files declare their use of SkipOp
ScaffoldFileCollectionTest.php in core/tests/Drupal/Tests/Composer/Plugin/Scaffold/Integration/ScaffoldFileCollectionTest.php
SkipOpTest.php in core/tests/Drupal/Tests/Composer/Plugin/Scaffold/Integration/SkipOpTest.php

File

composer/Plugin/Scaffold/Operations/SkipOp.php, line 14

Namespace

Drupal\Composer\Plugin\Scaffold\Operations
View on git.drupalcode.org
View source 
class SkipOp extends AbstractOperation {
  
  /**
   * Identifies Skip operations.
   */
  const ID = 'skip';
  
  /**
   * The message to output while processing.
   *
   * @var string
   */
  protected $message;
  
  /**
   * SkipOp constructor.
   *
   * @param string $message
   *   (optional) A custom message to output while skipping.
   */
  public function __construct($message = "  - Skip <info>[dest-rel-path]</info>: disabled") {
    $this->message = $message;
  }
  
  /**
   * {@inheritdoc}
   */
  protected function generateContents() {
    return '';
  }
  
  /**
   * {@inheritdoc}
   */
  public function process(ScaffoldFilePath $destination, IOInterface $io, ScaffoldOptions $options) {
    $interpolator = $destination->getInterpolator();
    $io->write($interpolator->interpolate($this->message));
    return new ScaffoldResult($destination, FALSE);
  }

}

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