TestContextAwareBlock.php
Same filename in other branches
Namespace
Drupal\block_test\Plugin\BlockFile
-
core/
modules/ block/ tests/ modules/ block_test/ src/ Plugin/ Block/ TestContextAwareBlock.php
View source
<?php
namespace Drupal\block_test\Plugin\Block;
use Drupal\Core\Block\BlockBase;
use Drupal\Core\Session\AccountInterface;
use Drupal\user\UserInterface;
/**
* Provides a context-aware block.
*
* @Block(
* id = "test_context_aware",
* admin_label = @Translation("Test context-aware block"),
* context_definitions = {
* "user" = @ContextDefinition("entity:user", required = FALSE,
* label = @Translation("User Context"), constraints = { "NotNull" = {} }
* ),
* }
* )
*/
class TestContextAwareBlock extends BlockBase {
/**
* {@inheritdoc}
*/
public function build() {
/** @var $user \Drupal\user\UserInterface */
$user = $this->getContextValue('user');
return [
'#prefix' => '<div id="' . $this->getPluginId() . '--username">',
'#suffix' => '</div>',
'#markup' => $user ? $user->getAccountName() : 'No context mapping selected.',
];
}
/**
* {@inheritdoc}
*/
protected function blockAccess(AccountInterface $account) {
if ($this->getContextValue('user') instanceof UserInterface) {
$this->messenger()
->addStatus('User context found.');
}
return parent::blockAccess($account);
}
}
Classes
Title | Deprecated | Summary |
---|---|---|
TestContextAwareBlock | Provides a context-aware block. |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.