class LayoutTestPlugin in Layout Plugin (obsolete, use core's Layout Discovery) 8

The plugin that handles the default layout template.

Plugin annotation

@Layout(
  id = "layout_test_plugin",
  label = @Translation("Layout plugin (with settings)"),
  category = @Translation("Layout test"),
  description = @Translation("Test layout"),
  template = "templates/layout-test-plugin",
  regions = {
    "main" = {
      "label" = @Translation("Main Region")
    }
  }
)

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
    • class \Drupal\layout_plugin\Plugin\Layout\LayoutBase implements ConfigurablePluginInterface, PluginFormInterface, LayoutInterface
      • class \Drupal\layout_test\Plugin\Layout\LayoutTestPlugin

File

tests/modules/layout_test/src/Plugin/Layout/LayoutTestPlugin.php, line 26

Namespace

Drupal\layout_test\Plugin\Layout

class LayoutTestPlugin extends LayoutBase {

  /**
   * {@inheritdoc}
   */
  public function defaultConfiguration() {
    return parent::defaultConfiguration() + [
      'setting_1' => 'Default',
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
    $configuration = $this
      ->getConfiguration();
    $form['setting_1'] = [
      '#type' => 'textfield',
      '#title' => 'Blah',
      '#default_value' => $configuration['setting_1'],
    ];
    return $form;
  }

  /**
   * @inheritDoc
   */
  public function submitConfigurationForm(array &$form, FormStateInterface $form_state) {
    parent::submitConfigurationForm($form, $form_state);
    $this->configuration['setting_1'] = $form_state
      ->getValue('setting_1');
  }

}

Members

Name	Modifiers	Type	Description	Overrides
DependencySerializationTrait::$_entityStorages	protected	property	An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds	protected	property	An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep	public	function		1
DependencySerializationTrait::__wakeup	public	function		2
LayoutBase::$configuration	protected	property	The layout configuration. Overrides PluginBase::$configuration
LayoutBase::build	public	function	Build a render array for layout with regions. Overrides LayoutInterface::build
LayoutBase::calculateDependencies	public	function	Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies
LayoutBase::getBasePath	public	function	Gets the path to resources like icon or template.
LayoutBase::getCategory	public	function	Gets the human-readable category.
LayoutBase::getConfiguration	public	function	Gets this plugin's configuration. Overrides ConfigurablePluginInterface::getConfiguration
LayoutBase::getDescription	public	function	Gets the optional description for advanced layouts.
LayoutBase::getIconFilename	public	function	Gets the path to the preview image.
LayoutBase::getLabel	public	function	Gets the human-readable name.
LayoutBase::getLibrary	public	function	Get the asset library.
LayoutBase::getRegionDefinitions	public	function	Gets information on regions keyed by machine name.
LayoutBase::getRegionNames	public	function	Gets human-readable list of regions keyed by machine name.
LayoutBase::getThemeHook	public	function	Gets the theme hook used to render this layout.
LayoutBase::setConfiguration	public	function	Sets the configuration for this plugin instance. Overrides ConfigurablePluginInterface::setConfiguration
LayoutBase::validateConfigurationForm	public	function	Form validation handler. Overrides PluginFormInterface::validateConfigurationForm
LayoutTestPlugin::buildConfigurationForm	public	function	Form constructor. Overrides LayoutBase::buildConfigurationForm
LayoutTestPlugin::defaultConfiguration	public	function	Gets default configuration for this plugin. Overrides LayoutBase::defaultConfiguration
LayoutTestPlugin::submitConfigurationForm	public	function	@inheritDoc Overrides LayoutBase::submitConfigurationForm
MessengerTrait::$messenger	protected	property	The messenger.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
MessengerTrait::setMessenger	public	function	Sets the messenger.
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::getPluginDefinition	public	function	Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition	3
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.
PluginBase::__construct	public	function	Constructs a \Drupal\Component\Plugin\PluginBase object.	92
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	1
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.