Coding standards.

Author: laryn

modules/layout_paragraphs/css/layout_paragraphs.css

@@ -243,3 +243,19 @@
     flex-grow: 12;
   }
 }
+
+.layout-editor-region {
+  display: flex;
+  flex-direction: column;
+
+  .layout-editor-region-title {
+    flex-grow: 0;
+  }
+  .layout-editor-region-content {
+    flex-grow: 1;
+  }
+}
+
+.layout--paragraphs-edit-main {
+  margin-block-end: 3rem;
+}

modules/layout_paragraphs/includes/block.paragraphs.inc

@@ -64,7 +64,6 @@ class BlockParagraphs extends Block {
     $this->is_orphaned = !empty($data['orphan']);
 
     // $this->host_entity_id = end(preg_split('/./', $data['layout_name']));
-
     $this->field_instance = _layout_paragraphs_get_field_instance($data['layout_name']);
     $this->bundle = paragraphs_bundle_load($this->delta);
     if (!empty($data['paragraphs_item_id'])) {
@@ -118,7 +117,7 @@ class BlockParagraphs extends Block {
   }
 
   /**
-   *  Paragraphs don't have front-facing titles, so this returns an empty string.
+   *  Paragraphs don't have front-facing titles, so return an empty string.
    */
   public function getTitle() {
     return '';

modules/layout_paragraphs/layout_paragraphs.context.admin.inc

@@ -1 +1,4 @@
 <?php
+/**
+ * @file
+ */

modules/layout_paragraphs/layout_paragraphs.module

@@ -320,6 +320,8 @@ function layout_paragraphs_tempstore_block_load(string $layout_block_uuid, strin
  * @param Layout $layout
  *   The layout instance to load the block from.
  *
+ * @return BlockParagraphs|bool
+ *
  */
 function layout_paragraphs_tempstore_block_retrieve(string $layout_block_uuid, Layout $layout) {
   $block = FALSE;
@@ -694,6 +696,7 @@ function layout_paragraphs_layout_flexible_types_alter(&$types) {
  */
 function layout_paragraphs_reset_caches() {
   layout_flexible_reset_caches('paragraphs');
+  cache('cache')->delete('layout_paragraphs_info');
 }
 
 /**
@@ -977,6 +980,7 @@ function layout_paragraphs_entity_presave($entity, $entity_type) {
       foreach ($uuids as $block_index => $uuid) {
         if (!empty($uuid)) {
           // Load block with Paragraphs item attached from tempstore.
+          /* var BlockParagraphs $block */
           $block = $layout->content[$uuid] ?? layout_paragraphs_tempstore_block_retrieve($uuid, $layout);
           if (!empty($block->paragraphs_item)) {
             $block_save_needed = ($block->is_new || $block->paragraphs_item->being_edited);

modules/layout_paragraphs/plugins/renderers/layout_renderer_editor_paragraphs.inc

@@ -17,7 +17,7 @@ class LayoutRendererEditorParagraphs extends LayoutRendererEditor {
   /**
    * {@inheritdoc}
    */
-  function __construct(Layout $layout, array $renderer_plugin) {
+  public function __construct(Layout $layout, array $renderer_plugin) {
     $template_id = $layout->layout_template ?? 'default';
 
     $template_info = layout_paragraphs_get_layout_template_info($template_id);
@@ -39,7 +39,7 @@ class LayoutRendererEditorParagraphs extends LayoutRendererEditor {
   /**
    * {@inheritdoc}
    */
-  function addMeta() {
+  public function addMeta() {
     parent::addMeta();
     backdrop_add_library('system', 'ui.sortable');
     backdrop_add_js(backdrop_get_path('module', 'layout') . '/js/layout.admin.js');
@@ -49,7 +49,7 @@ class LayoutRendererEditorParagraphs extends LayoutRendererEditor {
   /**
    * {@inheritdoc}
    */
-  function render() {
+  public function render() {
     $this->addMeta();
 
     $output = '<div class="layout--paragraphs-edit-main">';
@@ -71,7 +71,7 @@ class LayoutRendererEditorParagraphs extends LayoutRendererEditor {
    * @return string
    *   The HTML string representing the entire rendered, themed layout.
    */
-  function renderLayout() {
+  public function renderLayout() {
     if (empty($this->prep_run)) {
       $this->prepare();
     }
@@ -102,7 +102,7 @@ class LayoutRendererEditorParagraphs extends LayoutRendererEditor {
   /**
    * {@inheritdoc}
    */
-  function renderRegion($region_id, $blocks) {
+  public function renderRegion($region_id, $blocks) {
     $output = '';
     $content = implode('', $blocks);
     $region_buttons = $this->getRegionLinks($region_id);
@@ -121,7 +121,7 @@ class LayoutRendererEditorParagraphs extends LayoutRendererEditor {
   /**
    * Render the Page Title region in the Layout Editor.
    */
-  function renderTitleRegion($region_id) {
+  public function renderTitleRegion($region_id) {
     $region_buttons = $this->getRegionLinks($region_id);
     $description = layout_get_title_description($this->layout);
 
@@ -139,7 +139,7 @@ class LayoutRendererEditorParagraphs extends LayoutRendererEditor {
   /**
    * {@inheritdoc}
    */
-  function renderBlock($block) {
+  public function renderBlock($block) {
     $aria_label = $this->getAriaLabel($block);
     $buttons = $this->getBlockLinks($block);
     $content = $block->getAdminPreview();
@@ -175,7 +175,7 @@ class LayoutRendererEditorParagraphs extends LayoutRendererEditor {
    * Overrides LayoutRendererStandard::prepareBlocks() to process Layout
    * Paragraphs blocks.
    */
-  function prepareBlocks(array $blocks) {
+  public function prepareBlocks(array $blocks) {
     // Use local variables as writing to them is very slightly faster.
     $first = $normal = $last = array();
 
@@ -234,7 +234,7 @@ class LayoutRendererEditorParagraphs extends LayoutRendererEditor {
   /**
    * {@inheritdoc}
    */
-  function renderBlocks() {
+  public function renderBlocks() {
     $this->rendered['blocks'] = array();
     foreach ($this->prepared['blocks'] as $uuid => $block) {
       $block->uuid = $uuid;
@@ -246,7 +246,7 @@ class LayoutRendererEditorParagraphs extends LayoutRendererEditor {
   /**
    * Returns an aria label for a block.
    */
-  function getAriaLabel($block) {
+  public function getAriaLabel($block) {
     return t('Draggable block !title', array('!title' => strip_tags($block->getAdminTitle())));
   }
 
@@ -262,7 +262,7 @@ class LayoutRendererEditorParagraphs extends LayoutRendererEditor {
    * @return string
    *   A Backdrop menu path.
    */
-  function getUrl($command) {
+  public function getUrl($command) {
     $args = func_get_args();
     $command = array_shift($args);
     $url = 'admin/structure/paragraphs/layouts/manage/' . $this->layout->name . '/' . $command . '/' . $this->plugin['name'];

modules/layout_paragraphs/plugins/renderers/layout_renderer_paragraphs.inc

@@ -8,57 +8,57 @@ class LayoutRendererParagraphs extends LayoutRendererFlexible {
    *
    * @var Layout
    */
-  var $layout;
+  public $layout;
 
   /**
    * Deprecated. Now replaced by $layout_template_info.
    *
    * @var NULL
    * @deprecated since 1.29.0
    */
-  var $layout_info;
+  public $layout_info;
 
   /**
    * The information from hook_layout_template_info() for the layout template.
    *
    * @var array
    */
-  var $layout_template_info;
+  public $layout_template_info;
 
   /**
    * The complete rendered editor.
    *
    * @var array
    */
-  var $rendered_editor = array();
+  public $rendered_editor = array();
 
   /**
    * TRUE if this renderer is rendering in administrative mode.
    *
    * @var bool
    */
-  var $admin = TRUE;
+  public $admin = TRUE;
 
   /**
    * Include rendered HTML prior to the layout.
    *
    * @var string
    */
-  var $prefix = '';
+  public $prefix = '';
 
   /**
    * Include rendered HTML after the layout.
    *
    * @var string
    */
-  var $suffix = '';
+  public $suffix = '';
 
   /**
    * An array of dropbutton links to administrative actions on editor rows.
    *
    * @var array
    */
-  var $region_buttons = array();
+  public $region_buttons = array();
 
   /**
    * Construct the object that will be used to render the editor.
@@ -68,7 +68,7 @@ class LayoutRendererParagraphs extends LayoutRendererFlexible {
    * @param array $renderer_plugin
    *   The definition of the renderer plugin.
    */
-  function __construct(Layout $layout, array $renderer_plugin = array()) {
+  public function __construct(Layout $layout, array $renderer_plugin = array()) {
     $template_id = $layout->layout_template;
 
     $template_info = layout_paragraphs_get_layout_template_info($template_id);
@@ -90,7 +90,7 @@ class LayoutRendererParagraphs extends LayoutRendererFlexible {
    * @return string
    *   Themed & rendered HTML output.
    */
-  function render() {
+  public function render() {
     $this->addMeta();
 
     $output = '<div id="layout-paragraphs-edit-main">';
@@ -109,7 +109,7 @@ class LayoutRendererParagraphs extends LayoutRendererFlexible {
    * @return string
    *   The HTML string representing the entire rendered, themed template editor.
    */
-  function renderEditor() {
+  public function renderEditor() {
     $this->renderRowButtons();
 
     module_load_include('inc', 'layout', 'layout.theme');
@@ -134,7 +134,7 @@ class LayoutRendererParagraphs extends LayoutRendererFlexible {
   /**
    * Attach page metadata.
    */
-  function addMeta() {
+  public function addMeta() {
     backdrop_add_library('system', 'backdrop.ajax');
     backdrop_add_library('system', 'ui.sortable');
     backdrop_add_js(backdrop_get_path('module', 'layout') . '/js/layout.admin.js');
@@ -145,7 +145,7 @@ class LayoutRendererParagraphs extends LayoutRendererFlexible {
   /**
    * Render row dropbuttons.
    */
-  function renderRowButtons() {
+  public function renderRowButtons() {
     foreach ($this->layout_template_info['regions'] as $region_id => $title) {
       $this->region_buttons[$region_id] = $this->getRowButtons($region_id);
     }

modules/layout_paragraphs/plugins/renderers/layout_renderer_standard_paragraphs.inc

@@ -22,18 +22,21 @@ class LayoutRendererStandardParagraphs extends LayoutRendererStandard {
    *
    * @param Layout $layout
    *   The layout object to be rendered.
-   * @param array $plugin
+   * @param array $renderer_plugin
    *   The definition of the renderer plugin.
    *
    * @throws LayoutMissingException
    */
-  function __construct(Layout $layout, array $renderer_plugin) {
+  public function __construct(Layout $layout, array $renderer_plugin) {
     $this->plugin = $renderer_plugin;
     $layout_template_info = layout_paragraphs_get_layout_template_info($layout->layout_template);
     $this->layout = &$layout;
 
     if (empty($layout_template_info)) {
-      throw new LayoutMissingException(t('The layout plugin "@plugin" could not been found to display the "@title" layout.', array('@plugin' => $layout->layout_template, '@title' => $layout->title)));
+      throw new LayoutMissingException(t('The layout plugin "@plugin" could not been found to display the "@title" layout.', array(
+        '@plugin' => $layout->layout_template,
+        '@title' => $layout->title,
+      )));
     }
     else {
       $this->layout_template_info = $layout_template_info;
@@ -46,7 +49,7 @@ class LayoutRendererStandardParagraphs extends LayoutRendererStandard {
    * @return array
    *   An array of regions prepared for rendering.
    */
-  function prepareRegions(array $region_block_list, array $settings) {
+  public function prepareRegions(array $region_block_list, array $settings) {
     // Initialize defaults to be used for regions without their own explicit
     // settings. Use display settings if they exist, else hardcoded defaults.
     $default = array(
@@ -173,7 +176,11 @@ class LayoutRendererStandardParagraphs extends LayoutRendererStandard {
       $classes = array_filter($classes);
     }
 
-    return theme('layout_region_inner', array('blocks' => $blocks, 'tag' => $tag, 'classes' => $classes));
+    return theme('layout_region_inner', array(
+      'blocks' => $blocks,
+      'tag' => $tag,
+      'classes' => $classes,
+    ));
   }
 
   /**
@@ -197,7 +204,7 @@ class LayoutRendererStandardParagraphs extends LayoutRendererStandard {
   /**
    * Overrides LayoutRendererStandard::renderBlock().
    *
-   * @param Block $block
+   * @param mixed $block
    *   The block to be rendered.
    *
    * @return string
@@ -215,7 +222,10 @@ class LayoutRendererStandardParagraphs extends LayoutRendererStandard {
         );
       }
       // Add the contextual links.
-      $content['#contextual_links']['layout'] = array('admin/structure/layouts/manage/' . $this->layout->name . '/modal', array($block->uuid));
+      $content['#contextual_links']['layout'] = array(
+        'admin/structure/layouts/manage/' . $this->layout->name . '/modal',
+        array($block->uuid),
+      );
 
       $data = array(
         'content' => $content,
@@ -227,14 +237,23 @@ class LayoutRendererStandardParagraphs extends LayoutRendererStandard {
       );
 
       if (isset($style) && isset($style['block theme'])) {
-        $output = theme($style['block theme'] . '__' . $block->module . '__' . strtr($block->delta, '-', '_'), array('content' => $content, 'layout' => $this->layout, 'block' => $block, 'style' => $style, 'settings' => $block->style->settings));
+        $output = theme($style['block theme'] . '__' . $block->module . '__' . strtr($block->delta, '-', '_'), array(
+          'content' => $content,
+          'layout' => $this->layout,
+          'block' => $block,
+          'style' => $style,
+          'settings' => $block->style->settings,
+        ));
       }
       else {
         // Fallback.
-        $output = theme('block', array('content' => $content, 'layout' => $this->layout, 'block' => $block));
+        $output = theme('block', array(
+          'content' => $content,
+          'layout' => $this->layout,
+          'block' => $block,
+        ));
       }
     }
     return $output;
   }
-
 }

modules/layout_paragraphs/plugins/styles/layout_style_paragraphs.inc

@@ -3,5 +3,9 @@
  * @file
  * Class providing forms and settings for Layout Paragraphs block style.
  */
+
+/**
+ * Placeholder class.
+ */
 class LayoutStyleParagraphs extends LayoutStyle {
 }

modules/layout_paragraphs/templates/block_paragraphs.tpl.php

@@ -15,7 +15,7 @@
 <div class="<?php print implode(' ', $classes); ?>"<?php print backdrop_attributes($attributes); ?>>
 
 <?php print render($title_prefix); ?>
-<?php if ($title): ?>
+<?php if ($title) : ?>
   <h2 class="block-title"><?php print $title; ?></h2>
 <?php endif; ?>
 <?php print render($title_suffix); ?>