Version 1

[yaffs-website] / web / core / modules / forum / src / Plugin / Block / ForumBlockBase.php

diff --git a/web/core/modules/forum/src/Plugin/Block/ForumBlockBase.php b/web/core/modules/forum/src/Plugin/Block/ForumBlockBase.php
new file mode 100644 (file)
index 0000000..8095cef
--- /dev/null
+++ b/web/core/modules/forum/src/Plugin/Block/ForumBlockBase.php
@@ -0,0 +1,96 @@
+<?php
+
+namespace Drupal\forum\Plugin\Block;
+
+use Drupal\Core\Access\AccessResult;
+use Drupal\Core\Block\BlockBase;
+use Drupal\Core\Cache\Cache;
+use Drupal\Core\Form\FormStateInterface;
+use Drupal\Core\Session\AccountInterface;
+use Drupal\Core\Url;
+
+/**
+ * Provides a base class for Forum blocks.
+ */
+abstract class ForumBlockBase extends BlockBase {
+
+  /**
+   * {@inheritdoc}
+   */
+  public function build() {
+    $result = $this->buildForumQuery()->execute();
+    $elements = [];
+    if ($node_title_list = node_title_list($result)) {
+      $elements['forum_list'] = $node_title_list;
+      $elements['forum_more'] = [
+        '#type' => 'more_link',
+        '#url' => Url::fromRoute('forum.index'),
+        '#attributes' => ['title' => $this->t('Read the latest forum topics.')],
+      ];
+    }
+    return $elements;
+  }
+
+  /**
+   * Builds the select query to use for this forum block.
+   *
+   * @return \Drupal\Core\Database\Query\Select
+   *   A Select object.
+   */
+  abstract protected function buildForumQuery();
+
+  /**
+   * {@inheritdoc}
+   */
+  public function defaultConfiguration() {
+    return [
+      'properties' => [
+        'administrative' => TRUE,
+      ],
+      'block_count' => 5,
+    ];
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  protected function blockAccess(AccountInterface $account) {
+    return AccessResult::allowedIfHasPermission($account, 'access content');
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public function blockForm($form, FormStateInterface $form_state) {
+    $range = range(2, 20);
+    $form['block_count'] = [
+      '#type' => 'select',
+      '#title' => $this->t('Number of topics'),
+      '#default_value' => $this->configuration['block_count'],
+      '#options' => array_combine($range, $range),
+    ];
+    return $form;
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public function blockSubmit($form, FormStateInterface $form_state) {
+    $this->configuration['block_count'] = $form_state->getValue('block_count');
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public function getCacheContexts() {
+    return Cache::mergeContexts(parent::getCacheContexts(), ['user.node_grants:view']);
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public function getCacheTags() {
+    return Cache::mergeTags(parent::getCacheTags(), ['node_list']);
+  }
+
+}