You are here

Home » API reference » Decoupled Blocks 8 » FrameworkAwareBlockInterface.php

interface FrameworkAwareBlockInterface in Decoupled Blocks 8

Defines the interface for block plugins which expose a front-end component.

Hierarchy

Expanded class hierarchy of FrameworkAwareBlockInterface

All classes that implement FrameworkAwareBlockInterface

1 file declares its use of FrameworkAwareBlockInterface
PdbBlock.php in src/Plugin/Block/PdbBlock.php

File

src/FrameworkAwareBlockInterface.php, line 10

Namespace

Drupal\pdb
View source 
interface FrameworkAwareBlockInterface extends BlockPluginInterface {

  /**
   * Attaches the framework required by the component.
   *
   * @param array $component
   *   The component definition.
   *
   * @return array
   *   Array of attachments.
   */
  public function attachFramework(array $component);

  /**
   * Attaches JavaScript settings required by the component.
   *
   * @param array $component
   *   The component definition.
   *
   * @return array
   *   Array of attachments.
   */
  public function attachSettings(array $component);

  /**
   * Attaches any libraries required by the component.
   *
   * @param array $component
   *   The component definition.
   *
   * @return array
   *   Array of attachments.
   */
  public function attachLibraries(array $component);

  /**
   * Attaches anything the component needs in the HTML <head>.
   *
   * @param array $component
   *   The component definition.
   *
   * @return array
   *   Array of attachments.
   */
  public function attachPageHeader(array $component);

}

Members

Namesort descending Modifiers Type Description Overrides
BlockPluginInterface::access public function Indicates whether the block should be shown.
BlockPluginInterface::blockForm public function Returns the configuration form elements specific to this block plugin.
BlockPluginInterface::blockSubmit public function Adds block type-specific submission handling for the block form.
BlockPluginInterface::blockValidate public function Adds block type-specific validation for the block form.
BlockPluginInterface::BLOCK_LABEL_VISIBLE constant Indicates the block label (title) should be displayed to end users.
BlockPluginInterface::build public function Builds and returns the renderable array for this block plugin. 47
BlockPluginInterface::getMachineNameSuggestion public function Suggests a machine name to identify an instance of this block.
BlockPluginInterface::label public function Returns the user-facing block label.
BlockPluginInterface::setConfigurationValue public function Sets a particular value in the block settings.
CacheableDependencyInterface::getCacheContexts public function The cache contexts associated with this object. 34
CacheableDependencyInterface::getCacheMaxAge public function The maximum age for which this object may be cached. 34
CacheableDependencyInterface::getCacheTags public function The cache tags associated with this object. 27
ConfigurableInterface::defaultConfiguration public function Gets default configuration for this plugin. 11
ConfigurableInterface::getConfiguration public function Gets this plugin's configuration. 12
ConfigurableInterface::setConfiguration public function Sets the configuration for this plugin instance. 12
DependentPluginInterface::calculateDependencies public function Calculates dependencies for the configured plugin. 19
DerivativeInspectionInterface::getBaseId public function Gets the base_plugin_id of the plugin instance. 1
DerivativeInspectionInterface::getDerivativeId public function Gets the derivative_id of the plugin instance. 1
FrameworkAwareBlockInterface::attachFramework public function Attaches the framework required by the component. 1
FrameworkAwareBlockInterface::attachLibraries public function Attaches any libraries required by the component. 1
FrameworkAwareBlockInterface::attachPageHeader public function Attaches anything the component needs in the HTML <head>. 1
FrameworkAwareBlockInterface::attachSettings public function Attaches JavaScript settings required by the component. 1
PluginFormInterface::buildConfigurationForm public function Form constructor. 36
PluginFormInterface::submitConfigurationForm public function Form submission handler. 32
PluginFormInterface::validateConfigurationForm public function Form validation handler. 18
PluginInspectionInterface::getPluginDefinition public function Gets the definition of the plugin implementation. 4
PluginInspectionInterface::getPluginId public function Gets the plugin_id of the plugin instance. 2