bibcite_footnotes/bibcite_footnotes.module

<?php

/**
 * @file
 * Contains bibcite_footnotes.module.
 */

use Drupal\Core\Form\FormStateInterface;
use Drupal\Core\Routing\RouteMatchInterface;
use Drupal\Core\Url;
use Drupal\Core\Link;

/**
 * Implements hook_help().
 */
function bibcite_footnotes_help($route_name, RouteMatchInterface $route_match) {
  switch ($route_name) {
    // Main module help for the bibcite_footnotes module.
    case 'help.page.bibcite_footnotes':
      $output = '';
      $output .= '<h3>' . t('About') . '</h3>';
      $output .= '<p>' . t('Inline footnote links for BibCite References') . '</p>';
      return $output;

    default:
  }
}

/**
 * Implementation of hook_preprocess_footnote_list().
 *
 * Gatehrs all notes and prints out Notes and References as separate lists.
 *
 * @param $variables Theme variables.
 *
 * @throws \Drupal\Component\Plugin\Exception\InvalidPluginDefinitionException
 * @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
 */
function bibcite_footnotes_preprocess_footnote_list(&$variables) {
  $config = \Drupal::config('filter.format.rich_text_references');//filters.filter_reference_footnotes.settings');
  $footnotes = $variables['footnotes'];

  $notes = [
    '#theme' => 'item_list',
    '#list_type' => 'ul',
    '#title' => $config->get('filters.filter_reference_footnotes.settings.notes_section_label'),
    '#attributes' => ['class' => 'footnotes'],
    '#wrapper_attributes' => ['class' => 'container'],
  ];

  $references= [
    '#theme' => 'item_list',
    '#list_type' => 'ul',
    '#title' => $config->get('filters.filter_reference_footnotes.settings.references_section_label'),
    '#attributes' => ['class' => 'footnotes'],
    '#wrapper_attributes' => ['class' => 'container'],

  ];
  $references['#attached']['library'][] = 'bibcite_footnotes/reference_footnote';
  $dont_show_backlink_text = $config->get('filters.filter_reference_footnotes.settings.reference_dont_show_backlink_text');
  $sort_references_by = $config->get('filters.filter_reference_footnotes.settings.reference_sort_by');
  $serializer = \Drupal::service('serializer');

  foreach ($footnotes as $fn) {
    $item = [
      '#id' => $fn['fn_id'],
      '#wrapper_attributes' => [
        'class' => ['footnote'],
      ],
    ];
    $build = [];
    preg_match('/\[bibcite_reference:(\d*)\]/', $fn['text'], $matches);
    $reference_entity_id = $matches[1];

    if (!is_array($fn['ref_id'])) {
      // Output normal footnote.


      $url = Url::fromUserInput('#' . $fn['ref_id'], ['attributes' => ['id' => $fn['fn_id'], 'class' => 'footnote-link']]);
      $link = Link::fromTextAndUrl(($dont_show_backlink_text && $reference_entity_id ? '^' : $fn['value']), $url)->toRenderable();
      $build[] = $link;
    }
    else {
      // Output footnote that has more than one reference to it in the body.
      // The only difference is to insert backlinks to all references.
      // Helper: we need to enumerate a, b, c...
      $abc = str_split("abcdefghijklmnopqrstuvwxyz");
      $i = 0;

      $url = Url::fromUserInput('#' . $fn['ref_id'][0], ['attributes' => ['id' => $fn['fn_id'], 'class' => 'footnote-link']]);
      $build[] = Link::fromTextAndUrl($fn['value'], $url)->toRenderable();

      foreach ($fn['ref_id'] as $ref) {
        $url = Url::fromUserInput( '#' . $ref, ['attributes' => ['id' => $fn['fn_id'], 'class' => 'footnote-multi']]);
        $build[] = Link::fromTextAndUrl($abc[$i], $url)->toRenderable();

        $i++;
      }

    }

    if (!empty($reference_entity_id)) {
      $reference_storage = \Drupal::entityTypeManager()
        ->getStorage('bibcite_reference')
        ->load($reference_entity_id);
      $data = $serializer->normalize($reference_storage, 'csl');
      $build[] = ['#theme' => 'bibcite_citation', '#data' => $data];
      $render = render($build);
      $item['#markup'] = $render;
      $references['#items'][] = $item;

    }
    else {
      $build[] = ['#type' => 'markup', '#markup' => ' ' . $fn['text']];
      $render = render($build);
      $item['#markup'] = $render;

      $notes['#items'][] = $item;
    }
  }

  $variables['notes'] = $notes;

  $variables['references'] = $references;

}

