Merge pull request #1555 from tripal/tv4g1-issue1551-Add-chado-boolea…

…n-field

Tripal 4 add a chado boolean field

tripal/src/Entity/TripalEntity.php

@@ -477,7 +477,7 @@ public static function baseFieldDefinitions(EntityTypeInterface $entity_type) {
    * @param TripalEntity $entity
    *
    * @return array
-   *   The returned array has two elements: an an array of values as described
+   *   The returned array has two elements: an array of values as described
    *   above, and an array of TripalStorage objects,
    */
   public static function getValuesArray($entity) {
@@ -674,7 +674,7 @@ public static function postLoad(EntityStorageInterface $storage, array &$entitie
       $field_defs = $field_manager->getFieldDefinitions($entity_type_id, $bundle);
       foreach ($field_defs as $field_name => $field_def) {
 
-        // Createa  fieldItemlist and iterate through it.
+        // Create a fieldItemlist and iterate through it.
         $items = $field_type_manager->createFieldItemList($entity, $field_name, $entity->get($field_name)->getValue());
         foreach($items as $item) {
 

tripal/src/Plugin/Field/FieldFormatter/DefaultTripalBooleanTypeFormatter.php

@@ -0,0 +1,37 @@
+<?php
+
+namespace Drupal\tripal\Plugin\Field\FieldFormatter;
+
+use Drupal\tripal\TripalField\TripalFormatterBase;
+use Drupal\Core\Field\FieldItemListInterface;
+use Drupal\Core\Form\FormStateInterface;
+
+/**
+ * Plugin implementation of default Tripal boolean type formatter.
+ *
+ * @FieldFormatter(
+ *   id = "default_tripal_boolean_type_formatter",
+ *   label = @Translation("Default Boolean Type Formatter"),
+ *   description = @Translation("The default boolean type formatter."),
+ *   field_types = {
+ *     "tripal_boolean_type"
+ *   }
+ * )
+ */
+class DefaultTripalBooleanTypeFormatter extends TripalFormatterBase {
+
+  /**
+   * {@inheritdoc}
+   */
+  public function viewElements(FieldItemListInterface $items, $langcode) {
+    $elements = [];
+
+    foreach($items as $delta => $item) {
+      $elements[$delta] = [
+        "#markup" => $item->get("value")->getValue() ? 'True' : 'False',
+      ];
+    }
+
+    return $elements;
+  }
+}

tripal/src/Plugin/Field/FieldType/TripalBooleanTypeItem.php

@@ -0,0 +1,39 @@
+<?php
+
+namespace Drupal\tripal\Plugin\Field\FieldType;
+
+use Drupal\tripal\TripalField\TripalFieldItemBase;
+use Drupal\tripal\TripalStorage\BoolStoragePropertyType;
+use Drupal\tripal\TripalStorage\StoragePropertyValue;
+use Drupal\core\Form\FormStateInterface;
+use Drupal\core\Field\FieldDefinitionInterface;
+
+/**
+ * Plugin implementation of the 'boolean' field type.
+ *
+ * @FieldType(
+ *   id = "tripal_boolean_type",
+ *   label = @Translation("Tripal Boolean Field Type"),
+ *   description = @Translation("A boolean field."),
+ *   default_widget = "default_tripal_boolean_type_widget",
+ *   default_formatter = "default_tripal_boolean_type_formatter"
+ * )
+ */
+class TripalBooleanTypeItem extends TripalFieldItemBase {
+
+  public static $id = "tripal_boolean_type";
+
+  /**
+   * {@inheritdoc}
+   */
+  public static function tripalTypes($field_definition) {
+    $entity_type_id = $field_definition->getTargetEntityTypeId();
+    $storage_settings = $field_definition->getSettings();
+    $termIdSpace = $storage_settings['termIdSpace'];
+    $termAccession = $storage_settings['termAccession'];
+
+    return [
+      new BoolStoragePropertyType($entity_type_id, self::$id, "value", $termIdSpace . ':' . $termAccession),
+    ];
+  }
+}

tripal/src/Plugin/Field/FieldWidget/TripalBooleanTypeWidget.php

@@ -0,0 +1,35 @@
+<?php
+
+namespace Drupal\tripal\Plugin\Field\FieldWidget;
+
+use Drupal\tripal\TripalField\TripalWidgetBase;
+use Drupal\Core\Field\FieldItemListInterface;
+use Drupal\Core\Form\FormStateInterface;
+
+/**
+ * Plugin implementation of default Tripal boolean type widget.
+ *
+ * @FieldWidget(
+ *   id = "default_tripal_boolean_type_widget",
+ *   label = @Translation("Tripal Boolean Widget"),
+ *   description = @Translation("The default boolean type widget."),
+ *   field_types = {
+ *     "tripal_boolean_type"
+ *   }
+ * )
+ */
+class TripalBooleanTypeWidget extends TripalWidgetBase {
+
+
+  /**
+   * {@inheritdoc}
+   */
+  public function formElement(FieldItemListInterface $items, $delta, array $element, array &$form, FormStateInterface $form_state) {
+    $element['value'] = $element + [
+      '#type' => 'checkbox',
+      '#default_value' => $items[$delta]->value ?? NULL,
+      '#placeholder' => $this->getSetting('placeholder'),
+    ];
+    return $element;
+  }
+}

tripal/src/Services/TripalFieldCollection.php

@@ -237,7 +237,7 @@ public function validate($field_def) : bool {
     else {
       $field_types = \Drupal::service('plugin.manager.field.field_type')->getDefinitions();
       if (!in_array($field_def['type'], array_keys($field_types))) {
-        $this->logger->error('The field type, ' . $field_def['type'] . ' is not a valide field type.');
+        $this->logger->error('The field type, "' . $field_def['type'] . '", is not a valid field type.');
         return FALSE;
       }
     }

tripal/src/TripalField/TripalFieldItemBase.php

@@ -9,6 +9,7 @@
 use Drupal\tripal\TripalStorage\IntStoragePropertyType;
 use Drupal\tripal\TripalStorage\VarCharStoragePropertyType;
 use Drupal\tripal\TripalStorage\TextStoragePropertyType;
+use Drupal\tripal\TripalStorage\BoolStoragePropertyType;
 use Drupal\tripal\TripalStorage\StoragePropertyValue;
 use Drupal\Core\TypedData\DataDefinition;
 use \RuntimeException;
@@ -277,8 +278,11 @@ public static function propertyDefinitions(FieldStorageDefinitionInterface $fiel
       else if ($type instanceof TextStoragePropertyType) {
         $properties[$type->getKey()] = DataDefinition::create("string");
       }
+      else if ($type instanceof BoolStoragePropertyType) {
+        $properties[$type->getKey()] = DataDefinition::create("boolean");
+      }
       else {
-        throw new RuntimeException("Unknown Tripal Property Type class.");
+        throw new RuntimeException('Unknown Tripal Property Type class "' . get_class($type) . '"');
       }
     }
 
@@ -314,8 +318,16 @@ public static function schema(FieldStorageDefinitionInterface $field_definition)
         ];
         $schema["columns"][$type->getKey()] = $column;
       }
+      else if ($type instanceof BoolStoragePropertyType) {
+        $column = [
+          "type" => "int",
+          "size" => "tiny",
+          "pgsql_type" => "boolean",
+        ];
+        $schema["columns"][$type->getKey()] = $column;
+      }
       else {
-        throw new RuntimeException("Unknown Tripal Property Type class.");
+        throw new RuntimeException('Unknown Tripal Property Type class "' . get_class($type) . '"');
       }
     }