class BlockPluginUI

Same name in this branch
  1. 8.x drupal/core/modules/block/lib/Drupal/block/Plugin/Derivative/BlockPluginUI.php \Drupal\block\Plugin\Derivative\BlockPluginUI
  2. 8.x drupal/core/modules/block/lib/Drupal/block/Plugin/PluginUI/BlockPluginUI.php \Drupal\block\Plugin\PluginUI\BlockPluginUI

Provides block plugin UI plugin definitions for all themes.

@todo Add documentation to this class.

Hierarchy

Expanded class hierarchy of BlockPluginUI

See also

\Drupal\block\Plugin\system\plugin_ui\BlockPluginUI

File

drupal/core/modules/block/lib/Drupal/block/Plugin/Derivative/BlockPluginUI.php, line 18

Namespace

Drupal\block\Plugin\Derivative
View source
class BlockPluginUI implements DerivativeInterface {

  /**
   * List of derivative definitions.
   *
   * @var array
   */
  protected $derivatives = array();

  /**
   * Implements \Drupal\Component\Plugin\Derivative\DerivativeInterface::getDerivativeDefinition().
   *
   * @todo Add documentation to this method.
   */
  public function getDerivativeDefinition($derivative_id, array $base_plugin_definition) {
    if (!empty($this->derivatives) && !empty($this->derivatives[$derivative_id])) {
      return $this->derivatives[$derivative_id];
    }
    $this
      ->getDerivativeDefinitions($base_plugin_definition);
    return $this->derivatives[$derivative_id];
  }

  /**
   * Implements \Drupal\Component\Plugin\Derivative\DerivativeInterface::getDerivativeDefinitions().
   */
  public function getDerivativeDefinitions(array $base_plugin_definition) {

    // Provide a derivative of the plugin UI for each theme.
    foreach (list_themes() as $key => $theme) {
      $this->derivatives[$key] = $base_plugin_definition;
    }
    return $this->derivatives;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
BlockPluginUI::$derivatives protected property List of derivative definitions.
BlockPluginUI::getDerivativeDefinition public function Implements \Drupal\Component\Plugin\Derivative\DerivativeInterface::getDerivativeDefinition(). Overrides DerivativeInterface::getDerivativeDefinition
BlockPluginUI::getDerivativeDefinitions public function Implements \Drupal\Component\Plugin\Derivative\DerivativeInterface::getDerivativeDefinitions(). Overrides DerivativeInterface::getDerivativeDefinitions