class PluginHandler in Database Sanitize 7

Class PluginHandler.

Hierarchy

• class \EdisonLabs\MergeYaml\PluginHandler

1 file declares its use of PluginHandler

PluginHandlerTest.php in vendor/edisonlabs/merge-yaml/tests/src/Unit/PluginHandlerTest.php

File

vendor/edisonlabs/merge-yaml/src/PluginHandler.php, line 11

Namespace

EdisonLabs\MergeYaml

class PluginHandler {

  /**
   * IO object.
   *
   * @var \Composer\IO\IOInterface
   */
  protected $io;

  /**
   * The directory where the merged files will be placed.
   *
   * @var string
   */
  public $outputDir;

  /**
   * The file name patterns to scan for.
   *
   * @var array
   */
  public $fileNamePatterns;

  /**
   * The paths to scan recursively for yaml files.
   *
   * @var array
   */
  public $sourcePaths = array();

  /**
   * Flag indicating whether the plugin has configuration or not.
   *
   * @var bool
   */
  public $isConfigured = false;

  /**
   * {@inheritdoc}
   *
   * @param \Composer\Composer $composer
   *   The Composer object.
   * @param \Composer\IO\IOInterface $io
   *   The IO object.
   * @param array $configParameters
   *   The config parameters to override the extra config from composer.json.
   */
  public function __construct(Composer $composer, IOInterface $io, array $configParameters = array()) {
    $this->io = $io;
    $config = $configParameters;
    if (!$config) {
      $extra = $composer
        ->getPackage()
        ->getExtra();
      if (!isset($extra['merge-yaml'])) {
        return;
      }
      $config = $extra['merge-yaml'];
    }

    // Get files.
    if (empty($config['files'])) {
      throw new \RuntimeException('Please configure merge-yaml files in your composer.json');
    }
    $this->fileNamePatterns = $config['files'];

    // Get locations.
    if (empty($config['locations']) || !is_array($config['locations'])) {
      throw new \RuntimeException('Please configure merge-yaml locations in your composer.json');
    }
    $this->sourcePaths = $config['locations'];

    // Get output dir.
    if (empty($config['output-dir'])) {
      throw new \RuntimeException('Please configure merge-yaml output-dir in your composer.json');
    }
    $this->outputDir = $config['output-dir'];
    $this->isConfigured = true;
  }

  /**
   * Creates the merge files.
   */
  public function createMergeFiles() {
    if (!$this->isConfigured) {
      $this->io
        ->write('> WARNING: merge-yaml is not configured', true);
      return;
    }
    $mergeYaml = new MergeYaml($this->fileNamePatterns, $this->sourcePaths, $this->outputDir);
    $processedFiles = $mergeYaml
      ->createMergeFiles();
    if (empty($processedFiles)) {
      $this->io
        ->write('> merge-yaml: No merge files have been created', true);
      return;
    }
    foreach ($processedFiles as $fileName => $filePaths) {
      foreach ($filePaths as $filePath) {
        $this->io
          ->write("> merge-yaml: Merging {$filePath}", true);
      }
      $outputDir = $this->outputDir;
      $this->io
        ->write("> merge-yaml: Merged in {$outputDir}/{$fileName}.merge.yml", true);
    }
  }

}

Members

Name	Modifiers	Type	Description	Overrides
PluginHandler::$fileNamePatterns	public	property	The file name patterns to scan for.
PluginHandler::$io	protected	property	IO object.
PluginHandler::$isConfigured	public	property	Flag indicating whether the plugin has configuration or not.
PluginHandler::$outputDir	public	property	The directory where the merged files will be placed.
PluginHandler::$sourcePaths	public	property	The paths to scan recursively for yaml files.
PluginHandler::createMergeFiles	public	function	Creates the merge files.
PluginHandler::__construct	public	function