class TestBlockInstantiation

Same name in other branches
  1. 8.9.x core/modules/block/tests/modules/block_test/src/Plugin/Block/TestBlockInstantiation.php \Drupal\block_test\Plugin\Block\TestBlockInstantiation
  2. 10 core/modules/block/tests/modules/block_test/src/Plugin/Block/TestBlockInstantiation.php \Drupal\block_test\Plugin\Block\TestBlockInstantiation
  3. 11.x core/modules/block/tests/modules/block_test/src/Plugin/Block/TestBlockInstantiation.php \Drupal\block_test\Plugin\Block\TestBlockInstantiation

Provides a basic block for testing block instantiation and configuration.

Plugin annotation


@Block(
  id = "test_block_instantiation",
  admin_label = @Translation("Display message")
)

Hierarchy

Expanded class hierarchy of TestBlockInstantiation

1 file declares its use of TestBlockInstantiation
BlockBaseTest.php in core/tests/Drupal/Tests/Core/Block/BlockBaseTest.php

File

core/modules/block/tests/modules/block_test/src/Plugin/Block/TestBlockInstantiation.php, line 18

Namespace

Drupal\block_test\Plugin\Block
View source 
class TestBlockInstantiation extends BlockBase {
    
    /**
     * {@inheritdoc}
     */
    public function defaultConfiguration() {
        return [
            'display_message' => 'no message set',
        ];
    }
    
    /**
     * {@inheritdoc}
     */
    protected function blockAccess(AccountInterface $account) {
        return AccessResult::allowedIfHasPermission($account, 'access content');
    }
    
    /**
     * {@inheritdoc}
     */
    public function blockForm($form, FormStateInterface $form_state) {
        $form['display_message'] = [
            '#type' => 'textfield',
            '#title' => $this->t('Display message'),
            '#default_value' => $this->configuration['display_message'],
        ];
        return $form;
    }
    
    /**
     * {@inheritdoc}
     */
    public function blockSubmit($form, FormStateInterface $form_state) {
        $this->configuration['display_message'] = $form_state->getValue('display_message');
    }
    
    /**
     * {@inheritdoc}
     */
    public function build() {
        return [
            '#children' => $this->configuration['display_message'],
        ];
    }

}

Members

Title 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::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
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 24
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::$initializedContextConfig protected property Tracks whether the context has been initialized from configuration.
ContextAwarePluginTrait::getCacheContexts public function 9
ContextAwarePluginTrait::getCacheMaxAge public function 7
ContextAwarePluginTrait::getCacheTags public function 4
ContextAwarePluginTrait::getContext public function
ContextAwarePluginTrait::getContextDefinition public function
ContextAwarePluginTrait::getContextDefinitions public function
ContextAwarePluginTrait::getContextMapping public function
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
MessengerTrait::$messenger protected property The messenger. 17
MessengerTrait::messenger public function Gets the messenger. 17
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.
TestBlockInstantiation::blockAccess protected function Indicates whether the block should be shown. Overrides BlockPluginTrait::blockAccess
TestBlockInstantiation::blockForm public function Overrides BlockPluginTrait::blockForm
TestBlockInstantiation::blockSubmit public function Overrides BlockPluginTrait::blockSubmit
TestBlockInstantiation::build public function Builds and returns the renderable array for this block plugin. Overrides BlockPluginInterface::build
TestBlockInstantiation::defaultConfiguration public function Overrides BlockPluginTrait::defaultConfiguration

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.