/**
 * Implements hook_theme().
 */
function bibcite_footnotes_theme() {
  return [
    'bibcite_footnotes' => [
      'render element' => 'children',
    ],
  ];
}

function bibcite_footnotes_theme_registry_alter(&$theme_registry) {
  unset($theme_registry['footnote_list']['function']);
//  $theme_registry['footnote_list']['function'] = 'bibcite_footnotes_theme_footnote_list';
  $theme_registry['footnote_list']['path'] = drupal_get_path('module', 'bibcite_footnotes') . '/templates';
  $theme_registry['footnote_list']['template'] = 'footnote-list';
  $theme_registry['footnote_list']['variables']['notes'] = [];
  $theme_registry['footnote_list']['variables']['references'] = [];
  $theme_registry['footnote_list']['variables']['footnotes'] = [];
}

function bibcite_footnotes_theme_footnote_list($footnotes) {
  // @todo: change this ugly array for arguments in the function.
  $footnotes = $footnotes['footnotes']['#footnotes'];

  $notes = [
    '#theme' => 'item_list',
    '#list_type' => 'ul',
    '#title' => 'Notes',
    '#attributes' => ['class' => ''],
    '#wrapper_attributes' => ['class' => 'container'],
  ];

//  return drupal_render($content);
  $str = '<ul class="footnotes">';
  // Drupal 7 requires we use "render element" which just introduces a wrapper
  // around the old array.
  // $footnotes = $footnotes['footnotes'];
  // loop through the footnotes.
  $view_builder = \Drupal::entityTypeManager()->getViewBuilder('bibcite_reference');
  foreach ($footnotes as $fn) {
    if (!is_array($fn['ref_id'])) {
      // Output normal footnote.
      $str .= '<li class="footnote" id="' . $fn['fn_id'] . '"><a class="footnote-label" href="#' . $fn['ref_id'] . '">' . $fn['value'] . '.</a> ';
      preg_match('/\[bibcite_reference:(\d*)\]/', $fn['text'], $matches);
      $reference_entity_id = $matches[1];
      if (!empty($reference_entity_id)) {
        $reference_storage = \Drupal::entityTypeManager()
          ->getStorage('bibcite_reference')
          ->load($reference_entity_id);

        $build = $view_builder->view($reference_storage, 'citation');
        $render = render($build);

        $str .= $render . "</li>\n";
      }
      else {
        $str .= $fn['text'] . "</li>\n";
      }
    }
    else {
      // Output footnote that has more than one reference to it in the body.
      // The only difference is to insert backlinks to all references.
      // Helper: we need to enumerate a, b, c...
      $abc = str_split("abcdefghijklmnopqrstuvwxyz");
      $i = 0;

      $str .= '<li class="footnote" id="' . $fn['fn_id'] . '"><a href="#' . $fn['ref_id'][0] . '" class="footnote-label">' . $fn['value'] . '.</a> ';
      foreach ($fn['ref_id'] as $ref) {
        $str .= '<a class="footnote-multi" href="#' . $ref . '">' . $abc[$i] . '.</a> ';
        $i++;
      }
      $str .= $fn['text'] . "</li>\n";
    }
  }

  return $str;

}