【第5回】 Twig関数の拡張

<?php
namespace Drupal\unmanaged_files\Twig;

use Drupal\unmanaged_files\Service\FileHandler;
use Drupal\Core\File\FileUrlGeneratorInterface;
use Twig\Extension\AbstractExtension;
use Twig\TwigFunction;
use Drupal\image\Entity\ImageStyle;
use Drupal\Component\Utility\Html;

/**
 * テンプレートに非管理ファイルヘルパーを公開するTwig拡張機能。
 */
final class UnmanagedFilesExtension extends AbstractExtension {

  public function __construct(
    private FileHandler $handler,
    private FileUrlGeneratorInterface $urlGen,
  ) {}

  /**
   * {@inheritdoc}
   */
  public function getFunctions(): array {
    return [
      new TwigFunction('random_unmanaged_file', [$this, 'getRandomFile'], ['is_safe' => ['html']]),
    ];
  }

  /**
   * ランダムな非管理ファイルのファイルURLまたは<img>タグを返します。
   *
   * @param string $format
   *   'url'（デフォルト）でファイルURLを返すか、'img'で<img>タグを返します。
   * @param string|null $style
   *   （オプション）画像スタイルのマシン名、$format = 'img'の場合のみ使用されます。
   *
   * @return string|null
   *   URLまたはHTML文字列、ファイルが見つからない場合はNULL。
   */
  public function getRandomFile(string $format = 'url', ?string $style = NULL): ?string {
    $uri = $this->handler->getRandomFile();
    if (!$uri) {
      return NULL;
    }

    // 絶対ファイルURLから始めます。
    $url = $this->urlGen->generateAbsoluteString($uri);

    // 要求された場合は画像スタイルを適用します。
    if ($format === 'img' && $style) {
      if ($image_style = ImageStyle::load($style)) {
        $url = $image_style->buildUrl($uri);
      }
    }

    if ($format === 'img') {
      $safeUrl = Html::escape($url);
      return '<img src="' . $safeUrl . '" alt="ランダムな非管理ファイル">';
    }

    return $url;
  }
}

{# 例1: URLのみ #}
<p>ファイルURL: {{ random_unmanaged_file() }}</p>

{# 例2: レンダリングされた画像 #}
{{ random_unmanaged_file('img') }}

{# 例3: 特定のスタイルを使用したレンダリングされた画像 #}
{{ random_unmanaged_file('img', 'thumbnail') }}