Add option to sort References alphabetically.

bibcite_footnotes.module

@@ -104,9 +104,11 @@ function bibcite_footnotes_preprocess_footnote_list(&$variables) {
         ->getStorage('bibcite_reference')
         ->load($reference_entity_id);
       $data = $serializer->normalize($reference_storage, 'csl');
-      $build[] = ['#theme' => 'bibcite_citation', '#data' => $data];
+      $citation_build = ['#theme' => 'bibcite_citation', '#data' => $data];
+      $build[] = $citation_build;
       $render = render($build);
       $item['#markup'] = $render;
+      $item['sort'] = trim(strip_tags(render($citation_build)));
       $references['#items'][] = $item;
 
     }
@@ -121,8 +123,16 @@ function bibcite_footnotes_preprocess_footnote_list(&$variables) {
 
   $variables['notes'] = $notes;
 
+  if ($sort_references_by == 'alphabetical') {
+    usort($references['#items'], '_bibcite_footnotes_reference_array_cmp');
+  }
   $variables['references'] = $references;
+}
 
+function _bibcite_footnotes_reference_array_cmp($a, $b) {
+  $a1 = (!empty($a['sort']) ? strtolower($a['sort']) : '');
+  $b1 = (!empty($b['sort']) ? strtolower($b['sort']) : '');
+  return strcmp($a1, $b1);
 }
 
 /**
@@ -146,61 +156,3 @@ function bibcite_footnotes_theme_registry_alter(&$theme_registry) {
   $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;
-
-}

src/Plugin/Filter/ReferenceFootnotesFilter.php

@@ -90,8 +90,8 @@ class ReferenceFootnotesFilter extends FootnotesFilter {
       '#type' => 'select',
       '#title' => $this->t("Sort references list by"),
       '#options' => [
-        'appearance' => $this->t("Appearance in text"),
-        'contributor_surname' => $this->t("Contributor surname"),
+        'order' => $this->t("Order in text"),
+        'alphabetical' => $this->t("Alphabetical"),
       ],
       '#default_value' => $this->settings['reference_sort_by'],
     ];