ITKDev: Added wrapper function for audit logging

OS2Forms · Aug 21, 2024 · c60de69 · c60de69
1 parent e327173
commit c60de69
Show file tree

Hide file tree

Showing 5 changed files with 32 additions and 2 deletions.
diff --git a/modules/os2forms_audit/src/Commands/AuditLogDrushCommands.php b/modules/os2forms_audit/src/Commands/AuditLogDrushCommands.php
@@ -35,6 +35,9 @@ public function __construct(
    * @throws \Drupal\Component\Plugin\Exception\PluginException
    */
   public function logMessage(string $log_message = ''): void {
+    if (empty($log_message)) {
+      throw new \Exception('Log message cannot be empty.');
+    }
     $this->auditLogger->log('test', time(), $log_message, ['from' => 'drush']);
   }
 

diff --git a/modules/os2forms_audit/src/Form/PluginSettingsForm.php b/modules/os2forms_audit/src/Form/PluginSettingsForm.php
@@ -40,7 +40,7 @@ public function __construct(
   /**
    * {@inheritdoc}
    */
-  public static function create(ContainerInterface $container): PluginSettingsForm|ConfigFormBase|static {
+  public static function create(ContainerInterface $container): static {
     return new static(
       $container->get('config.factory'),
       $container->get('plugin.manager.os2forms_audit_logger')

diff --git a/modules/os2forms_audit/src/Form/SettingsForm.php b/modules/os2forms_audit/src/Form/SettingsForm.php
@@ -28,7 +28,7 @@ public function __construct(
   /**
    * {@inheritdoc}
    */
-  public static function create(ContainerInterface $container) {
+  public static function create(ContainerInterface $container): static {
     return new static(
       $container->get('config.factory'),
       $container->get('plugin.manager.os2forms_audit_logger')

diff --git a/modules/os2forms_audit/src/Service/Logger.php b/modules/os2forms_audit/src/Service/Logger.php
@@ -38,6 +38,8 @@ public function log(string $type, int $timestamp, string $line, array $metadata
     $config = $this->configFactory->get(SettingsForm::$configName);
     $plugin_id = $config->get('provider');
 
+    // @todo: default logger (file)
+    // @todo: Fallback logger on error.
     $configuration = $this->configFactory->get(PluginSettingsForm::getConfigName())->get($plugin_id);
     $logger = $this->loggerManager->createInstance($plugin_id, $configuration ?? []);
 

diff --git a/os2forms.module b/os2forms.module
@@ -357,3 +357,28 @@ function os2forms_module_implements_alter(&$implementations, $hook) {
       break;
   }
 }
+
+/**
+ * Logging function for audit logs.
+ *
+ * Wrapper to make logging easier and simplify the usage of the audit logger, if
+ * enabled.
+ *
+ * @param string $type
+ *   The type of log entry.
+ * @param int $timestamp
+ *   The timestamp of the log entry.
+ * @param string $line
+ *   The log message.
+ * @param array $metadata
+ *   Additional metadata for the log entry.
+ *
+ * @throws \Drupal\Component\Plugin\Exception\PluginException
+ */
+function os2forms_audit_log(string $type, int $timestamp, string $line, array $metadata = []): void {
+  if ( \Drupal::service('module_handler')->moduleExists('os2form_audit')) {
+    /** @var \Drupal\os2forms_audit\Service\Logger $logger */
+    $logger = \Drupal::service('os2form_audit.logger');
+    $logger->log($type, $timestamp, $line, $metadata);
+  }
+}