added show channel types setting (#7)

* added show channel types setting * add textfield to labels * removed unused var * fixed cachable dependency Co-authored-by: Arsene Claudiu Ion <[email protected]>
dragos-dumi-ibm · Nov 9, 2022 · 3d074f5 · 3d074f5
1 parent e51e443
commit 3d074f5
Showing 1 changed file with 44 additions and 11 deletions.
diff --git a/src/Plugin/Field/FieldFormatter/ErrandServicesFormatter.php b/src/Plugin/Field/FieldFormatter/ErrandServicesFormatter.php
@@ -9,6 +9,7 @@
 use Drupal\Core\Field\FieldItemListInterface;
 use Drupal\Core\Field\FormatterBase;
 use Drupal\Core\Form\FormStateInterface;
+use Drupal\helfi_tpr\Entity\ChannelType;
 use Drupal\helfi_tpr\Entity\ChannelTypeCollection;
 use Drupal\helfi_tpr\Entity\Service;
 
@@ -34,6 +35,25 @@ public static function defaultSettings() {
       ] + parent::defaultSettings();
   }
 
+  /**
+   * {@inheritdoc}
+   */
+  public function settingsSummary() {
+    $settings = $this->getSetting('sort_order');
+    $selected_channels = [];
+    foreach ($settings as $channel_type => $channel_setting) {
+      if ($channel_setting['show']) {
+        $selected_channels[] = $channel_type;
+      }
+    }
+
+    return [
+      $this->t('Showing @list ', [
+        '@list' => implode(', ', $selected_channels)
+      ])
+    ];
+  }
+
   /**
    * Gets the channel types.
    *
@@ -56,6 +76,8 @@ public function settingsForm(array $form, FormStateInterface $form_state) {
       '#header' => [
         $this->t('ID'),
         $this->t('Label'),
+        $this->t('Show'),
+        $this->t('Label'),
         $this->t('Weight'),
       ],
       '#tableselect' => FALSE,
@@ -67,16 +89,29 @@ public function settingsForm(array $form, FormStateInterface $form_state) {
         ],
       ],
     ];
+    $channelTypes = [];
+    foreach ($this->getChannelTypes() as $channelId => $channelType) {
+      $channelTypes[$channelId] = $channelType;
+    }
+    $channelTypes['OFFICE'] = new ChannelType('OFFICE', 99);
 
-    foreach ($this->getChannelTypes() as $item) {
+
+    foreach ($channelTypes as $item) {
       $form['sort_order'][$item->id] = [
         '#attributes' => ['class' => ['draggable']],
         '#weight' => $item->weight,
         'id' => ['#plain_text' => $item->id],
-        'label' => ['#plain_text' => $item->label()],
+        'label' => [
+          '#type' => 'textfield',
+          '#default_value' => $this->getSetting('sort_order')[$item->id]['label'] ?? $item->id,
+        ],
+        'show' => [
+          '#type' => 'checkbox',
+          '#default_value' => $this->getSetting('sort_order')[$item->id]['show'] ?? 0,
+        ],
         'weight' => [
           '#type' => 'weight',
-          '#title' => $this->t('Weight for @title', ['@title' => $item->label()]),
+          '#title' => $this->t('Weight for @title', ['@title' => $item->id]),
           '#title_display' => 'invisible',
           '#default_value' => $item->weight,
           '#attributes' => ['class' => ['group-weight']],
@@ -95,7 +130,6 @@ public function viewElements(FieldItemListInterface $items, $langcode) : array {
     if (!$items->getEntity() instanceof Service) {
       throw new \InvalidArgumentException('The field can only be used with Services entities.');
     }
-
     $channelTypes = $this->getChannelTypes();
 
     /** @var \Drupal\Core\Render\Renderer $renderer */
@@ -111,17 +145,16 @@ public function viewElements(FieldItemListInterface $items, $langcode) : array {
     foreach ($errand_services as $errand_service) {
       /** @var \Drupal\helfi_tpr\Entity\ErrandService $errand_service */
       foreach ($errand_service->getChannels() as $channel) {
-        if (isset($channel_list[$channel->getType()])) {
+        if (isset($channel_list[$channel->getType()])
+        || empty($this->getSetting('sort_order')[$channel->getType()]['show'])) {
           continue;
         }
 
-        /** @var \Drupal\helfi_tpr\Entity\Channel $translatedChannel */
-        $translatedChannel = \Drupal::service('entity.repository')->getTranslationFromContext($channel, $langcode);
         $channel_list[$channel->getType()] = [
-          '#name' => $translatedChannel->type_string->value,
+          '#name' => $this->getSetting('sort_order')[$channel->getType()]['label'],
           '#weight' => $channelTypes[$channel->getType()]->weight,
         ];
-        $renderer->addCacheableDependency($item_list, $translatedChannel);
+        $renderer->addCacheableDependency($item_list, $channel);
       }
     }
 
@@ -130,8 +163,8 @@ public function viewElements(FieldItemListInterface $items, $langcode) : array {
 
     if ($service->hasField('has_unit') && $service->has_unit->value) {
       $channel_list['OFFICE'] = [
-        '#name' => $this->t('Office'),
-        '#weight' => 999,
+        '#name' => $this->getSetting('sort_order')['OFFICE']['label'],
+        '#weight' => $this->getSetting('sort_order')['OFFICE']['weight'],
       ];
     }