ISTWCMS-4053: completing code review changes for custom layouts

src/Plugin/Layout/UwTwoColumnLayout.php → src/Plugin/Layout/Uw2ColumnLayout.php

@@ -3,28 +3,11 @@
 namespace Drupal\uw_cfg_common\Plugin\Layout;
 
 use Drupal\Core\Form\FormStateInterface;
-use Drupal\Core\Layout\LayoutDefault;
-use Drupal\Core\Plugin\PluginFormInterface;
 
 /**
  * A UW two column layout.
- *
- * @Layout(
- *   id = "uw_two_column",
- *   label = @Translation("Two columns"),
- *   category = @Translation("UW layouts"),
- *   template = "templates/layout/layout--uwtwocol",
- *   regions = {
- *     "first" = {
- *       "label" = @Translation("Column 1"),
- *     },
- *     "second" = {
- *       "label" = @Translation("Column 2"),
- *     },
- *   }
- * )
  */
-class UwTwoColumnLayout extends LayoutDefault implements PluginFormInterface {
+class Uw2ColumnLayout extends UwColumnLayoutBase {
 
   /**
    * {@inheritdoc}
@@ -51,31 +34,4 @@ class UwTwoColumnLayout extends LayoutDefault implements PluginFormInterface {
 
     return $form;
   }
-
-  /**
-   * {@inheritdoc}
-   */
-  public function submitConfigurationForm(array &$form, FormStateInterface $form_state) {
-
-    // Set the column class in the config.
-    $this->configuration['column_class'] = $form_state->getValue(['layout_settings', 'column_class'], NULL);
-  }
-
-  /**
-   * {@inheritdoc}
-   */
-  public function build(array $regions) {
-
-    // Build the render array as usual.
-    $build = parent::build($regions);
-
-    // Retrieve the config for the layout.
-    $configuration = $this->getConfiguration();
-
-    // Set the column class to be used in the layout template.
-    $build['#settings']['column_class'] = $configuration['column_class'];
-
-    return $build;
-  }
-
 }

src/Plugin/Layout/UwThreeColumnLayout.php → src/Plugin/Layout/Uw3ColumnLayout.php

@@ -3,31 +3,11 @@
 namespace Drupal\uw_cfg_common\Plugin\Layout;
 
 use Drupal\Core\Form\FormStateInterface;
-use Drupal\Core\Layout\LayoutDefault;
-use Drupal\Core\Plugin\PluginFormInterface;
 
 /**
  * A UW three column layout.
- *
- * @Layout(
- *   id = "uw_three_column",
- *   label = @Translation("Three columns"),
- *   category = @Translation("UW layouts"),
- *   template = "templates/layout/layout--uwthreecol",
- *   regions = {
- *     "first" = {
- *       "label" = @Translation("Column 1"),
- *     },
- *     "second" = {
- *       "label" = @Translation("Column 2"),
- *     },
- *     "third" = {
- *       "label" = @Translation("Column 3"),
- *     },
- *   }
- * )
  */
-class UwThreeColumnLayout extends LayoutDefault implements PluginFormInterface {
+class Uw3ColumnLayout extends UwColumnLayoutBase {
 
   /**
    * {@inheritdoc}
@@ -57,31 +37,4 @@ class UwThreeColumnLayout extends LayoutDefault implements PluginFormInterface {
 
     return $form;
   }
-
-  /**
-   * {@inheritdoc}
-   */
-  public function submitConfigurationForm(array &$form, FormStateInterface $form_state) {
-
-    // Set the column class in the config.
-    $this->configuration['column_class'] = $form_state->getValue(['layout_settings', 'column_class'], NULL);
-  }
-
-  /**
-   * {@inheritdoc}
-   */
-  public function build(array $regions) {
-
-    // Build the render array as usual.
-    $build = parent::build($regions);
-
-    // Retrieve the config for the layout.
-    $configuration = $this->getConfiguration();
-
-    // Set the column class to be used in the layout template.
-    $build['#settings']['column_class'] = $configuration['column_class'];
-
-    return $build;
-  }
-
 }

src/Plugin/Layout/UwFourColumnLayout.php → src/Plugin/Layout/Uw4ColumnLayout.php

@@ -3,34 +3,11 @@
 namespace Drupal\uw_cfg_common\Plugin\Layout;
 
 use Drupal\Core\Form\FormStateInterface;
-use Drupal\Core\Layout\LayoutDefault;
-use Drupal\Core\Plugin\PluginFormInterface;
 
 /**
  * A UW four column layout.
- *
- * @Layout(
- *   id = "uw_four_column",
- *   label = @Translation("Four columns"),
- *   category = @Translation("UW layouts"),
- *   template = "templates/layout/layout--uwfourcol",
- *   regions = {
- *     "first" = {
- *       "label" = @Translation("Column 1"),
- *     },
- *     "second" = {
- *       "label" = @Translation("Column 2"),
- *     },
- *     "third" = {
- *       "label" = @Translation("Column 3"),
- *     },
- *     "four" = {
- *       "label" = @Translation("Column 4"),
- *     },
- *   }
- * )
  */
-class UwFourColumnLayout extends LayoutDefault implements PluginFormInterface {
+class Uw4ColumnLayout extends UwColumnLayoutBase {
 
   /**
    * {@inheritdoc}
@@ -60,31 +37,4 @@ class UwFourColumnLayout extends LayoutDefault implements PluginFormInterface {
 
     return $form;
   }
-
-  /**
-   * {@inheritdoc}
-   */
-  public function submitConfigurationForm(array &$form, FormStateInterface $form_state) {
-
-    // Set the column class in the config.
-    $this->configuration['column_class'] = $form_state->getValue(['layout_settings', 'column_class'], NULL);
-  }
-
-  /**
-   * {@inheritdoc}
-   */
-  public function build(array $regions) {
-
-    // Build the render array as usual.
-    $build = parent::build($regions);
-
-    // Retrieve the config for the layout.
-    $configuration = $this->getConfiguration();
-
-    // Set the column class to be used in the layout template.
-    $build['#settings']['column_class'] = $configuration['column_class'];
-
-    return $build;
-  }
-
 }

src/Plugin/Layout/UwFiveColumnLayout.php → src/Plugin/Layout/Uw5ColumnLayout.php

@@ -3,37 +3,11 @@
 namespace Drupal\uw_cfg_common\Plugin\Layout;
 
 use Drupal\Core\Form\FormStateInterface;
-use Drupal\Core\Layout\LayoutDefault;
-use Drupal\Core\Plugin\PluginFormInterface;
 
 /**
  * A UW four column layout.
- *
- * @Layout(
- *   id = "uw_five_column",
- *   label = @Translation("Five columns"),
- *   category = @Translation("UW layouts"),
- *   template = "templates/layout/layout--uwfivecol",
- *   regions = {
- *     "first" = {
- *       "label" = @Translation("Column 1"),
- *     },
- *     "second" = {
- *       "label" = @Translation("Column 2"),
- *     },
- *     "third" = {
- *       "label" = @Translation("Column 3"),
- *     },
- *     "fourth" = {
- *       "label" = @Translation("Column 4"),
- *     },
- *     "fifth" = {
- *       "label" = @Translation("Column 5"),
- *     },
- *   }
- * )
  */
-class UwFiveColumnLayout extends LayoutDefault implements PluginFormInterface {
+class Uw5ColumnLayout extends UwColumnLayoutBase {
 
   /**
    * {@inheritdoc}
@@ -65,30 +39,4 @@ class UwFiveColumnLayout extends LayoutDefault implements PluginFormInterface {
     return $form;
   }
 
-  /**
-   * {@inheritdoc}
-   */
-  public function submitConfigurationForm(array &$form, FormStateInterface $form_state) {
-
-    // Set the column class in the config.
-    $this->configuration['column_class'] = $form_state->getValue(['layout_settings', 'column_class'], NULL);
-  }
-
-  /**
-   * {@inheritdoc}
-   */
-  public function build(array $regions) {
-
-    // Build the render array as usual.
-    $build = parent::build($regions);
-
-    // Retrieve the config for the layout.
-    $configuration = $this->getConfiguration();
-
-    // Set the column class to be used in the layout template.
-    $build['#settings']['column_class'] = $configuration['column_class'];
-
-    return $build;
-  }
-
 }

src/Plugin/Layout/UwOneColumnLayout.php → src/Plugin/Layout/UwColumnLayoutBase.php

-<?php
-
-namespace Drupal\uw_cfg_common\Plugin\Layout;
-
-use Drupal\Core\Form\FormStateInterface;
-use Drupal\Core\Layout\LayoutDefault;
-use Drupal\Core\Plugin\PluginFormInterface;
-
-/**
- * A UW one column layout.
- *
- * @Layout(
- *   id = "uw_one_column",
- *   label = @Translation("One column"),
- *   category = @Translation("UW layouts"),
- *   template = "templates/layout/layout--uwonecol",
- *   regions = {
- *     "first" = {
- *       "label" = @Translation("Column 1"),
- *     },
- *   }
- * )
- */
-class UwOneColumnLayout extends LayoutDefault implements PluginFormInterface {
-
-  /**
-   * {@inheritdoc}
-   */
-  public function build(array $regions) {
-
-    // Build the render array as usual.
-    $build = parent::build($regions);
-
-    return $build;
-  }
-
-}
+<?php
+
+namespace Drupal\uw_cfg_common\Plugin\Layout;
+
+use Drupal\Core\Form\FormStateInterface;
+use Drupal\Core\Layout\LayoutDefault;
+use Drupal\Core\Plugin\PluginFormInterface;
+
+/**
+ * A column layout base.
+ */
+class UwColumnLayoutBase extends LayoutDefault implements PluginFormInterface {
+
+  /**
+   * {@inheritdoc}
+   */
+  public function submitConfigurationForm(array &$form, FormStateInterface $form_state) {
+
+    // Set the column class in the config.
+    $this->configuration['column_class'] = $form_state->getValue(['layout_settings', 'column_class'], NULL);
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public function build(array $regions) {
+
+    // Build the render array as usual.
+    $build = parent::build($regions);
+
+    // Retrieve the config for the layout.
+    $configuration = $this->getConfiguration();
+
+    // Set the column class to be used in the layout template.
+    $build['#settings']['column_class'] = $configuration['column_class'];
+
+    return $build;
+  }
+
+}

uw_cfg_common.layouts.yml

 uw_one_column:
   label: 'One column'
   category: 'UW layouts'
-  class: '\Drupal\uw_cfg_common\Plugin\Layout\UwOneColumnLayout'
-  template: uw_fdsu_theme_resp/templates/layout/layout--uwonecol
+  template: uw_fdsu_theme_resp/templates/layout/layout--uw1col
   default_region: first
   regions:
     first:
@@ -12,27 +11,27 @@ uw_one_column:
 uw_two_column:
   label: 'Two columns'
   category: 'UW layouts'
-  class: '\Drupal\uw_cfg_common\Plugin\Layout\UwTwoColumnLayout'
-  template: uw_fdsu_theme_resp/templates/layout/layout--uwtwocol
+  class: '\Drupal\uw_cfg_common\Plugin\Layout\Uw2ColumnLayout'
+  template: uw_fdsu_theme_resp/templates/layout/layout--uw2col
   default_region: first
   regions:
     first:
-      label: One
+      label: First
     second:
-      label: Two
+      label: Second
   icon_map:
     - [first, second]
 uw_three_column:
   label: 'Three columns'
   category: 'UW layouts'
-  class: '\Drupal\uw_cfg_common\Plugin\Layout\UwThreeColumnLayout'
-  template: uw_fdsu_theme_resp/templates/layout/layout--uwthreecol
+  class: '\Drupal\uw_cfg_common\Plugin\Layout\Uw3ColumnLayout'
+  template: uw_fdsu_theme_resp/templates/layout/layout--uw3col
   default_region: first
   regions:
     first:
-      label: One
+      label: First
     second:
-      label: Two
+      label: Second
     third:
       label: Third
   icon_map:
@@ -40,14 +39,14 @@ uw_three_column:
 uw_four_column:
   label: 'Four columns'
   category: 'UW layouts'
-  class: '\Drupal\uw_cfg_common\Plugin\Layout\UwFourColumnLayout'
-  template: uw_fdsu_theme_resp/templates/layout/layout--uwfourcol
+  class: '\Drupal\uw_cfg_common\Plugin\Layout\Uw4ColumnLayout'
+  template: uw_fdsu_theme_resp/templates/layout/layout--uw4col
   default_region: first
   regions:
     first:
-      label: One
+      label: First
     second:
-      label: Two
+      label: Second
     third:
       label: Third
     fourth:
@@ -57,14 +56,14 @@ uw_four_column:
 uw_five_column:
   label: 'Five columns'
   category: 'UW layouts'
-  class: '\Drupal\uw_cfg_common\Plugin\Layout\UwFiveColumnLayout'
-  template: uw_fdsu_theme_resp/templates/layout/layout--uwfivecol
+  class: '\Drupal\uw_cfg_common\Plugin\Layout\Uw5ColumnLayout'
+  template: uw_fdsu_theme_resp/templates/layout/layout--uw5col
   default_region: first
   regions:
     first:
-      label: One
+      label: First
     second:
-      label: Two
+      label: Second
     third:
       label: Third
     fourth: