Merge branch '3519844-support-oop-hooks' into '1.2.x'

Resolve #3519844 "Support oop hooks"

See merge request !5

composer.json

@@ -21,7 +21,7 @@
     "source": "https://git.drupalcode.org/project/fileslog"
   },
   "require": {
-    "drupal/core": "^10 || ^11",
+    "drupal/core": "^10.1 || ^11",
     "php": ">=8.1"
   }
 }

fileslog.info.yml

 name: Private Files Logging
 type: module
 package: Logging
-core_version_requirement: ^10 || ^11
+core_version_requirement: ^10.1 || ^11
 description: 'Logs and records system events to the private filesystem.'
 configure: system.logging_settings

fileslog.module

@@ -5,68 +5,33 @@
  * Redirects logging messages to the private filesystem.
  */
 
-use Drupal\Core\File\FileSystemInterface;
 use Drupal\Core\Form\FormStateInterface;
+use Drupal\Core\Hook\Attribute\LegacyHook;
 use Drupal\Core\Routing\RouteMatchInterface;
-use Drupal\fileslog\FilesLogInterface;
+use Drupal\fileslog\Hook\Cron;
+use Drupal\fileslog\Hook\FormAlter;
+use Drupal\fileslog\Hook\Help;
 
 /**
  * Implements hook_help().
  */
