From 749ac0458fbec43bc7bdb56bf8331d3782dd95f2 Mon Sep 17 00:00:00 2001
From: Michael Stenta <mike@mstenta.net>
Date: Wed, 10 Apr 2019 15:07:33 -0400
Subject: [PATCH] Add a new farm_fields_dynamic module to standardize the
 creation of dynamic fields.

---
 .../farm_fields_dynamic.api.php               | 54 +++++++++++
 .../farm_fields_dynamic.info                  |  5 +
 .../farm_fields_dynamic.install               | 94 +++++++++++++++++++
 .../farm_fields_dynamic.module                |  6 ++
 4 files changed, 159 insertions(+)
 create mode 100644 modules/farm/farm_fields/farm_fields_dynamic/farm_fields_dynamic.api.php
 create mode 100644 modules/farm/farm_fields/farm_fields_dynamic/farm_fields_dynamic.info
 create mode 100644 modules/farm/farm_fields/farm_fields_dynamic/farm_fields_dynamic.install
 create mode 100644 modules/farm/farm_fields/farm_fields_dynamic/farm_fields_dynamic.module

diff --git a/modules/farm/farm_fields/farm_fields_dynamic/farm_fields_dynamic.api.php b/modules/farm/farm_fields/farm_fields_dynamic/farm_fields_dynamic.api.php
new file mode 100644
index 000000000..5f10d1127
--- /dev/null
+++ b/modules/farm/farm_fields/farm_fields_dynamic/farm_fields_dynamic.api.php
@@ -0,0 +1,54 @@
+<?php
+
+/**
+ * @file
+ * Hooks provided by farm_fields_dynamic.
+ *
+ * This file contains no working PHP code; it exists to provide additional
+ * documentation for doxygen as well as to document hooks in the standard
+ * Drupal manner.
+ */
+
+/**
+ * @defgroup farm_fields_dynamic Farm dynamic field module integrations.
+ *
+ * Module integrations with the farm_fields_dynamic module.
+ */
+
+/**
+ * @defgroup farm_fields_dynamic_hooks Farm dynamic field's hooks
+ * @{
+ * Hooks that can be implemented by other modules in order to extend farm_fields_dynamic.
+ */
+
+/**
+ * Define dynamic field bases.
+ *
+ * @return array
+ *   An array of field base definitions, keyed by field name.
+ */
+function hook_farm_fields_dynamic_bases() {
+  return array(
+    'my_field' => array(
+      // ...
+    ),
+  );
+}
+
+/**
+ * Define dynamic field instances.
+ *
+ * @return array
+ *   An array of field instance definitions.
+ */
+function hook_farm_fields_dynamic_instances() {
+  return array(
+    array(
+      // ...
+    ),
+  );
+}
+
+/**
+ * @}
+ */
diff --git a/modules/farm/farm_fields/farm_fields_dynamic/farm_fields_dynamic.info b/modules/farm/farm_fields/farm_fields_dynamic/farm_fields_dynamic.info
new file mode 100644
index 000000000..bb1035c2e
--- /dev/null
+++ b/modules/farm/farm_fields/farm_fields_dynamic/farm_fields_dynamic.info
@@ -0,0 +1,5 @@
+name = Farm Fields Dynamic
+description = Provides the ability for modules to define fields dynamically.
+core = 7.x
+package = farmOS
+dependencies[] = field
diff --git a/modules/farm/farm_fields/farm_fields_dynamic/farm_fields_dynamic.install b/modules/farm/farm_fields/farm_fields_dynamic/farm_fields_dynamic.install
new file mode 100644
index 000000000..80377c50d
--- /dev/null
+++ b/modules/farm/farm_fields/farm_fields_dynamic/farm_fields_dynamic.install
@@ -0,0 +1,94 @@
+<?php
+
+/**
+ * @file
+ * Farm fields dynamic install.
+ */
+
+/**
+ * Implements hook_install().
+ */
+function farm_fields_dynamic_install() {
+
+  // When this module is installed, create dynamic field bases and instances (if
+  // necessary).
+  farm_fields_dynamic_base_create();
+  farm_fields_dynamic_instances_create();
+}
+
+/**
+ * Implements hook_modules_installed().
+ */
+function farm_fields_dynamic_modules_installed() {
+
+  // When another module is installed, create dynamic field bases and instances
+  // (if necessary).
+  farm_fields_dynamic_base_create();
+  farm_fields_dynamic_instances_create();
+}
+
+/**
+ * Create data field base.
+ */
+function farm_fields_dynamic_base_create() {
+
+  // Load field types.
+  $field_types = field_info_fields();
+
+  // Get dynamic field base definitions.
+  $dynamic_field_bases = module_invoke_all('farm_fields_dynamic_bases');
+
+  // Iterate through the field base definitions.
+  foreach ($dynamic_field_bases as $field_base) {
+
+    // If the field name is not available, skip it.
+    if (!empty($field_base['field_name'])) {
+      $field_name = $field_base['field_name'];
+    }
+    else {
+      continue;
+    }
+
+    // If the field base already exists, skip it.
+    if (!empty($field_types[$field_name])) {
+      continue;
+    }
+
+    // Create the field base.
+    field_create_field($field_base);
+  }
+}
+
+/**
+ * Create data field instances.
+ */
+function farm_fields_dynamic_instances_create() {
+
+  // Load existing field instances.
+  $field_instances = field_info_instances();
+
+  // Get dynamic field instance definitions.
+  $dynamic_field_instances = module_invoke_all('farm_fields_dynamic_instances');
+
+  // Iterate through the dynamic field instances.
+  foreach ($dynamic_field_instances as $field_instance) {
+
+    // If the entity type, bundle, or field name are not available, bail.
+    if (!empty($field_instance['entity_type']) && !empty($field_instance['bundle']) && !empty($field_instance['field_name'])) {
+      $entity_type = $field_instance['entity_type'];
+      $bundle = $field_instance['bundle'];
+      $field_name = $field_instance['field_name'];
+    }
+    else {
+      continue;
+    }
+
+    // If the instance already exists, skip it.
+    if (!empty($field_instances[$entity_type][$bundle][$field_name])) {
+      continue;
+    }
+
+    // Create the field instance.
+    field_create_instance($field_instance);
+  }
+}
diff --git a/modules/farm/farm_fields/farm_fields_dynamic/farm_fields_dynamic.module b/modules/farm/farm_fields/farm_fields_dynamic/farm_fields_dynamic.module
new file mode 100644
index 000000000..b7ea68a93
--- /dev/null
+++ b/modules/farm/farm_fields/farm_fields_dynamic/farm_fields_dynamic.module
@@ -0,0 +1,6 @@
+<?php
+
+/**
+ * @file
+ * Farm fields dynamic module.
+ */