You are here

ConfigurableInterface.php in Drupal 8

Same filename and directory in other branches
  1. 9 core/lib/Drupal/Component/Plugin/ConfigurableInterface.php

File

core/lib/Drupal/Component/Plugin/ConfigurableInterface.php
View source
<?php

namespace Drupal\Component\Plugin;


/**
 * Provides an interface for a configurable plugin.
 *
 * @ingroup plugin_api
 */
interface ConfigurableInterface {

  /**
   * Gets this plugin's configuration.
   *
   * @return array
   *   An array of this plugin's configuration.
   */
  public function getConfiguration();

  /**
   * Sets the configuration for this plugin instance.
   *
   * @param array $configuration
   *   An associative array containing the plugin's configuration.
   */
  public function setConfiguration(array $configuration);

  /**
   * Gets default configuration for this plugin.
   *
   * @return array
   *   An associative array with the default configuration.
   */
  public function defaultConfiguration();

}

Interfaces

Namesort descending Description
ConfigurableInterface Provides an interface for a configurable plugin.