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. 8.9.x 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.

Hierarchy

Expanded class hierarchy of LayoutTestPlugin

File

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

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) {
        if ($form_state->getValue('setting_1') === 'Test Validation Error Message') {
            $form_state->setErrorByName('setting_1', 'Validation Error Message');
        }
    }
    
    /**
     * {@inheritdoc}
     */
    public function submitConfigurationForm(array &$form, FormStateInterface $form_state) {
        $this->configuration['setting_1'] = $form_state->getValue('setting_1');
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
ContextAwarePluginAssignmentTrait::addContextAssignmentElement protected function Builds a form element for assigning a context to a given slot.
ContextAwarePluginAssignmentTrait::contextHandler protected function Wraps the context handler.
ContextAwarePluginAssignmentTrait::t abstract protected function Ensures the t() method is available.
ContextAwarePluginTrait::$context protected property The data objects representing the context of this plugin.
ContextAwarePluginTrait::getCacheContexts public function 10
ContextAwarePluginTrait::getCacheMaxAge public function 6
ContextAwarePluginTrait::getCacheTags public function 3
ContextAwarePluginTrait::getContext public function
ContextAwarePluginTrait::getContextDefinition public function
ContextAwarePluginTrait::getContextDefinitions public function
ContextAwarePluginTrait::getContextMapping public function 1
ContextAwarePluginTrait::getContexts public function
ContextAwarePluginTrait::getContextValue public function
ContextAwarePluginTrait::getContextValues public function
ContextAwarePluginTrait::setContext public function 1
ContextAwarePluginTrait::setContextMapping public function
ContextAwarePluginTrait::setContextValue public function
ContextAwarePluginTrait::validateContexts public function
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::$inPreview protected property Whether the plugin is being rendered in preview mode.
LayoutDefault::$pluginDefinition protected property The layout definition.
LayoutDefault::build public function Build a render array for layout with regions. Overrides LayoutInterface::build 5
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 ContextAwarePluginTrait::getPluginDefinition
LayoutDefault::setConfiguration public function Sets the configuration for this plugin instance. Overrides ConfigurableInterface::setConfiguration
LayoutDefault::setInPreview public function Set preview mode for the plugin. Overrides PreviewAwarePluginInterface::setInPreview
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.