You are here

class DropdownWithInclude in Block Style Plugins 8

Same name and namespace in other branches
  1. 8.2 tests/modules/block_style_plugins_test/src/Plugin/BlockStyle/DropdownWithInclude.php \Drupal\block_style_plugins_test\Plugin\BlockStyle\DropdownWithInclude

Demonstrate using the 'include' parameter.

Provides a 'DropdownWithInclude' block style for only adding styles to the "Powered by Drupal" block.

Plugin annotation


@BlockStyle(
 id = "dropdown_with_include",
 label = @Translation("Dropdown with Include"),
 include = {
   "system_powered_by_block",
   "basic",
 }
)

Hierarchy

Expanded class hierarchy of DropdownWithInclude

File

tests/modules/block_style_plugins_test/src/Plugin/BlockStyle/DropdownWithInclude.php, line 23

Namespace

Drupal\block_style_plugins_test\Plugin\BlockStyle
View source
class DropdownWithInclude extends BlockStyleBase {

  /**
   * {@inheritdoc}
   */
  public function defaultConfiguration() {

    // Default this to the third option.
    return [
      'dropdown_class' => 'style-3',
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function buildConfigurationForm(array $form, FormStateInterface $form_state) {

    // The value of the options should be the class name which will be applied.
    $elements['dropdown_class'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Choose a style from the dropdown'),
      '#options' => [
        'style-1' => $this
          ->t('Style 1'),
        'style-2' => $this
          ->t('Style 2'),
        'style-3' => $this
          ->t('Style 3'),
      ],
      '#default_value' => $this->configuration['dropdown_class'],
    ];
    return $elements;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
BlockStyleBase::$blockContentBundle protected property Bundle type for 'Block Content' blocks.
BlockStyleBase::$blockPlugin protected property Plugin instance for the Block being configured.
BlockStyleBase::$entityRepository protected property Instance of the Entity Repository service.
BlockStyleBase::$entityTypeManager protected property Instance of the Entity Type Manager service.
BlockStyleBase::$pluginId protected property Plugin ID for the Block being configured. Overrides PluginBase::$pluginId
BlockStyleBase::$styles Deprecated protected property Style settings for the block styles.
BlockStyleBase::baseIdMatch protected function Determine if a plugin ID matches a Base ID in a list of include/exclude.
BlockStyleBase::build public function Builds and returns the renderable array for this block style plugin. Overrides BlockStyleInterface::build
BlockStyleBase::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
BlockStyleBase::defaultStyles Deprecated public function Gets default style configuration for this plugin.
BlockStyleBase::exclude public function Exclude styles from appearing on a block. Overrides BlockStyleInterface::exclude
BlockStyleBase::formAlter Deprecated public function Overrides BlockStyleInterface::formAlter
BlockStyleBase::formElements Deprecated public function Returns an array of field elements.
BlockStyleBase::getConfiguration public function Gets this plugin's configuration. Overrides ConfigurableInterface::getConfiguration
BlockStyleBase::getStyles Deprecated public function Gets this plugin's style configuration.
BlockStyleBase::getStylesFromVariables protected function Get styles for a block set in a preprocess $variables array.
BlockStyleBase::includeOnly public function Only show styles on specific blocks. Overrides BlockStyleInterface::includeOnly
BlockStyleBase::prepareForm public function Returns the configuration form elements specific to a block configuration. Overrides BlockStyleInterface::prepareForm
BlockStyleBase::setBlockContentBundle public function Set the block content bundle type.
BlockStyleBase::setConfiguration public function Sets the configuration for this plugin instance. Overrides ConfigurableInterface::setConfiguration
BlockStyleBase::setStyles Deprecated public function Sets the style configuration for this plugin instance.
BlockStyleBase::submitConfigurationForm public function Form submission handler. Overrides PluginFormInterface::submitConfigurationForm
BlockStyleBase::submitForm Deprecated public function Overrides BlockStyleInterface::submitForm
BlockStyleBase::themeSuggestion public function Add theme suggestions for the block. Overrides BlockStyleInterface::themeSuggestion 1
BlockStyleBase::validateConfigurationForm public function Form validation handler. Overrides PluginFormInterface::validateConfigurationForm
BlockStyleBase::validateForm Deprecated public function Adds block style specific validation handling for the block form.
BlockStyleBase::__construct public function Construct method for BlockStyleBase. Overrides PluginBase::__construct
DependencySerializationTrait::$_entityStorages protected property An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds protected property An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep public function 1
DependencySerializationTrait::__wakeup public function 2
DropdownWithInclude::buildConfigurationForm public function Form constructor. Overrides BlockStyleBase::buildConfigurationForm
DropdownWithInclude::defaultConfiguration public function Gets default configuration for this plugin. Overrides BlockStyleBase::defaultConfiguration
MessengerTrait::$messenger protected property The messenger. 29
MessengerTrait::messenger public function Gets the messenger. 29
MessengerTrait::setMessenger public function Sets the messenger.
PluginBase::$configuration protected property Configuration information passed into the plugin. 1
PluginBase::$pluginDefinition protected property The plugin implementation definition. 1
PluginBase::DERIVATIVE_SEPARATOR constant A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId public function Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId public function Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition public function Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition 3
PluginBase::getPluginId public function Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable public function Determines if the plugin is configurable.
StringTranslationTrait::$stringTranslation protected property The string translation service. 1
StringTranslationTrait::formatPlural protected function Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals protected function Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation protected function Gets the string translation service.
StringTranslationTrait::setStringTranslation public function Sets the string translation service to use. 2
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.