In progress

GetDKAN · beeyayjay · Apr 29, 2024 · May 14, 2024 · May 20, 2024 · May 24, 2024
commit ae7e367459688ee8914eda118f13dcc27d787def
diff --git a/modules/data_dictionary_widget/data_dictionary_widget.module b/modules/data_dictionary_widget/data_dictionary_widget.module
@@ -51,9 +51,18 @@ function data_dictionary_widget_theme($existing, $type, $theme, $path) {
  */
 function data_dictionary_widget_entity_form_display_alter(EntityFormDisplayInterface $form_display, array $context) {
   if (data_dictionary_widget__data_dictionary_data_type_checker($context) === 'data-dictionary') {
-    $form_display->setComponent('field_json_metadata', [
-      'type' => 'data_dictionary_widget',
-    ]);
+    $index = \Drupal::request()->query->get('index');
+    if (isset($index)) {
+      $form_display->setComponent('field_json_metadata', [
+        'type' => 'data_index_widget',
+        'settings' => ['index' => $index],
+      ]);
+    }
+    else {
+      $form_display->setComponent('field_json_metadata', [
+        'type' => 'data_dictionary_widget',
+      ]);
+    }
   }
 }
 

diff --git a/modules/data_dictionary_widget/src/Plugin/Field/FieldWidget/AbstractMetadataWidget.php b/modules/data_dictionary_widget/src/Plugin/Field/FieldWidget/AbstractMetadataWidget.php
@@ -7,11 +7,8 @@
 use Drupal\Core\Field\WidgetBase;
 use Drupal\Core\Form\FormStateInterface;
 use Drupal\Core\Security\TrustedCallbackInterface;
-use Drupal\data_dictionary_widget\Fields\FieldCreation;
 use Drupal\data_dictionary_widget\Fields\FieldOperations;
 use Drupal\Core\Entity\EntityFormInterface;
-use Drupal\data_dictionary_widget\Indexes\IndexFieldCreation;
-use Drupal\data_dictionary_widget\Indexes\IndexFieldOperations;
 
 /**
  * A data-dictionary widget.
@@ -37,7 +34,7 @@ public function formElement(FieldItemListInterface $items, $delta, array $elemen
     $field_json_metadata = !empty($items[0]->value) ? json_decode($items[0]->value, TRUE) : [];
 
     // Retrieve initial data results from field JSON metadata.
-    $data_results = $this->getFieldResults($field_json_metadata);
+    $data_results = $field_json_metadata['data']['fields'] ?? [];
 
     // Process data results.
     $data_results = $this->processDataResults($data_results, $current_fields, $field_values, $op);
@@ -49,10 +46,10 @@ public function formElement(FieldItemListInterface $items, $delta, array $elemen
     $element['dictionary_fields']['#pre_render'] = [[$this, 'preRenderForm']];
 
     // Add data rows to display in tables.
-    $element['dictionary_fields']['data'] = $this->createDictionaryDataRows($current_fields, $data_results, $form_state);
+    $element['dictionary_fields']['data'] = $this->createDataRows($current_fields, $data_results, $form_state);
 
     // Create dictionary fields/buttons for editing.
-    $element['dictionary_fields'] = $this->createDictionaryFieldOptions($op_index, $data_results, $fields_being_modified, $element['dictionary_fields']);
+    $element['dictionary_fields'] = $this->createFieldOptions($op_index, $data_results, $fields_being_modified, $element['dictionary_fields']);
     $element['dictionary_fields']['add_row_button']['#access'] = $fields_being_modified == NULL;
 
     // Get form entity.
@@ -67,24 +64,13 @@ public function formElement(FieldItemListInterface $items, $delta, array $elemen
       $form_entity->set('field_data_type', 'data-dictionary');
     }
 
-    // Set form state for adding fields and indexes.
+    // Set form state for adding and editing fields.
     $element = $this->setAddDictionaryFieldFormState($add_new_field, $element);
     $element = $this->editDictionaryFieldFormState($fields_being_modified, $element);
 
     return $element;
   }
 
-  /**
-   * Get field array from json metadata
-   *
-   * @param array $field_json_metadata
-   *   The json metadata array
-   *
-   * @return array
-   *   Array asociative array of field names and field values.
-   */
-  abstract protected function getFieldResults(array $field_json_metadata) : array;
-
   /**
    * Cleaning the data up.
    */
@@ -181,6 +167,6 @@ protected static function checkEditingField($key, $op_index, $fields_being_modif
     }
   }
 
-  abstract protected static function createDictionaryDataRows($current_dictionary_fields, $data_results, $form_state);
+  abstract protected static function createDataRows($current_dictionary_fields, $data_results, $form_state);
 
 }
