DirectoryWithMetadataPluginDiscovery.php

Same filename and directory in other branches
  1. 11.x core/lib/Drupal/Core/Plugin/Discovery/DirectoryWithMetadataPluginDiscovery.php
  2. 10 core/lib/Drupal/Core/Plugin/Discovery/DirectoryWithMetadataPluginDiscovery.php

Namespace

Drupal\Core\Plugin\Discovery

File

core/lib/Drupal/Core/Plugin/Discovery/DirectoryWithMetadataPluginDiscovery.php

View source
<?php

namespace Drupal\Core\Plugin\Discovery;

use Drupal\Core\File\FileSystemInterface;

/**
 * Discover directories that contain a specific metadata file.
 */
class DirectoryWithMetadataPluginDiscovery extends YamlDiscovery {
  
  /**
   * Constructs a DirectoryWithMetadataPluginDiscovery object.
   *
   * @param array $directories
   *   An array of directories to scan, keyed by the provider. The value can
   *   either be a string or an array of strings. The string values should be
   *   the path of a directory to scan.
   * @param string $file_cache_key_suffix
   *   The file cache key suffix. This should be unique for each type of
   *   discovery.
   * @param \Drupal\Core\File\FileSystemInterface|null $file_system
   *   The file system service.
   */
  public function __construct(array $directories, $file_cache_key_suffix, ?FileSystemInterface $file_system = NULL) {
    // Intentionally does not call parent constructor as this class uses a
    // different YAML discovery.
    if ($file_system) {
      @trigger_error(sprintf('Passing the $fileSystem parameter to %s() is deprecated in drupal:11.3.0 and is removed from drupal:12.0.0. The class no longer uses the file system service. See https://www.drupal.org/node/3530869', __METHOD__), E_USER_DEPRECATED);
    }
    $this->discovery = new DirectoryWithMetadataDiscovery($directories, $file_cache_key_suffix);
  }

}

Classes

Title Deprecated Summary
DirectoryWithMetadataPluginDiscovery Discover directories that contain a specific metadata file.

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