-function fileslog_help($route_name, RouteMatchInterface $route_match) {
-  switch ($route_name) {
-    case 'help.page.fileslog':
-      $output = '';
-      $output .= '<h3>' . t('About') . '</h3>';
-      $output .= '<p>' . t('The fileslog module saves logs to the private filesystem.') . '</p>';
-      return $output;
-  }
+#[LegacyHook]
+function fileslog_help($route_name, RouteMatchInterface $route_match): ?string {
+  return \Drupal::service(Help::class)->help($route_match, $route_match);
 }
 
 /**
- * Implements hook_cron().
- */
-function fileslog_cron() {
-  /** @var \Drupal\Core\File\FileSystemInterface $filesystem */
-  $filesystem = \Drupal::service('file_system');
-  /** @var \Drupal\fileslog\FilesLogManagerInterface $files_log_manager */
-  $files_log_manager = \Drupal::service('fileslog.manager');
-  $dir = FilesLogInterface::DIRECTORY;
-  $max_items = (int) \Drupal::config('fileslog.settings')->get('max_items') ?: 1000;
-
-  $filesystem->prepareDirectory($dir, FileSystemInterface::CREATE_DIRECTORY | FileSystemInterface::MODIFY_PERMISSIONS);
-  $files = $files_log_manager->getLogFiles([], 0);
-  if (count($files) > $max_items) {
-    $to_delete = array_slice($files, $max_items, (count($files) - $max_items));
-    foreach ($to_delete as $uri => $file) {
-      $filesystem->unlink($uri);
-    }
-  }
+* Implements hook_cron().
+*/
+#[LegacyHook]
+function fileslog_cron(): void {
+  \Drupal::service(Cron::class)->cron();
 }
 
 /**
  * Implements hook_form_FORM_ID_alter().
  */
-function fileslog_form_system_logging_settings_alter(&$form, FormStateInterface $form_state) {
-  $config = \Drupal::configFactory()->getEditable('fileslog.settings');
-  $form['max_items'] = [
-    '#type' => 'number',
-    '#title' => t('Maximum logs'),
-    '#default_value' => $config->get('max_items'),
-    '#required' => TRUE,
-    '#description' => t('The maximum log items to keep in the private filesystem before deleting the oldest ones.'),
-  ];
-
-  $form['#submit'][] = 'fileslog_logging_settings_submit';
-}
-
-/**
- * Form submission handler for system_logging_settings().
- *
- * @see fileslog_form_system_logging_settings_alter()
- */
-function fileslog_logging_settings_submit($form, FormStateInterface $form_state) {
-  \Drupal::configFactory()->getEditable('fileslog.settings')
-    ->set('max_items', $form_state->getValue('max_items'))
-    ->save();
+#[LegacyHook]
+function fileslog_form_system_logging_settings_alter(&$form, FormStateInterface $form_state): void {
+  \Drupal::service(FormAlter::class)->alterSystemLoggingSettingsForm($form, $form_state);
 }

fileslog.services.yml

+parameters:
+  fileslog.hooks_converted: true
+
 services:
+  _defaults:
+    autowire: true
+
   # The fileslog manager.
   fileslog.manager:
     class: Drupal\fileslog\FilesLogManager
-    arguments: ['@file_system', '@request_stack']
+  Drupal\fileslog\FilesLogManagerInterface: '@fileslog.manager'
 
   # The logger service.
   logger.fileslog:
     class: Drupal\fileslog\Logger\FilesLog
-    arguments: ['@logger.log_message_parser']
     tags:
       - { name: logger }
+
+  # Hook services.
+  Drupal\fileslog\Hook\Help:
+    class: Drupal\fileslog\Hook\Help
+  Drupal\fileslog\Hook\Cron:
+    class: Drupal\fileslog\Hook\Cron
+  Drupal\fileslog\Hook\FormSystemLoggingSettingsAlter:
+    class: Drupal\fileslog\Hook\FormSystemLoggingSettingsAlter

src/Hook/Cron.php

+<?php
+
+namespace Drupal\fileslog\Hook;
+
+use Drupal\Core\Config\ConfigFactoryInterface;
+use Drupal\Core\File\FileSystemInterface;
+use Drupal\Core\Hook\Attribute\Hook;
+use Drupal\fileslog\FilesLogInterface;
+use Drupal\fileslog\FilesLogManagerInterface;
+
+/**
+ * Hooks onto cron events.
+ */
+class Cron {
+
+  /**
+   * Constructs the cron hook class.
+   */
+  public function __construct(
+    protected FileSystemInterface $fileSystem,
+    protected ConfigFactoryInterface $configFactory,
+    protected FilesLogManagerInterface $filesLogManager,
+  ) {}
+
+  /**
+   * Executes the 'cron'-hook.
+   */
+  #[Hook('cron')]
+  public function cron(): void {
+    $max_items = (int) ($this->configFactory->get('fileslog.settings')->get('max_items') ?: 1000);
+    $dir = FilesLogInterface::DIRECTORY;
+
+    $this->fileSystem->prepareDirectory($dir, FileSystemInterface::CREATE_DIRECTORY | FileSystemInterface::MODIFY_PERMISSIONS);
+    $files = $this->filesLogManager->getLogFiles([], 0);
+    if (count($files) > $max_items) {
+      $to_delete = array_slice($files, $max_items, (count($files) - $max_items));
+      foreach ($to_delete as $uri => $file) {
+        $this->fileSystem->unlink($uri);
+      }
+    }
+  }
+
+}

src/Hook/FormAlter.php

+<?php
+
+namespace Drupal\fileslog\Hook;
+
+use Drupal\Core\Config\ConfigFactoryInterface;
+use Drupal\Core\Form\FormStateInterface;
+use Drupal\Core\Hook\Attribute\Hook;
+
+/**
+ * Hooks onto form alter events.
+ */
+class FormAlter {
+
+  /**
+   * Constructs the form_system_logging_settings_alter hook class.
+   */
+  public function __construct(
+    protected ConfigFactoryInterface $configFactory,
+  ) {}
+
+  /**
+   * Executes the 'form_system_logging_settings_alter'-hook.
+   */
+  #[Hook('form_system_logging_settings_alter')]
+  public function alterSystemLoggingSettingsForm(&$form, FormStateInterface $form_state): void {
+    $config = $this->configFactory->getEditable('fileslog.settings');
+    $form['max_items'] = [
+      '#type' => 'number',
+      '#title' => t('Maximum logs'),
+      '#default_value' => $config->get('max_items'),
+      '#required' => TRUE,
+      '#description' => t('The maximum log items to keep in the private filesystem before deleting the oldest ones.'),
+    ];
+
+    $form['#submit'][] = [$this, 'submitForm'];
+  }
+
+  /**
+   * Form submission handler for system_logging_settings().
+   *
+   * @see static::alterForm()
+   */
+  public function submitForm($form, FormStateInterface $form_state) {
+    $this->configFactory->getEditable('fileslog.settings')
+      ->set('max_items', $form_state->getValue('max_items'))
+      ->save();
+  }
+
+}

src/Hook/Help.php

+<?php
+
+namespace Drupal\fileslog\Hook;
+
+use Drupal\Core\Hook\Attribute\Hook;
+use Drupal\Core\Routing\RouteMatchInterface;
+
+/**
+ * Hooks onto help events.
+ */
+class Help {
+
+  /**
+   * Executes the 'help'-hook.
+   */
+  #[Hook('help')]
+  public function help($route_name, RouteMatchInterface $route_match): ?string {
+    if ($route_name === 'help.page.fileslog') {
+      return '<h3>' . t('About') . '</h3>'
+        . '<p>' . t('The fileslog module saves logs to the private filesystem.') . '</p>';
+    }
+
+    return NULL;
+  }
+
+}