class Block in Service Container 7

Defines a Block annotation object.

Hierarchy

• class \Drupal\Component\Annotation\Plugin implements AnnotationInterface
  • class \Drupal\Core\Block\Annotation\Block

2 string references to 'Block'

ContainerAwarePluginManagerTest::getContainerDefinition in tests/src/Plugin/ContainerAwarePluginManagerTest.php

Returns a container definition used for testing.

service_container_block.services.yml in modules/utility/service_container_block/service_container_block.services.yml

modules/utility/service_container_block/service_container_block.services.yml

1 class is annotated with Block

ServiceContainerBlock in modules/utility/service_container_block/src/Plugin/Block/ServiceContainerBlock.php

Defines a Drupal Block.

File

lib/Drupal/Core/Block/Annotation/Block.php, line 19

Contains \Drupal\Core\Block\Annotation\Block.

Namespace

Drupal\Core\Block\Annotation

class Block extends Plugin {

  /**
   * The plugin ID.
   *
   * @var string
   */
  public $id;

  /**
   * The administrative label of the block.
   *
   * @var \Drupal\Core\Annotation\Translation
   *
   * @ingroup plugin_translatable
   */
  public $admin_label = '';

  /**
   * The category in the admin UI where the block will be listed.
   *
   * @var \Drupal\Core\Annotation\Translation
   *
   * @ingroup plugin_translatable
   */
  public $category = '';

  /**
   * Class used to retrieve derivative definitions of the block.
   *
   * @var string
   */
  public $derivative = '';

}

Members

Name	Modifiers	Type	Description	Overrides
Block::$admin_label	public	property	The administrative label of the block.
Block::$category	public	property	The category in the admin UI where the block will be listed.
Block::$derivative	public	property	Class used to retrieve derivative definitions of the block.
Block::$id	public	property	The plugin ID.
Plugin::$definition	protected	property	The plugin definition read from the class annotation.
Plugin::get	public	function	Gets the value of an annotation. Overrides AnnotationInterface::get
Plugin::getClass	public	function	Gets the class of the annotated class. Overrides AnnotationInterface::getClass
Plugin::getId	public	function	Gets the unique ID for this annotated class. Overrides AnnotationInterface::getId
Plugin::getProvider	public	function	Gets the name of the provider of the annotated class. Overrides AnnotationInterface::getProvider
Plugin::parse	protected	function	Parses an annotation into its definition.
Plugin::setClass	public	function	Sets the class of the annotated class. Overrides AnnotationInterface::setClass
Plugin::setProvider	public	function	Sets the name of the provider of the annotated class. Overrides AnnotationInterface::setProvider
Plugin::__construct	public	function	Constructs a Plugin object.