class TestBlockInstantiation

Provides a basic block for testing block instantiation and configuration.

Plugin annotation


@Plugin(
  id = "test_block_instantiation",
  admin_label = @Translation("Display message"),
  module = "block_test"
)

Hierarchy

Expanded class hierarchy of TestBlockInstantiation

File

drupal/core/modules/block/tests/lib/Drupal/block_test/Plugin/Block/TestBlockInstantiation.php, line 23
Contains \Drupal\block_test\Plugin\Block\TestBlockInstantiation.

Namespace

Drupal\block_test\Plugin\Block
View source
class TestBlockInstantiation extends BlockBase {

  /**
   * {@inheritdoc}
   */
  public function settings() {
    return array(
      'display_message' => 'no message set',
    );
  }

  /**
   * {@inheritdoc}
   */
  public function access() {
    return user_access('access content');
  }

  /**
   * {@inheritdoc}
   */
  public function blockForm($form, &$form_state) {
    $form['display_message'] = array(
      '#type' => 'textfield',
      '#title' => t('Display message'),
      '#default_value' => $this->configuration['display_message'],
    );
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function blockSubmit($form, &$form_state) {
    $this->configuration['display_message'] = $form_state['values']['display_message'];
  }

  /**
   * {@inheritdoc}
   */
  public function build() {
    return array(
      '#children' => $this->configuration['display_message'],
    );
  }

}

Members

Namesort descending Modifiers Type Description Overrides
BlockBase::blockValidate public function Adds block type-specific validation for the block form.
BlockBase::form public function Implements \Drupal\block\BlockPluginInterface::form(). Overrides BlockPluginInterface::form 1
BlockBase::getConfig public function Returns the configuration data for the block plugin.
BlockBase::setConfig public function Sets a particular value in the block settings.
BlockBase::submit public function Implements \Drupal\block\BlockPluginInterface::submit(). Overrides BlockPluginInterface::submit
BlockBase::validate public function Implements \Drupal\block\BlockPluginInterface::validate(). Overrides BlockPluginInterface::validate
BlockBase::__construct public function Constructs a Drupal\Component\Plugin\PluginBase object. Overrides PluginBase::__construct 1
PluginBase::$configuration protected property Configuration information passed into the plugin. 1
PluginBase::$pluginDefinition protected property The plugin implementation definition.
PluginBase::$pluginId protected property The plugin_id.
PluginBase::getPluginDefinition public function Returns the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition
PluginBase::getPluginId public function Returns the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
TestBlockInstantiation::access public function Indicates whether block-specific criteria allow access to the block. Overrides BlockBase::access
TestBlockInstantiation::blockForm public function Returns the configuration form elements specific to this block plugin. Overrides BlockBase::blockForm
TestBlockInstantiation::blockSubmit public function Adds block type-specific submission handling for the block form. Overrides BlockBase::blockSubmit
TestBlockInstantiation::build public function Builds and returns the renderable array for this block plugin. Overrides BlockPluginInterface::build
TestBlockInstantiation::settings public function Returns plugin-specific settings for the block. Overrides BlockBase::settings