【第3回】Block Pluginで画像を動的に表示する実装ガイド

<?php
namespace Drupal\unmanaged_files\Plugin\Block;

use Drupal\Core\Block\BlockBase;
use Drupal\Core\File\FileUrlGeneratorInterface;
use Drupal\unmanaged_files\Service\FileHandler;
use Symfony\Component\DependencyInjection\ContainerInterface;
use Drupal\Core\Plugin\ContainerFactoryPluginInterface;

/**
 * ランダムな非管理ファイルを表示するブロックを提供します。
 *
 * @Block(
 *   id = "unmanaged_files_block",
 *   admin_label = @Translation("Unmanaged Files Block"),
 * )
 */
final class UnmanagedFilesBlock extends BlockBase implements ContainerFactoryPluginInterface {

  /**
   * 新しいUnmanagedFilesBlockインスタンスを構築します。
   *
   * @param array $configuration
   *   プラグインインスタンスに関する情報を含む設定配列。
   * @param string $plugin_id
   *   ブロックのプラグインID。
   * @param mixed $plugin_definition
   *   プラグイン実装の定義。
   * @param \Drupal\unmanaged_files\Service\FileHandler $handler
   *   非管理ファイル用のファイルハンドラーサービス。
   * @param \Drupal\Core\File\FileUrlGeneratorInterface $urlGen
   *   ファイルURL生成サービス。
   */
  public function __construct(
    array $configuration,
    $plugin_id,
    $plugin_definition,
    private FileHandler $handler,
    private FileUrlGeneratorInterface $urlGen,
  ) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
  }

  /**
   * UnmanagedFilesBlockのインスタンスを作成します。
   *
   * このファクトリーメソッドは、コンテナから必要なサービスを注入します。
   *
   * @param \Symfony\Component\DependencyInjection\ContainerInterface $c
   *   サービスコンテナ。
   * @param array $configuration
   *   プラグインインスタンスに関する情報を含む設定配列。
   * @param string $plugin_id
   *   ブロックのプラグインID。
   * @param mixed $plugin_definition
   *   プラグイン実装の定義。
   *
   * @return static
   *   新しいUnmanagedFilesBlockインスタンスを返します。
   */
  public static function create(ContainerInterface $c, array $configuration, $plugin_id, $plugin_definition): self {
    /** @var \Drupal\unmanaged_files\Service\FileHandler $handler */
    $handler = $c->get('unmanaged_files.handler');

    /** @var \Drupal\Core\File\FileUrlGeneratorInterface $urlGen */
    $urlGen = $c->get('file_url_generator');

    return new self(
      $configuration,
      $plugin_id,
      $plugin_definition,
      $handler,
      $urlGen,
    );
  }

  /**
   * ブロックのレンダー配列を構築します。
   *
   * ファイルハンドラーを使用してランダムな非管理ファイルを取得し、
   * それを画像レンダー配列として返します。非管理ファイルが見つからない場合は、
   * 代わりにシンプルなメッセージを返します。
   *
   * @return array
   *   ブロックコンテンツのレンダー配列。
   */
  public function build(): array {
    $uri = $this->handler->getRandomFile();

    if (!$uri) {
      return [
        '#markup' => '<p>非管理ファイルが見つかりません。</p>',
      ];
    }

    return [
      '#theme' => 'image',
      '#uri' => $uri,
      '#alt' => $this->t('ランダムな非管理ファイル'),
      '#cache' => [
        'max-age' => 1,
      ],
    ];
  }