class ExampleConfigurableTextBlock

Same name in other branches
  1. 3.x modules/block_example/src/Plugin/Block/ExampleConfigurableTextBlock.php \Drupal\block_example\Plugin\Block\ExampleConfigurableTextBlock

Provides a 'Example: configurable text string' block.

Drupal\Core\Block\BlockBase gives us a very useful set of basic functionality for this configurable block. We can just fill in a few of the blanks with defaultConfiguration(), blockForm(), blockSubmit(), and build().

Plugin annotation


@Block(
  id = "example_configurable_text",
  admin_label = @Translation("Example: configurable text")
)

Hierarchy

Expanded class hierarchy of ExampleConfigurableTextBlock

File

modules/block_example/src/Plugin/Block/ExampleConfigurableTextBlock.php, line 20

Namespace

Drupal\block_example\Plugin\Block
View source
class ExampleConfigurableTextBlock extends BlockBase {
    
    /**
     * {@inheritdoc}
     *
     * This method sets the block default configuration. This configuration
     * determines the block's behavior when a block is initially placed in a
     * region. Default values for the block configuration form should be added to
     * the configuration array. System default configurations are assembled in
     * BlockBase::__construct() e.g. cache setting and block title visibility.
     *
     * @see \Drupal\block\BlockBase::__construct()
     */
    public function defaultConfiguration() {
        return [
            'block_example_string' => $this->t('A default value. This block was created at %time', [
                '%time' => date('c'),
            ]),
        ];
    }
    
    /**
     * {@inheritdoc}
     *
     * This method defines form elements for custom block configuration. Standard
     * block configuration fields are added by BlockBase::buildConfigurationForm()
     * (block title and title visibility) and BlockFormController::form() (block
     * visibility settings).
     *
     * @see \Drupal\block\BlockBase::buildConfigurationForm()
     * @see \Drupal\block\BlockFormController::form()
     */
    public function blockForm($form, FormStateInterface $form_state) {
        $form['block_example_string_text'] = [
            '#type' => 'textarea',
            '#title' => $this->t('Block contents'),
            '#description' => $this->t('This text will appear in the example block.'),
            '#default_value' => $this->configuration['block_example_string'],
        ];
        return $form;
    }
    
    /**
     * {@inheritdoc}
     *
     * This method processes the blockForm() form fields when the block
     * configuration form is submitted.
     *
     * The blockValidate() method can be used to validate the form submission.
     */
    public function blockSubmit($form, FormStateInterface $form_state) {
        $this->configuration['block_example_string'] = $form_state->getValue('block_example_string_text');
    }
    
    /**
     * {@inheritdoc}
     */
    public function build() {
        return [
            '#markup' => $this->configuration['block_example_string'],
        ];
    }

}

Members

Title Sort descending Modifiers Object type Summary Member alias Overriden Title Overrides
BlockBase::buildConfigurationForm public function Form constructor. Overrides PluginFormInterface::buildConfigurationForm 2
BlockPluginInterface::BLOCK_LABEL_VISIBLE constant Indicates the block label (title) should be displayed to end users.
BlockPluginTrait::$inPreview protected property Whether the plugin is being rendered in preview mode.
BlockPluginTrait::$transliteration protected property The transliteration service.
BlockPluginTrait::access public function
BlockPluginTrait::baseConfigurationDefaults protected function Returns generic default configuration for block plugins.
BlockPluginTrait::blockAccess protected function Indicates whether the block should be shown. 18
BlockPluginTrait::blockValidate public function 3
BlockPluginTrait::buildConfigurationForm public function Creates a generic configuration form for all block types. Individual
block plugins can add elements to this form by overriding
BlockBase::blockForm(). Most block plugins should not override this
method unless they need to alter the generic form elements.
Aliased as: traitBuildConfigurationForm
BlockPluginTrait::calculateDependencies public function 1
BlockPluginTrait::getConfiguration public function 1
BlockPluginTrait::getMachineNameSuggestion public function 1
BlockPluginTrait::getPreviewFallbackString public function 3
BlockPluginTrait::label public function
BlockPluginTrait::setConfiguration public function
BlockPluginTrait::setConfigurationValue public function
BlockPluginTrait::setInPreview public function
BlockPluginTrait::setTransliteration public function Sets the transliteration service.
BlockPluginTrait::submitConfigurationForm public function Most block plugins should not override this method. To add submission
handling for a specific block type, override BlockBase::blockSubmit().
BlockPluginTrait::transliteration protected function Wraps the transliteration service.
BlockPluginTrait::validateConfigurationForm public function Most block plugins should not override this method. To add validation
for a specific block type, override BlockBase::blockValidate().
1
BlockPluginTrait::__construct public function 25
ContextAwarePluginAssignmentTrait::addContextAssignmentElement protected function Builds a form element for assigning a context to a given slot.
ContextAwarePluginAssignmentTrait::contextHandler protected function Wraps the context handler.
ContextAwarePluginTrait::$context protected property The data objects representing the context of this plugin.
ContextAwarePluginTrait::getCacheContexts public function 10
ContextAwarePluginTrait::getCacheMaxAge public function 6
ContextAwarePluginTrait::getCacheTags public function 3
ContextAwarePluginTrait::getContext public function
ContextAwarePluginTrait::getContextDefinition public function
ContextAwarePluginTrait::getContextDefinitions public function
ContextAwarePluginTrait::getContextMapping public function 1
ContextAwarePluginTrait::getContexts public function
ContextAwarePluginTrait::getContextValue public function
ContextAwarePluginTrait::getContextValues public function
ContextAwarePluginTrait::getPluginDefinition abstract public function 1
ContextAwarePluginTrait::setContext public function 1
ContextAwarePluginTrait::setContextMapping public function
ContextAwarePluginTrait::setContextValue public function
ContextAwarePluginTrait::validateContexts public function
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
ExampleConfigurableTextBlock::blockForm public function This method defines form elements for custom block configuration. Standard
block configuration fields are added by BlockBase::buildConfigurationForm()
(block title and title visibility) and BlockFormController::form() (block
visibility settings).
Overrides BlockPluginTrait::blockForm
ExampleConfigurableTextBlock::blockSubmit public function This method processes the blockForm() form fields when the block
configuration form is submitted.
Overrides BlockPluginTrait::blockSubmit
ExampleConfigurableTextBlock::build public function Builds and returns the renderable array for this block plugin. Overrides BlockPluginInterface::build
ExampleConfigurableTextBlock::defaultConfiguration public function This method sets the block default configuration. This configuration
determines the block's behavior when a block is initially placed in a
region. Default values for the block configuration form should be added to
the configuration array. System…
Overrides BlockPluginTrait::defaultConfiguration
MessengerTrait::$messenger protected property The messenger. 16
MessengerTrait::messenger public function Gets the messenger. 16
MessengerTrait::setMessenger public function Sets the messenger.
PluginInspectionInterface::getPluginId public function Gets the plugin ID of the plugin instance. 2
PluginWithFormsTrait::getFormClass public function Implements \Drupal\Core\Plugin\PluginWithFormsInterface::getFormClass().
PluginWithFormsTrait::hasFormClass public function Implements \Drupal\Core\Plugin\PluginWithFormsInterface::hasFormClass().
StringTranslationTrait::$stringTranslation protected property The string translation service. 3
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.