class FieldBlock in Drupal 9

Provides test field block to test with Block UI.

\Drupal\Tests\layout_builder\FunctionalJavascript\FieldBlockTest provides test coverage of complex AJAX interactions within certain field blocks. layout_builder_plugin_filter_block__block_ui_alter() removes certain blocks with 'layout_builder' as the provider. To make these blocks available during testing, this plugin uses the same deriver but each derivative will have a different provider.

Plugin annotation

@Block(
  id = "field_block_test",
  deriver = "\Drupal\layout_builder\Plugin\Derivative\FieldBlockDeriver",
)

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, PreviewFallbackInterface uses BlockPluginTrait, ContextAwarePluginAssignmentTrait, ContextAwarePluginTrait
      • class \Drupal\layout_builder\Plugin\Block\FieldBlock implements ContainerFactoryPluginInterface, ContextAwarePluginInterface
        • class \Drupal\layout_builder_fieldblock_test\Plugin\Block\FieldBlock

See also

\Drupal\Tests\layout_builder\FunctionalJavascript\FieldBlockTest

layout_builder_plugin_filter_block__block_ui_alter()

File

core/modules/layout_builder/tests/modules/layout_builder_fieldblock_test/src/Plugin/Block/FieldBlock.php, line 25

Namespace

Drupal\layout_builder_fieldblock_test\Plugin\Block

class FieldBlock extends LayoutBuilderFieldBlock {

}

Members

Name	Modifiers	Type	Description	Overrides
BlockBase::buildConfigurationForm	public	function	Form constructor. Overrides PluginFormInterface::buildConfigurationForm	2
BlockPluginInterface::BLOCK_LABEL_VISIBLE		constant	Indicates the block label (title) should be displayed to end users.
BlockPluginTrait::$transliteration	protected	property	The transliteration service.
BlockPluginTrait::access	public	function
BlockPluginTrait::baseConfigurationDefaults	protected	function	Returns generic default configuration for block plugins.
BlockPluginTrait::blockValidate	public	function		3
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::getConfiguration	public	function		1
BlockPluginTrait::getMachineNameSuggestion	public	function		1
BlockPluginTrait::label	public	function
BlockPluginTrait::setConfiguration	public	function
BlockPluginTrait::setConfigurationValue	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
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::$initializedContextConfig	protected	property	Tracks whether the context has been initialized from configuration.
ContextAwarePluginTrait::getCacheContexts	public	function		9
ContextAwarePluginTrait::getCacheMaxAge	public	function		7
ContextAwarePluginTrait::getCacheTags	public	function		4
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 protected	function		1
ContextAwarePluginTrait::setContext	public	function		1
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
FieldBlock::$bundle	protected	property	The bundle ID.
FieldBlock::$entityFieldManager	protected	property	The entity field manager.
FieldBlock::$entityTypeId	protected	property	The entity type ID.
FieldBlock::$fieldDefinition	protected	property	The field definition.
FieldBlock::$fieldName	protected	property	The field name.
FieldBlock::$formatterManager	protected	property	The formatter manager.
FieldBlock::$logger	protected	property	The logger.
FieldBlock::$moduleHandler	protected	property	The module handler.
FieldBlock::blockAccess	protected	function	Indicates whether the block should be shown. Overrides BlockPluginTrait::blockAccess
FieldBlock::blockForm	public	function	Overrides BlockPluginTrait::blockForm
FieldBlock::blockSubmit	public	function	Overrides BlockPluginTrait::blockSubmit
FieldBlock::build	public	function	Builds and returns the renderable array for this block plugin. Overrides BlockPluginInterface::build
FieldBlock::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
FieldBlock::defaultConfiguration	public	function	Overrides BlockPluginTrait::defaultConfiguration
FieldBlock::formatterSettingsAjaxCallback	public static	function	Render API callback: gets the layout settings elements.
FieldBlock::formatterSettingsProcessCallback	public	function	Render API callback: builds the formatter settings elements.
FieldBlock::getApplicablePluginOptions	protected	function	Returns an array of applicable formatter options for a field.
FieldBlock::getEntity	protected	function	Gets the entity that has the field.
FieldBlock::getFieldDefinition	protected	function	Gets the field definition.
FieldBlock::getFormatter	protected	function	Gets the formatter object.
FieldBlock::getPreviewFallbackString	public	function	Overrides BlockPluginTrait::getPreviewFallbackString
FieldBlock::thirdPartySettingsForm	protected	function	Adds the formatter third party settings forms.
FieldBlock::__construct	public	function	Constructs a new FieldBlock. Overrides BlockPluginTrait::__construct
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::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	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.	4
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.