class LayoutTestPlugin

Same name in other branches
  1. 9 core/modules/system/tests/modules/layout_test/src/Plugin/Layout/LayoutTestPlugin.php \Drupal\layout_test\Plugin\Layout\LayoutTestPlugin
  2. 10 core/modules/system/tests/modules/layout_test/src/Plugin/Layout/LayoutTestPlugin.php \Drupal\layout_test\Plugin\Layout\LayoutTestPlugin
  3. 11.x core/modules/system/tests/modules/layout_test/src/Plugin/Layout/LayoutTestPlugin.php \Drupal\layout_test\Plugin\Layout\LayoutTestPlugin

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

Expanded class hierarchy of LayoutTestPlugin

File

core/modules/system/tests/modules/layout_test/src/Plugin/Layout/LayoutTestPlugin.php, line 25

Namespace

Drupal\layout_test\Plugin\Layout
View source 
class LayoutTestPlugin extends LayoutDefault implements PluginFormInterface {
    
    /**
     * {@inheritdoc}
     */
    public function defaultConfiguration() {
        return [
            'setting_1' => 'Default',
        ];
    }
    
    /**
     * {@inheritdoc}
     */
    public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
        $form['setting_1'] = [
            '#type' => 'textfield',
            '#title' => 'Blah',
            '#default_value' => $this->configuration['setting_1'],
        ];
        return $form;
    }
    
    /**
     * {@inheritdoc}
     */
    public function validateConfigurationForm(array &$form, FormStateInterface $form_state) {
    }
    
    /**
     * {@inheritdoc}
     */
    public function submitConfigurationForm(array &$form, FormStateInterface $form_state) {
        $this->configuration['setting_1'] = $form_state->getValue('setting_1');
    }

}

Members

Title Modifiers Object type Summary Overriden Title Overrides
DerivativeInspectionInterface::getBaseId public function Gets the base_plugin_id of the plugin instance. 1
DerivativeInspectionInterface::getDerivativeId public function Gets the derivative_id of the plugin instance. 1
LayoutDefault::$pluginDefinition protected property The layout definition.
LayoutDefault::build public function Build a render array for layout with regions. Overrides LayoutInterface::build 3
LayoutDefault::calculateDependencies public function Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies 2
LayoutDefault::getConfiguration public function Gets this plugin's configuration. Overrides ConfigurableInterface::getConfiguration
LayoutDefault::getPluginDefinition public function Overrides LayoutInterface::getPluginDefinition
LayoutDefault::setConfiguration public function Sets the configuration for this plugin instance. Overrides ConfigurableInterface::setConfiguration
LayoutDefault::__construct public function
LayoutTestPlugin::buildConfigurationForm public function Form constructor. Overrides LayoutDefault::buildConfigurationForm
LayoutTestPlugin::defaultConfiguration public function Gets default configuration for this plugin. Overrides LayoutDefault::defaultConfiguration
LayoutTestPlugin::submitConfigurationForm public function Form submission handler. Overrides LayoutDefault::submitConfigurationForm
LayoutTestPlugin::validateConfigurationForm public function Form validation handler. Overrides LayoutDefault::validateConfigurationForm
PluginInspectionInterface::getPluginId public function Gets the plugin_id of the plugin instance. 2

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.