diff --git a/modules/data_dictionary_widget/src/Plugin/Field/FieldWidget/DataDictionaryWidget.php b/modules/data_dictionary_widget/src/Plugin/Field/FieldWidget/DataDictionaryWidget.php
@@ -9,12 +9,8 @@
 use Drupal\Core\Form\FormStateInterface;
 use Drupal\Core\Security\TrustedCallbackInterface;
 use Drupal\data_dictionary_widget\Fields\FieldButtons;
-use Drupal\data_dictionary_widget\Fields\FieldCreation;
 use Drupal\data_dictionary_widget\Fields\FieldEditCreation;
 use Drupal\data_dictionary_widget\Fields\FieldOperations;
-use Drupal\Core\Entity\EntityFormInterface;
-use Drupal\data_dictionary_widget\Indexes\IndexFieldCreation;
-use Drupal\data_dictionary_widget\Indexes\IndexFieldOperations;
 
 /**
  * A data-dictionary widget.
@@ -29,13 +25,6 @@
  */
 class DataDictionaryWidget extends AbstractMetadataWidget implements TrustedCallbackInterface {
 
-  /**
-   * @inheritDoc
-   */
-  protected function getFieldResults(array $field_json_metadata) : array {
-    return $field_json_metadata['data']['fields'] ?? [];
-  }
-
   protected function processDataResults($data_results, $current_fields, $field_values, $op) {
     if (isset($current_fields)) {
       $data_results = $current_fields;
@@ -254,18 +243,6 @@ public function preRenderForm(array $dictionaryFields) {
 //    return IndexFieldOperations::setIndexAjaxElements($indexes);
 //  }
 
-  /**
-   * {@inheritdoc}
-   */
-  public static function trustedCallbacks() {
-    return [
-      'preRenderForm',
-//      'preRenderIndexFieldFormOnAdd',
-//      'preRenderIndexFieldForm',
-//      'preRenderIndexForm',
-    ];
-  }
-
   /**
    * {@inheritdoc}
    */
@@ -292,7 +269,7 @@ protected function createGeneralFields($element, $field_json_metadata, $current_
   /**
    * @inheritDoc
    */
-  protected function createDictionaryFieldOptions($op_index, $data_results, $fields_being_modified, $element) {
+  protected function createFieldOptions($op_index, $data_results, $fields_being_modified, $element) {
     // Creating ajax buttons/fields to be placed in correct location later.
     foreach ($data_results as $key => $data) {
       if (self::checkEditingField($key, $op_index, $fields_being_modified)) {
@@ -336,7 +313,7 @@ protected function editDictionaryFieldFormState($fields_being_modified, $element
   public function massageFormValues(array $values, array $form, FormStateInterface $form_state) {
     $current_fields = $form["field_json_metadata"]["widget"][0]["dictionary_fields"]["data"]["#rows"];
     $field_collection = $values[0]['dictionary_fields']["field_collection"]["group"] ?? [];
-    $indexes = isset($values[0]["indexes"]) ? json_decode($values[0]["indexes"]) : NULL;
+    $indexes = isset($values[0]["indexes"]) ? json_decode($values[0]["indexes"]) : [];
 
     $data_results = !empty($field_collection) ? [
       [
@@ -355,14 +332,14 @@ public function massageFormValues(array $values, array $form, FormStateInterface
       'data' => [
         'title' => $values[0]['title'] ?? '',
         'fields' => $updated,
-        'indexes' => $indexes ?? [],
+        'indexes' => $indexes,
       ],
     ];
 
     return json_encode($json_data);
   }
 
-  protected static function createDictionaryDataRows($current_dictionary_fields, $data_results, $form_state) {
+  protected static function createDataRows($current_dictionary_fields, $data_results, $form_state) {
 
     return [
       '#access' => ((bool) $current_dictionary_fields || (bool) $data_results),
@@ -375,4 +352,23 @@ protected static function createDictionaryDataRows($current_dictionary_fields, $
 
   }
 
+  /**
+   * @inheritDoc
+   */
+  protected function createDictionaryFieldOptions($op_index, $data_results, $fields_being_modified, $element) {
+    $current_fields = $element['current_dictionary_fields'];
+    // Creating ajax buttons/fields to be placed in correct location later.
+    foreach ($data_results as $key => $data) {
+      if (self::checkEditingField($key, $op_index, $fields_being_modified)) {
+        $element['edit_fields'][$key] = FieldEditCreation::editFields($key, $current_fields, $fields_being_modified);
+      }
+      else {
+        $element['edit_buttons'][$key]['edit_button'] = FieldButtons::editButtons($key);
+      }
+    }
+    $element['add_row_button'] = FieldButtons::addButton();
+
+    return $element;
+  }
+
 }
diff --git a/modules/data_dictionary_widget/src/Plugin/Field/FieldWidget/DataIndexWidget.php b/modules/data_dictionary_widget/src/Plugin/Field/FieldWidget/DataIndexWidget.php
@@ -0,0 +1,135 @@
+<?php
+
+namespace Drupal\data_dictionary_widget\Plugin\Field\FieldWidget;
+
+use Drupal\Core\Entity\FieldableEntityInterface;
+use Drupal\Core\Field\FieldItemListInterface;
+use Drupal\Core\Field\WidgetBase;
+use Drupal\Core\Form\FormStateInterface;
+use Drupal\Core\Security\TrustedCallbackInterface;
+use Drupal\data_dictionary_widget\Fields\FieldCreation;
+use Drupal\data_dictionary_widget\Fields\FieldOperations;
+use Drupal\Core\Entity\EntityFormInterface;
+use Drupal\data_dictionary_widget\Indexes\IndexFieldCreation;
+use Drupal\data_dictionary_widget\Indexes\IndexFieldOperations;
+
+/**
+ * A data-dictionary widget.
+ *
+ * @FieldWidget(
+ *   id = "data_index_widget",
+ *   label = @Translation("Data-Dictionary Index Widget"),
+ *   field_types = {
+ *     "string_long"
+ *   }
+ * )
+ */
+class DataIndexWidget extends AbstractMetadataWidget implements TrustedCallbackInterface {
+
+  /**
+   * {@inheritdoc}
+   */
+  public function massageFormValues(array $values, array $form, FormStateInterface $form_state) {
+    $current_fields = $form["field_json_metadata"]["widget"][0]["dictionary_fields"]["data"]["#rows"] ?? [];
+    $field_collection = $values[0]["indexes"]["fields"]["field_collection"]["group"] ?? [];
+    $dictionary_collection = $values[0]['dictionary_fields']["field_collection"]["group"] ?? [];
+
+    $data_results = !empty($field_collection) ? [
+      [
+        "name" => $index_fields["name"] ?? '',
+        "length" => isset($index_fields["length"]) ? (int) $index_fields["length"] : 0,
+      ],
+    ] : [];
+
+    $updated = array_merge($current_fields ?? [], $data_results);
+
+    $json_data = [
+      'identifier' => $values[0]['identifier'] ?? '',
+      'data' => [
+        'title' => $values[0]['title'] ?? '',
+        'fields' => $dictionary_collection,
+        'indexes' => $updated,
+      ],
+    ];
+
+    return json_encode($json_data);
+  }
+
+  /**
+   * Prerender callback for the index field form.
+   *
+   * Moves the buttons into the table.
+   */
+  public function preRenderForm(array $dictionaryFields) {
+    return IndexFieldOperations::setIndexFieldsAjaxElements($dictionaryFields);
+  }
+
+//  /**
+//   * Prerender callback for the index field form.
+//   *
+//   * Moves the buttons into the table.
+//   */
+//  public function preRenderIndexFieldFormOnAdd(array $indexFields) {
+//    return IndexFieldOperations::setIndexFieldsAjaxElementsOnAdd($indexFields);
+//  }
+//
+//  /**
+//   * {@inheritdoc}
+//   */
+//  public static function trustedCallbacks() {
+//    return [
+//      'preRenderForm',
+//      'preRenderIndexFieldFormOnAdd',
+//      'preRenderIndexFieldForm',
+//      'preRenderIndexForm',
+//    ];
+//  }
+
+
+  /**
+   * @inheritDoc
+   */
+  protected function processDataResults($data_results, $current_fields, $field_values, $op) {
+    return IndexFieldOperations::processIndexFieldsDataResults($data_results, $current_fields, $field_values, $op);
+  }
+
+  protected function createGeneralFields($element, $field_json_metadata, $current_fields, $form_state) {
+    $element['identifier'] = self::createField('identifier', $field_json_metadata, $form_state);
+    $element['title'] = self::createField('title', $field_json_metadata, $form_state);
+
+    $element['dictionary_fields'] = [
+      '#type' => 'fieldset',
+      '#title' => t('Fields'),
+      '#prefix' => '<div id = field-json-metadata-index-fields>',
+      '#suffix' => '</div>',
+      '#markup' => t('<div class="claro-details__description">One or more fields included in index. Must be keys from the fields object.</div>'),
+      '#required' => TRUE,
+    ];
+    $element['dictionary_fields']['current_dictionary_fields'] = $current_fields;
+
+    return $element;
+  }
+
+  /**
+   * @inheritDoc
+   */
+  protected function createDictionaryFieldOptions($op_index, $data_results, $fields_being_modified, $element) {
+    // TODO: Implement createDictionaryFieldOptions() method.
+  }
+
+  protected function setAddDictionaryFieldFormState($add_new_field, $element) {
+    // TODO: Implement setAddDictionaryFieldFormState() method.
+  }
+
+  /**
+   * @inheritDoc
+   */
+  protected function editDictionaryFieldFormState($fields_being_modified, $element) {
+    // TODO: Implement editDictionaryFieldFormState() method.
+  }
+
+  protected static function createDataRows($current_dictionary_fields, $data_results, $form_state) {
+    // TODO: Implement createDataRows() method.
+  }
+
+}