You are here

TestContextAwareBlock.php in Zircon Profile 8

File

core/modules/block/tests/modules/block_test/src/Plugin/Block/TestContextAwareBlock.php
View source
<?php

/**
 * @file
 * Contains \Drupal\block_test\Plugin\Block\TestContextAwareBlock.
 */
namespace Drupal\block_test\Plugin\Block;

use Drupal\Core\Block\BlockBase;

/**
 * Provides a context-aware block.
 *
 * @Block(
 *   id = "test_context_aware",
 *   admin_label = @Translation("Test context-aware block"),
 *   context = {
 *     "user" = @ContextDefinition("entity:user", required = FALSE)
 *   }
 * )
 */
class TestContextAwareBlock extends BlockBase {

  /**
   * {@inheritdoc}
   */
  public function build() {

    /** @var $user \Drupal\user\UserInterface */
    $user = $this
      ->getContextValue('user');
    return array(
      '#prefix' => '<div id="' . $this
        ->getPluginId() . '--username">',
      '#suffix' => '</div>',
      '#markup' => $user ? $user
        ->getUsername() : 'No context mapping selected.',
    );
  }

}

Classes

Namesort descending Description
TestContextAwareBlock Provides a context-aware block.