core/lib/Drupal/Core/Plugin/ObjectWithPluginCollectionInterface.php


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26

<?php

namespace Drupal\Core\Plugin;

/**
 * Provides an interface for an object using a plugin collection.
 *
 * @see \Drupal\Component\Plugin\LazyPluginCollection
 *
 * @ingroup plugin_api
 *
 * Entities that need this interface should implement
 * \Drupal\Core\Entity\EntityWithPluginCollectionInterface, which extends this.
 */
interface ObjectWithPluginCollectionInterface {

  /**
   * Gets the plugin collections used by this object.
   *
   * @return \Drupal\Component\Plugin\LazyPluginCollection[]
   *   An array of plugin collections, keyed by the property name they use to
   *   store their configuration.
   */
  public function getPluginCollections();

}