Move preprocess_file_link() to localgov_core

[markconroy]

If we move the following code to LocalGov Core, then any document media items that we have will display the same in the backend and the frontend.

At the moment, if we merge #849 then in our editor screens we will see for example my-file.pdf (PDF, 2MB) but on the frontend we will see My File (PDF, 2MB).

Moving this will mean we have a consistent experience for all whether using LocalGov Base or not.

/**
 * Implements hook_preprocess_file_link().
 *
 * Changes:
 * - Inserts file *type* and size into the theme variable.
 * - Reformats file size.  Example: 123.4KB.
 * - Appends file metadata to the file link text.
 *
 * @see template_preprocess_file_link()
 */
function localgov_base_preprocess_file_link(&$variables): void {

  $file = $variables['file'];
  $filename = $file->getFilename();
  $file_extension = pathinfo($filename, PATHINFO_EXTENSION);

  $variables['file_type'] = strtoupper($file_extension);

  // 123.45 KB -> 123.45KB
  $variables['file_size'] = strtr($variables['file_size'], [' ' => '']);

  // Load media entity from file.
  $media_id = $file->_referringItem->getParent()->getParent()->getEntity()->get('mid')->getString();
  $media = \Drupal\media\Entity\Media::load($media_id);
  $media_name = $media->get('name')->getString();

  if (isset($variables['link']['#title'])) {
    $document_title = $variables['link']['#title'];

    if ($media_name && $media_name !== $document_title) {
      // If the media name is set and different to the $variables['link']['#title'],
      // we will use that instead.
      $document_title = $media_name;
    }

    $variables['link']['#title'] = [
      '#markup' => "{$document_title} <span class=\"file-meta\">(<span class=\"file-type\">{$variables['file_type']}</span>, <span class=\"file-size\">{$variables['file_size']}</span>)</span>",
    ];
  }
  else {
    $file_title = $variables['link'];
    $variables['link'] = [
      '#markup' => "{$file_title} <span class=\"file-meta\">(<span class=\"file-type\">{$variables['file_type']}</span>, <span class=\"file-size\">{$variables['file_size']}</span>)</span>",
    ];
  }
}

[tonypaulbarker]

@markconroy is there any reason that we couldn't have it both places - perhaps a check for the theme here if executing it twice is a problem? People can use localgov_base without localgov_core and I think flexibility is to be encouraged as the project evolves.

[markconroy]

I think I'd rather keep it in one place. Either we want it in the theme for the frontend, or in a module for both backend and frontend. We have lots of other places where our modules are doing frontend things.

We "could" put it in two places, but that seems a bit of an anti-pattern.

[tonypaulbarker]

As you say @markconroy , we should see the expected format in the editor. Shall we close the theme PR in favour of this then?

[markconroy]

I'd be happy to get the theme PR in if it's approved, then I'll work on adding it here and removing it from the theme this week.

[tonypaulbarker]

Sounds good. It works really well. Thanks!