Add support for log bundle plugins.

docs/development/module/index.md

@@ -49,7 +49,7 @@ type: module
 package: farmOS Contrib
 core_version_requirement: ^9
 dependencies:
-  - log:log
+  - farm:farm_log
 ```
 
 Other common files and directories in a module include:

modules/asset/equipment/tests/modules/farm_equipment_field_test/farm_equipment_field_test.info.yml

@@ -5,4 +5,4 @@ package: Testing
 core_version_requirement: ^9
 dependencies:
   - farm:farm_field
-  - log:log
+  - farm:farm_log

modules/asset/equipment/tests/modules/farm_equipment_field_test/src/Plugin/Log/LogType/Test.php

@@ -0,0 +1,17 @@
+<?php
+
+namespace Drupal\farm_equipment_field_test\Plugin\Log\LogType;
+
+use Drupal\farm_log\Plugin\Log\LogType\LogTypeBase;
+
+/**
+ * Provides the test log type.
+ *
+ * @LogType(
+ *   id = "test",
+ *   label = @Translation("Test"),
+ * )
+ */
+class Test extends LogTypeBase {
+
+}

modules/core/field/tests/modules/farm_field_test/src/Plugin/Asset/AssetType/Test.php

@@ -0,0 +1,17 @@
+<?php
+
+namespace Drupal\farm_field_test\Plugin\Asset\AssetType;
+
+use Drupal\asset\Plugin\Asset\AssetType\AssetTypeBase;
+
+/**
+ * Provides the test asset type.
+ *
+ * @AssetType(
+ *   id = "test",
+ *   label = @Translation("Test"),
+ * )
+ */
+class Test extends AssetTypeBase {
+
+}

modules/core/field/tests/modules/farm_field_test/src/Plugin/Log/LogType/Test.php

@@ -0,0 +1,17 @@
+<?php
+
+namespace Drupal\farm_field_test\Plugin\Log\LogType;
+
+use Drupal\farm_log\Plugin\Log\LogType\LogTypeBase;
+
+/**
+ * Provides the test log type.
+ *
+ * @LogType(
+ *   id = "test",
+ *   label = @Translation("Test"),
+ * )
+ */
+class Test extends LogTypeBase {
+
+}

modules/core/field/tests/modules/farm_field_test/src/Plugin/Plan/PlanType/Test.php

@@ -0,0 +1,17 @@
+<?php
+
+namespace Drupal\farm_field_test\Plugin\Plan\PlanType;
+
+use Drupal\plan\Plugin\Plan\PlanType\PlanTypeBase;
+
+/**
+ * Provides the test plan type.
+ *
+ * @PlanType(
+ *   id = "test",
+ *   label = @Translation("Test"),
+ * )
+ */
+class Test extends PlanTypeBase {
+
+}

modules/core/log/farm_log.info.yml

@@ -0,0 +1,7 @@
+name: farmOS Log
+description: Extends the Log entity type for farmOS.
+type: module
+package: farmOS
+core_version_requirement: ^9
+dependencies:
+  - log:log

modules/core/log/farm_log.module

@@ -0,0 +1,34 @@
+<?php
+
+/**
+ * @file
+ * The farmOS Log module.
+ */
+
+/**
+ * Implements hook_module_implements_alter().
+ */
+function farm_log_module_implements_alter(&$implementations, $hook) {
+
+  // Make sure this module's hook_entity_type_build() runs before the
+  // entity module's implementation, so that we can set the Log entity type's
+  // bundle_plugin_type.
+  $module = 'farm_log';
+  if ($hook == 'entity_type_build') {
+    $implementation = [$module => $implementations[$module]];
+    unset($implementations[$module]);
+    $implementations = array_merge($implementation, $implementations);
+  }
+}
+
+/**
+ * Implements hook_entity_type_build().
+ */
+function farm_log_entity_type_build(array &$entity_types) {
+
+  // Enable the use of bundle plugins for log entities.
+  /** @var \Drupal\Core\Entity\EntityTypeInterface[] $entity_types */
+  if (!empty($entity_types['log'])) {
+    $entity_types['log']->set('bundle_plugin_type', 'log_type');
+  }
+}

modules/core/log/farm_log.services.yml

@@ -0,0 +1,4 @@
+services:
+  plugin.manager.log_type:
+    class: Drupal\farm_log\LogTypeManager
+    parent: default_plugin_manager

modules/core/log/src/Annotation/LogType.php

@@ -0,0 +1,34 @@
+<?php
+
+namespace Drupal\farm_log\Annotation;
+
+use Drupal\Component\Annotation\Plugin;
+
+/**
+ * Defines the log type plugin annotation object.
+ *
+ * Plugin namespace: Plugin\Log\LogType.
+ *
+ * @see plugin_api
+ *
+ * @Annotation
+ */
+class LogType extends Plugin {
+
+  /**
+   * The plugin ID.
+   *
+   * @var string
+   */
+  public $id;
+
+  /**
+   * The log type label.
+   *
+   * @var \Drupal\Core\Annotation\Translation
+   *
+   * @ingroup plugin_translatable
+   */
+  public $label;
+
+}

modules/core/log/src/LogTypeManager.php

@@ -0,0 +1,49 @@
+<?php
+
+namespace Drupal\farm_log;
+
+use Drupal\Component\Plugin\Exception\PluginException;
+use Drupal\Core\Cache\CacheBackendInterface;
+use Drupal\Core\Extension\ModuleHandlerInterface;
+use Drupal\Core\Plugin\DefaultPluginManager;
+
+/**
+ * Manages discovery and instantiation of log type plugins.
+ *
+ * @see \Drupal\log\Annotation\LogType
+ * @see plugin_api
+ */
+class LogTypeManager extends DefaultPluginManager {
+
+  /**
+   * Constructs a new LogTypeManager object.
+   *
+   * @param \Traversable $namespaces
+   *   An object that implements \Traversable which contains the root paths
+   *   keyed by the corresponding namespace to look for plugin implementations.
+   * @param \Drupal\Core\Cache\CacheBackendInterface $cache_backend
+   *   The cache backend.
+   * @param \Drupal\Core\Extension\ModuleHandlerInterface $module_handler
+   *   The module handler.
+   */
+  public function __construct(\Traversable $namespaces, CacheBackendInterface $cache_backend, ModuleHandlerInterface $module_handler) {
+    parent::__construct('Plugin/Log/LogType', $namespaces, $module_handler, 'Drupal\farm_log\Plugin\Log\LogType\LogTypeInterface', 'Drupal\farm_log\Annotation\LogType');
+
+    $this->alterInfo('log_type_info');
+    $this->setCacheBackend($cache_backend, 'log_type_plugins');
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public function processDefinition(&$definition, $plugin_id) {
+    parent::processDefinition($definition, $plugin_id);
+
+    foreach (['id', 'label'] as $required_property) {
+      if (empty($definition[$required_property])) {
+        throw new PluginException(sprintf('The log type %s must define the %s property.', $plugin_id, $required_property));
+      }
+    }
+  }
+
+}

modules/core/log/src/Plugin/Log/LogType/LogTypeBase.php

@@ -0,0 +1,33 @@
+<?php
+
+namespace Drupal\farm_log\Plugin\Log\LogType;
+
+use Drupal\Core\Plugin\PluginBase;
+
+/**
+ * Provides the base log type class.
+ */
+abstract class LogTypeBase extends PluginBase implements LogTypeInterface {
+
+  /**
+   * {@inheritdoc}
+   */
+  public function getLabel() {
+    return $this->pluginDefinition['label'];
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public function getWorkflowId() {
+    return $this->pluginDefinition['workflow'];
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public function buildFieldDefinitions() {
+    return [];
+  }
+
+}

modules/core/log/src/Plugin/Log/LogType/LogTypeInterface.php

@@ -0,0 +1,28 @@
+<?php
+
+namespace Drupal\farm_log\Plugin\Log\LogType;
+
+use Drupal\entity\BundlePlugin\BundlePluginInterface;
+
+/**
+ * Defines the interface for log types.
+ */
+interface LogTypeInterface extends BundlePluginInterface {
+
+  /**
+   * Gets the log type label.
+   *
+   * @return string
+   *   The log type label.
+   */
+  public function getLabel();
+
+  /**
+   * Gets the log workflow ID.
+   *
+   * @return string
+   *   The log workflow ID.
+   */
+  public function getWorkflowId();
+
+}

modules/core/role/tests/modules/farm_role_test/farm_role_test.info.yml

@@ -5,4 +5,5 @@ package: Testing
 core_version_requirement: ^8.8 || ^9
 
 dependencies:
-  - farm_role:farm_role
+  - log:log
+  - farm:farm_role