class AttachedRenderingBlock in Drupal 10

A block we can use to test caching of #attached headers.

Plugin annotation

@Block(
  id = "attached_rendering_block",
  admin_label = @Translation("AttachedRenderingBlock")
)

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
    • class \Drupal\Core\Block\BlockBase implements BlockPluginInterface, ContextAwarePluginInterface, PluginWithFormsInterface, PreviewAwarePluginInterface, PreviewFallbackInterface uses BlockPluginTrait, ContextAwarePluginAssignmentTrait, ContextAwarePluginTrait
      • class \Drupal\render_attached_test\Plugin\Block\AttachedRenderingBlock

See also

\Drupal\system\Tests\Render\HtmlResponseAttachmentsTest

File

core/modules/system/tests/modules/render_attached_test/src/Plugin/Block/AttachedRenderingBlock.php, line 20

Namespace

Drupal\render_attached_test\Plugin\Block

class AttachedRenderingBlock extends BlockBase {

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

    // Grab test attachment fixtures from
    // Drupal\render_attached_test\Controller\RenderAttachedTestController.
    $controller = new RenderAttachedTestController();
    $attached = BubbleableMetadata::mergeAttachments($controller
      ->feed(), $controller
      ->head());
    $attached = BubbleableMetadata::mergeAttachments($attached, $controller
      ->header());
    $attached = BubbleableMetadata::mergeAttachments($attached, $controller
      ->teapotHeaderStatus());

    // Return some arbitrary markup so the block doesn't disappear.
    $attached['#markup'] = 'Markup from attached_rendering_block.';
    return $attached;
  }

  /**
   * {@inheritdoc}
   */
  public function getCacheMaxAge() {
    return Cache::PERMANENT;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
AttachedRenderingBlock::build	public	function	Builds and returns the renderable array for this block plugin. Overrides BlockPluginInterface::build
AttachedRenderingBlock::getCacheMaxAge	public	function	Overrides ContextAwarePluginTrait::getCacheMaxAge
BlockBase::buildConfigurationForm	public	function
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.	3
BlockPluginTrait::blockForm	public	function		4
BlockPluginTrait::blockSubmit	public	function		1
BlockPluginTrait::blockValidate	public	function		1
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::defaultConfiguration	public	function		1
BlockPluginTrait::getConfiguration	public	function
BlockPluginTrait::getMachineNameSuggestion	public	function
BlockPluginTrait::getPreviewFallbackString	public	function
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		4
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		1
ContextAwarePluginTrait::getCacheTags	public	function
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
ContextAwarePluginTrait::setContext	public	function
ContextAwarePluginTrait::setContextMapping	public	function
ContextAwarePluginTrait::setContextValue	public	function
ContextAwarePluginTrait::validateContexts	public	function
DependencySerializationTrait::$_entityStorages	protected	property
DependencySerializationTrait::$_serviceIds	protected	property
DependencySerializationTrait::__sleep	public	function		2
DependencySerializationTrait::__wakeup	public	function		2
MessengerTrait::$messenger	protected	property	The messenger.	18
MessengerTrait::messenger	public	function	Gets the messenger.	18
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.
PluginBase::$pluginId	protected	property	The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR		constant	A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId	public	function
PluginBase::getDerivativeId	public	function
PluginBase::getPluginId	public	function
PluginBase::isConfigurable	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.	1
StringTranslationTrait::t	protected	function	Translates a string to the current language or to a given language.