class MergeYaml in Database Sanitize 7

Main class for merge-yaml.

Hierarchy

• class \EdisonLabs\MergeYaml\MergeYaml

2 files declare their use of MergeYaml

database_sanitize.inc in inc/database_sanitize.inc

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

File

vendor/edisonlabs/merge-yaml/src/MergeYaml.php, line 12

Namespace

EdisonLabs\MergeYaml

class MergeYaml {

  /**
   * 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;

  /**
   * MergeYaml constructor.
   *
   * @param array  $files
   *   The files patterns.
   * @param array  $locations
   *   The source paths.
   * @param string $outputDir
   *   Path where the merged files will be saved.
   */
  public function __construct(array $files, array $locations, $outputDir) {
    $this->fileNamePatterns = $files;
    $this->sourcePaths = array();
    foreach ($locations as $path) {
      $this->sourcePaths[] = realpath($path);
    }
    $this->outputDir = $outputDir;
  }

  /**
   * Creates the output directory if doesn't exist.
   */
  public function prepareOutputDir() {

    // Check if the output directory exists and try to create it if it doesn't.
    if (!is_dir($this->outputDir) && !mkdir($this->outputDir, 0700)) {
      throw new \RuntimeException(sprintf('Output directory does not exist and it was not able to be created: %s.', $this->outputDir));
    }
  }

  /**
   * Returns the content of the merged yaml files.
   *
   * @param array $filePaths
   *   An array containing the file paths.
   *
   * @return string
   *   The yaml content.
   */
  public function getMergedYmlContent(array $filePaths) {
    $mergedValue = array();
    foreach ($filePaths as $filePath) {
      try {
        $fileContent = file_get_contents($filePath);
        $parsedFile = Yaml::parse($fileContent);
      } catch (ParseException $exception) {
        throw new \RuntimeException(sprintf("Unable to parse the file %s as YAML: %s", $filePath, $exception
          ->getMessage()));
      }
      if (!is_array($parsedFile)) {
        $parsedFile = array();
      }
      $mergedValue = array_merge_recursive($mergedValue, $parsedFile);
    }
    return Yaml::dump($mergedValue, PHP_INT_MAX, 2);
  }

  /**
   * Create the merge files.
   *
   * @return array
   *   Returns the processed files.
   */
  public function createMergeFiles() {

    // Check if the output directory exists and try to create it if it doesn't.
    $this
      ->prepareOutputDir();
    $ymlFilesPaths = $this
      ->getYamlFiles();
    if (empty($ymlFilesPaths)) {

      // No valid Yaml files were found.
      return array();
    }
    foreach ($ymlFilesPaths as $fileName => $filePaths) {
      $outputFileName = $fileName . '.merge.yml';
      $yaml = $this
        ->getMergedYmlContent($filePaths);

      // Save file.
      file_put_contents($this->outputDir . '/' . $outputFileName, $yaml);
    }
    return $ymlFilesPaths;
  }

  /**
   * Gets all yaml files matching fileNamePatterns inside the sourcePaths.
   *
   * @return array
   *   The absolute paths to the valid yaml files.
   */
  public function getYamlFiles() {
    $ymlFiles = array();
    $finder = new Finder();
    $finder
      ->files();
    $finder
      ->followLinks();
    $finder
      ->in($this->sourcePaths);
    $finder
      ->sortByName();
    foreach ($this->fileNamePatterns as $filePattern) {
      $finder
        ->name($filePattern . '.yml');
    }
    if ($finder
      ->count() < 1) {
      return array();
    }
    foreach ($finder as $file) {
      $fileName = str_replace('.yml', '', $file
        ->getFilename());

      /** @var \Symfony\Component\Finder\SplFileInfo $file */
      $ymlFiles[$fileName][] = $file
        ->getRealPath();
    }
    return $ymlFiles;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
MergeYaml::$fileNamePatterns	public	property	The file name patterns to scan for.
MergeYaml::$outputDir	public	property	The directory where the merged files will be placed.
MergeYaml::$sourcePaths	public	property	The paths to scan recursively for yaml files.
MergeYaml::createMergeFiles	public	function	Create the merge files.
MergeYaml::getMergedYmlContent	public	function	Returns the content of the merged yaml files.
MergeYaml::getYamlFiles	public	function	Gets all yaml files matching fileNamePatterns inside the sourcePaths.
MergeYaml::prepareOutputDir	public	function	Creates the output directory if doesn't exist.
MergeYaml::__construct	public	function	MergeYaml constructor.