BlankLayout
class BlankLayout extends LayoutDefault (View source)
| internal | This layout plugin is intended for internal use by Layout Builder only. |
Provides a layout plugin that produces no output.
Traits
Handles context assignments for context-aware plugins.
Provides a trait to add context-aware functionality to plugins.
Wrapper methods for \Drupal\Core\StringTranslation\TranslationInterface.
Provides dependency injection friendly methods for serialization.
Provides a trait for the messenger service.
Constants
| DERIVATIVE_SEPARATOR |
A string which is used to separate base plugin IDs from the derivative ID. |
Properties
| protected string | $pluginId | The plugin_id. |
from PluginBase |
| protected LayoutDefinition | $pluginDefinition | The layout definition. |
from LayoutDefault |
| protected array | $configuration | Configuration information passed into the plugin. |
from PluginBase |
| protected TranslationInterface | $stringTranslation | The string translation service. |
from StringTranslationTrait |
| protected array | $_serviceIds | An array of service IDs keyed by property name used for serialization. |
from DependencySerializationTrait |
| protected array | $_entityStorages | An array of entity type IDs keyed by the property name of their storages. |
from DependencySerializationTrait |
| protected MessengerInterface | $messenger | The messenger. |
from MessengerTrait |
| protected ContextInterface[] | $context | The data objects representing the context of this plugin. |
from ContextAwarePluginTrait |
| protected bool internal | $initializedContextConfig | Tracks whether the context has been initialized from configuration. |
from ContextAwarePluginTrait |
Methods
Constructs a \Drupal\Component\Plugin\PluginBase object.
Translates a string to the current language or to a given language.
Formats a string containing a count of items.
Returns the number of plurals supported by a given language.
Gets the string translation service.
Wraps the context handler.
Builds a form element for assigning a context to a given slot.
Build a render array for layout with regions.
Sets the configuration for this plugin instance.
Details
__construct(array $configuration, string $plugin_id, mixed $plugin_definition)
Constructs a \Drupal\Component\Plugin\PluginBase object.
string
getPluginId()
Gets the plugin_id of the plugin instance.
string
getBaseId()
Gets the base_plugin_id of the plugin instance.
string|null
getDerivativeId()
Gets the derivative_id of the plugin instance.
abstract protected
getPluginDefinition()
{@inheritdoc}
bool
isConfigurable()
Determines if the plugin is configurable.
protected TranslatableMarkup
t(string $string, array $args = [], array $options = [])
Translates a string to the current language or to a given language.
See \Drupal\Core\StringTranslation\TranslatableMarkup::__construct() for important security information and usage guidelines.
In order for strings to be localized, make them available in one of the ways supported by the
protected
formatPlural($count, $singular, $plural, array $args = [], array $options = [])
Formats a string containing a count of items.
protected
getNumberOfPlurals($langcode = NULL)
Returns the number of plurals supported by a given language.
protected TranslationInterface
getStringTranslation()
Gets the string translation service.
$this
setStringTranslation(TranslationInterface $translation)
Sets the string translation service to use.
__sleep()
{@inheritdoc}
__wakeup()
{@inheritdoc}
setMessenger(MessengerInterface $messenger)
Sets the messenger.
MessengerInterface
messenger()
Gets the messenger.
protected ContextHandlerInterface
contextHandler()
Wraps the context handler.
protected array
addContextAssignmentElement(ContextAwarePluginInterface $plugin, array $contexts)
Builds a form element for assigning a context to a given slot.
getContexts()
{@inheritdoc}
ContextInterface
getContext($name)
{@inheritdoc}
setContext($name, ContextInterface $context)
{@inheritdoc}
getContextValues()
{@inheritdoc}
getContextValue($name)
{@inheritdoc}
setContextValue($name, $value)
{@inheritdoc}
getContextMapping()
{@inheritdoc}
setContextMapping(array $context_mapping)
{@inheritdoc}
ContextDefinitionInterface[]
getContextDefinitions()
{@inheritdoc}
ContextDefinitionInterface
getContextDefinition($name)
{@inheritdoc}
validateContexts()
{@inheritdoc}
getCacheContexts()
{@inheritdoc}
getCacheTags()
{@inheritdoc}
getCacheMaxAge()
{@inheritdoc}
array
build(array $regions)
Build a render array for layout with regions.
array
getConfiguration()
Gets this plugin's configuration.
setConfiguration(array $configuration)
Sets the configuration for this plugin instance.
array
defaultConfiguration()
Gets default configuration for this plugin.
array
calculateDependencies()
Calculates dependencies for the configured plugin.
Dependencies are saved in the plugin's configuration entity and are used to determine configuration synchronization order. For example, if the plugin integrates with specific user roles, this method should return an array of dependencies listing the specified roles.
array
buildConfigurationForm(array $form, FormStateInterface $form_state)
Form constructor.
Plugin forms are embedded in other forms. In order to know where the plugin form is located in the parent form, #parents and #array_parents must be known, but these are not available during the initial build phase. In order to have these properties available when building the plugin form's elements, let this method return a form element that has a #process callback and build the rest of the form in the callback. By the time the callback is executed, the element's #parents and #array_parents properties will have been set by the form API. For more documentation on #parents and
array_parents, see \Drupal\Core\Render\Element\FormElement.
validateConfigurationForm(array $form, FormStateInterface $form_state)
Form validation handler.
submitConfigurationForm(array $form, FormStateInterface $form_state)
Form submission handler.