class TestPageTitleMainContentAndMessagesBlock
Same name and namespace in other branches
- main core/modules/block/tests/modules/block_test/src/Plugin/Block/TestPageTitleMainContentAndMessagesBlock.php \Drupal\block_test\Plugin\Block\TestPageTitleMainContentAndMessagesBlock
Provides a block which includes page title, main content & messages together.
Attributes
#[Block(id: "test_title_content_message_block", admin_label: new TranslatableMarkup("Test Page Title, Content, and Message Block"))]
Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements \Drupal\Component\Plugin\PluginInspectionInterface, \Drupal\Component\Plugin\DerivativeInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses \Drupal\Core\DependencyInjection\AutowiredInstanceTrait, \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait extends \Drupal\Component\Plugin\PluginBase
- class \Drupal\Core\Block\BlockBase implements \Drupal\Core\Block\BlockPluginInterface, \Drupal\Core\Plugin\PluginWithFormsInterface, \Drupal\Core\Plugin\PreviewAwarePluginInterface, \Drupal\Core\Render\PreviewFallbackInterface, \Drupal\Core\Plugin\ContextAwarePluginInterface uses \Drupal\Core\Block\BlockPluginTrait, \Drupal\Core\Plugin\ContextAwarePluginTrait, \Drupal\Core\Plugin\ContextAwarePluginAssignmentTrait extends \Drupal\Core\Plugin\PluginBase
- class \Drupal\block_test\Plugin\Block\TestPageTitleMainContentAndMessagesBlock implements \Drupal\Core\Block\MainContentBlockPluginInterface, \Drupal\Core\Block\TitleBlockPluginInterface, \Drupal\Core\Block\MessagesBlockPluginInterface extends \Drupal\Core\Block\BlockBase
- class \Drupal\Core\Block\BlockBase implements \Drupal\Core\Block\BlockPluginInterface, \Drupal\Core\Plugin\PluginWithFormsInterface, \Drupal\Core\Plugin\PreviewAwarePluginInterface, \Drupal\Core\Render\PreviewFallbackInterface, \Drupal\Core\Plugin\ContextAwarePluginInterface uses \Drupal\Core\Block\BlockPluginTrait, \Drupal\Core\Plugin\ContextAwarePluginTrait, \Drupal\Core\Plugin\ContextAwarePluginAssignmentTrait extends \Drupal\Core\Plugin\PluginBase
- class \Drupal\Core\Plugin\PluginBase uses \Drupal\Core\DependencyInjection\AutowiredInstanceTrait, \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait extends \Drupal\Component\Plugin\PluginBase
Expanded class hierarchy of TestPageTitleMainContentAndMessagesBlock
File
-
core/
modules/ block/ tests/ modules/ block_test/ src/ Plugin/ Block/ TestPageTitleMainContentAndMessagesBlock.php, line 17
Namespace
Drupal\block_test\Plugin\BlockView source
class TestPageTitleMainContentAndMessagesBlock extends BlockBase implements MainContentBlockPluginInterface, TitleBlockPluginInterface, MessagesBlockPluginInterface {
/**
* The page title: a string (plain title) or a render array (formatted title).
*
* @var string|array
*/
protected $title = '';
/**
* The render array representing the main page content.
*
* @var array
*/
protected $mainContent;
/**
* Whether setMainContent was called.
*
* @var bool
*/
protected $isMainContentPlaced = FALSE;
/**
* Whether setTitle was called.
*
* @var bool
*/
protected $isPageTitlePlaced = FALSE;
/**
* {@inheritdoc}
*/
public function setMainContent(array $main_content) : void {
$this->mainContent = $main_content;
$this->isMainContentPlaced = TRUE;
}
/**
* {@inheritdoc}
*/
public function setTitle($title) : static {
$this->title = $title;
$this->isPageTitlePlaced = TRUE;
return $this;
}
/**
* {@inheritdoc}
*/
public function build() : array {
$build = [];
// Print a message to later verify that messages are rendered in the block.
$this->messenger()
->addStatus('This is a status message.');
if ($this->isPageTitlePlaced === TRUE) {
$build['page_title'] = [
'#type' => 'page_title',
'#title' => $this->title,
];
// Display text which confirms title was displayed by this block.
// Content of text is used in corresponding test.
$build['page_title_confirmation'] = [
'#markup' => $this->t('Page title has been placed in the block.'),
];
}
if ($this->isMainContentPlaced === TRUE) {
$build['main_content'] = $this->mainContent;
// Display text which confirms main content was displayed by this block.
// Content of text is used in corresponding test.
$build['main_content_confirmation'] = [
'#markup' => $this->t('Main content has been placed in the block.'),
];
}
$build['content']['messages'] = [
'#prefix' => '<div id="test-block-messages-wrapper">',
'#weight' => -1000,
'#type' => 'status_messages',
'#include_fallback' => TRUE,
'#suffix' => '</div>',
];
return $build;
}
}
Members
| Title Sort descending | Deprecated | Modifiers | Object type | Summary | Member alias | Overriden Title | Overrides |
|---|---|---|---|---|---|---|---|
| AutowiredInstanceTrait::createInstanceAutowired | public static | function | Instantiates a new instance of the implementing class using autowiring. | ||||
| AutowiredInstanceTrait::getAutowireArguments | private static | function | Resolves arguments for a method using autowiring. | ||||
| BlockBase::buildConfigurationForm | public | function | Form constructor. | Overrides PluginFormInterface::buildConfigurationForm | 2 | ||
| BlockBase::submitConfigurationForm | public | function | Form submission handler. | Overrides PluginFormInterface::submitConfigurationForm | |||
| 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::blockForm | public | function | 14 | ||||
| BlockPluginTrait::blockSubmit | public | function | 10 | ||||
| BlockPluginTrait::blockValidate | public | function | 4 | ||||
| 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::createPlaceholder | public | function | 7 | ||||
| BlockPluginTrait::defaultConfiguration | public | function | 16 | ||||
| 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(). |
Aliased as: traitSubmitConfigurationForm | |||
| 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 | 27 | ||||
| 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 | 9 | ||||
| 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 | |||||
| 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 | 2 | ||||
| DependencySerializationTrait::__wakeup | public | function | 2 | ||||
| MessengerTrait::$messenger | protected | property | The messenger. | 27 | |||
| MessengerTrait::messenger | public | function | Gets the messenger. | 27 | |||
| 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::$pluginId | protected | property | The plugin ID. | ||||
| PluginBase::create | public static | function | Instantiates a new instance of the implementing class using autowiring. | 65 | |||
| 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::getPluginId | public | function | Gets the plugin ID of the plugin instance. | Overrides PluginInspectionInterface::getPluginId | |||
| PluginBase::isConfigurable | Deprecated | public | function | Determines if the plugin is configurable. | |||
| 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. | 1 | |||
| TestPageTitleMainContentAndMessagesBlock::$isMainContentPlaced | protected | property | Whether setMainContent was called. | ||||
| TestPageTitleMainContentAndMessagesBlock::$isPageTitlePlaced | protected | property | Whether setTitle was called. | ||||
| TestPageTitleMainContentAndMessagesBlock::$mainContent | protected | property | The render array representing the main page content. | ||||
| TestPageTitleMainContentAndMessagesBlock::$title | protected | property | The page title: a string (plain title) or a render array (formatted title). | ||||
| TestPageTitleMainContentAndMessagesBlock::build | public | function | Builds and returns the renderable array for this block plugin. | Overrides BlockPluginInterface::build | |||
| TestPageTitleMainContentAndMessagesBlock::setMainContent | public | function | Sets the main content render array. | Overrides MainContentBlockPluginInterface::setMainContent | |||
| TestPageTitleMainContentAndMessagesBlock::setTitle | public | function | Sets the title. | Overrides TitleBlockPluginInterface::setTitle |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.