SkipOp.php

<?php

namespace Drupal\Composer\Plugin\Scaffold\Operations;

use Composer\IO\IOInterface;
use Drupal\Composer\Plugin\Scaffold\ScaffoldFilePath;
use Drupal\Composer\Plugin\Scaffold\ScaffoldOptions;

/**
 * Scaffold operation to skip a scaffold file (do nothing).
 *
 * @internal
 */
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);
    }

}