function theme_biblio_format_authors in Bibliography Module 7

Same name and namespace in other branches

1. 5 biblio.module \theme_biblio_format_authors()
2. 6.2 includes/biblio_theme.inc \theme_biblio_format_authors()
3. 6 biblio_theme.inc \theme_biblio_format_authors()
4. 7.2 includes/biblio.theme.inc \theme_biblio_format_authors()

9 theme calls to theme_biblio_format_authors()

biblio_format_authors in includes/biblio_theme.inc

biblio_style_ama in styles/biblio_style_ama.inc

biblio_style_apa in styles/biblio_style_apa.inc

Apply a bibliographic style to the node.

biblio_style_chicago in styles/biblio_style_chicago.inc

Apply a bibliographic style to the node.

biblio_style_classic in styles/biblio_style_classic.inc

Apply a bibliographic style to the node.

... See full list

File

includes/biblio_theme.inc, line 492

Code

function theme_biblio_format_authors($variables) {
  $contributors = $variables['contributors'];
  $options = $variables['options'];
  if (empty($contributors)) {
    return;
  }
  list($alnum, $alpha, $cntrl, $dash, $digit, $graph, $lower, $print, $punct, $space, $upper, $word, $patternModifiers) = _biblio_get_regex_patterns();
  $base = variable_get('biblio_base', 'biblio');
  $author_links = variable_get('biblio_author_links', 1);

  // Check how many authors we have to deal with.
  $authorCount = count($contributors);

  // This variable will hold the final author string.
  $output = "";
  $includeStringAfterFirstAuthor = FALSE;
  if (empty($options['numberOfAuthorsTriggeringEtAl'])) {
    $options['numberOfAuthorsTriggeringEtAl'] = $authorCount;
  }
  if (empty($options['includeNumberOfAuthors'])) {
    $options['includeNumberOfAuthors'] = $authorCount;
  }
  foreach ($contributors as $rank => $author) {
    if (empty($author['name'])) {
      continue;
    }
    if (!isset($author['lastname']) && empty($author['literal'])) {
      module_load_include('inc', 'biblio', '/includes/biblio.contributors');

      // This is needed for form preview to fill in all fields.
      $author = biblio_parse_author($author, $author['auth_type']);
    }
    if (empty($author['literal'])) {
      if (!empty($author['firstname'])) {

        // If we're supposed to abbreviate given names.
        if ($options['shortenGivenNames']) {

          // Within initials, reduce all full first names (-> defined by a starting uppercase character, followed by one ore more lowercase characters)
          // to initials, i.e., only retain their first character.
          $author['firstname'] = preg_replace("/([{$upper}])[{$lower}]+/{$patternModifiers}", '\\1', $author['firstname']);

          // $author['firstname'] = drupal_substr($author['firstname'], 0, 1);
          // the next line caused extra betweenInitialsDelim to appear in some circumstances
          // $author['firstname'] = preg_replace("/($space|$dash)?/$patternModifier", $options['betweenInitialsDelim'], $author['firstname']);.
        }
      }
      if (isset($author['initials'])) {

        // Within initials, remove any dots:
        $author['initials'] = preg_replace("/([{$upper}])\\.+/{$patternModifiers}", "\\1", $author['initials']);

        // $author['initials'] = str_replace('.', '',  $author['initials']);
        // Within initials, remove any spaces *between* initials:
        $author['initials'] = preg_replace("/(?<=[-{$upper}]) +(?=[-{$upper}])/{$patternModifiers}", "", $author['initials']);

        // $author['initials'] = str_replace(' ', '',  $author['initials']);
        // Within initials, add a space after a hyphen, but only if ...
        // ... the delimiter that separates initials ends with a space.
        if (preg_match('/ $/', $options['betweenInitialsDelim'])) {
          $author['initials'] = preg_replace("/-(?=[{$upper}])/{$patternModifiers}", "- ", $author['initials']);
        }

        // then, separate initials with the specified delimiter:
        $delim = $options['betweenInitialsDelim'];
        $author['initials'] = preg_replace("/([{$upper}])(?=[^{$lower}]+|\$)/{$patternModifiers}", "\\1{$delim}", $author['initials']);
        $shortenInitials = isset($options['numberOfInitialsToKeep']) ? $options['numberOfInitialsToKeep'] : FALSE;
        if ($shortenInitials) {
          $author['initials'] = drupal_substr($author['initials'], 0, $shortenInitials);
        }
        if ($options['shortenGivenNames'] && !empty($author['firstname'])) {
          $author['firstname'] = $author['firstname'] . $options['betweenInitialsDelim'] . $author['initials'];
          if ($shortenInitials) {
            $author['firstname'] = drupal_substr($author['firstname'], 0, $shortenInitials);
          }
        }
        elseif (!empty($author['firstname'])) {
          $author['firstname'] = $author['firstname'] . ' ' . $author['initials'];
        }
        elseif (empty($author['firstname'])) {
          $author['firstname'] = $author['initials'];
        }
      }

      // Remove double periods which can exist if a first name is entered as an
      // initial followed by a period.
      $author['firstname'] = preg_replace('/\\.{2,}/', '.', $author['firstname']);

      // If there is a surname prefix like "van", "von" etc, stick it back before the last name.
      if (!empty($author['prefix'])) {
        $author['lastname'] = $author['prefix'] . ' ' . $author['lastname'];
      }
      if (!empty($author['suffix'])) {
        $author['lastname'] = $author['lastname'] . ', ' . $author['suffix'];
      }
      if (!empty($author['firstname'])) {

        // -> first author.
        if ($rank == 0) {
          if ($options['initialsBeforeAuthorFirstAuthor']) {
            $author['name'] = $author['firstname'] . $options['AuthorsInitialsDelimFirstAuthor'] . $author['lastname'];
          }
          else {
            $author['name'] = $author['lastname'] . $options['AuthorsInitialsDelimFirstAuthor'] . $author['firstname'];
          }
        }
        else {
          if ($options['initialsBeforeAuthorStandard']) {
            $author['name'] = $author['firstname'] . $options['AuthorsInitialsDelimStandard'] . $author['lastname'];
          }
          else {
            $author['name'] = $author['lastname'] . $options['AuthorsInitialsDelimStandard'] . $author['firstname'];
          }
        }
      }
      else {
        $author['name'] = $author['lastname'];
      }
    }
    if ($author_links) {
      $author['name'] = theme('biblio_author_link', array(
        'author' => $author,
      ));
    }
    else {
      $author['name'] = check_plain($author['name']);
    }

    // Append this author to the final author string:
    // -> first author, or (for multiple authors) all authors except the last one.
    if ($rank == 0 or $rank + 1 < $authorCount) {

      // -> first author.
      if ($rank == 0) {
        $output .= $author['name'];
      }
      else {
        $output .= $options['BetweenAuthorsDelimStandard'] . $author['name'];
      }

      // we'll append the string in '$customStringAfterFirstAuthors' to the number of authors given in '$includeNumberOfAuthors' if the total number of authors is greater than the number given in '$numberOfAuthorsTriggeringEtAl':
      if ($rank + 1 == $options['includeNumberOfAuthors'] and $authorCount > $options['numberOfAuthorsTriggeringEtAl']) {
        if (preg_match("/__NUMBER_OF_AUTHORS__/", $options['customStringAfterFirstAuthors'])) {

          // Resolve placeholder.
          $customStringAfterFirstAuthors = preg_replace("/__NUMBER_OF_AUTHORS__/", $authorCount - $options['includeNumberOfAuthors'], $options['customStringAfterFirstAuthors']);
        }
        $includeStringAfterFirstAuthor = TRUE;
        break;
      }
    }
    elseif ($authorCount > 1 and $rank + 1 == $authorCount) {
      $output .= $options['BetweenAuthorsDelimLastAuthor'] . $author['name'];
    }
  }

  // Do some final clean up:
  // if ($options['encodeHTML'])
  // $output = encodeHTML($output); // HTML encode higher ASCII characters within the newly arranged author contents.
  if ($includeStringAfterFirstAuthor) {

    // The custom string won't get HTML encoded so that it's possible to include HTML tags (such as '<i>') within the string.
    $output .= $options['customStringAfterFirstAuthors'];
  }

  // Remove double spaces (which occur e.g., when both, $betweenInitialsDelim & $newAuthorsInitialsDelim..., end with a space)
  $output = preg_replace("/  +/", " ", $output);

  // Remove excess spaces before [,.;:?!()] and from the end of the author string.
  $output = preg_replace("/ +([,.;:?!()]|\$)/", "\\1", $output);
  return $output;
}