BiblioContributorUtility.inc in Bibliography Module 7.3

Helper class for handling Biblio Contributors.

File

includes/BiblioContributorUtility.inc

<?php

/**
 * @file
 * Helper class for handling Biblio Contributors.
 */
class BiblioContributorUtility {

  /**
   * Get saved contributor objects by their names.
   *
   * @param $names
   *  String of contributors' names separated by 'and'.
   *
   * @return
   *  Array of saved contributor objects.
   */
  public static function getBiblioContributorsFromNames($names) {

    // Split names.
    $names = preg_split("/(and|&)/i", trim($names));
    $contributors = array();
    foreach ($names as $name) {

      // Parse contributor's name to get each part separately.
      $values = BiblioContributorUtility::parseContributorName($name);

      // Get existing Biblio Contributor object, save it if it doesn't exist.
      $biblio_contributor = biblio_contributor_create($values);
      $biblio_contributor = BiblioContributorUtility::getBiblioContributor($biblio_contributor);
      $contributors[] = $biblio_contributor;
    }
    return $contributors;
  }

  /**
   * Get each part of a contributor's name separately.
   *
   * @param $full_name
   *  Full name of contributor.
   *
   * @return
   *  Array of parsed name, ready for creating a contributor.
   */
  public static function parseContributorName($full_name) {

    // @todo

    /*if (isset($contributor_array['auth_category']) && $contributor_array['auth_category'] == 5) {
          $contributor_array['firstname'] = '';
          $contributor_array['initials'] = '';
          $contributor_array['lastname'] = trim($contributor_array['name']);
          $contributor_array['prefix'] = '';
          $contributor_array['literal'] = 1;

          return $contributor_array;
        }*/
    $appellation = $prefix = $lastname = $firstname = $initials = '';

    // Remove unneeded spaces from full name.
    $full_name = trim($full_name);
    $full_name = preg_replace("/\\s{2,}/", ' ', $full_name);

    // Split full name by commas.
    $name_parts = explode(',', $full_name);

    // Count commas.
    $commas = count($name_parts) - 1;
    if (!$commas) {

      // No commas in full name.
      if (preg_match("/(.*) {([^\\\\].*)}/", $full_name, $matches) && !preg_match("/(.*) {\\\\.{.*}.*}/", $full_name, $matches2)) {

        // Complete last name enclosed in {...}, unless the string starts with a
        // backslash (\) because then it is probably a special latex-sign.
        // In the last case, any NESTED curly braces should also be taken into
        // account! so second clause rules out things such as 'a{\"{o}}'.
        $name_parts = explode(' ', $matches[1]);
        $lastname = $matches[2];
      }
      else {

        // The pattern is firstname-initials-lastname, such as 'George Bush',
        // 'George W. Bush', 'G W Bush' etc.
        // Split full name by spaces.
        $name_parts = explode(' ', $full_name);

        // Last element in the array should be the last name.
        // There shouldn't be a prefix if the name was entered correctly.
        $lastname = array_pop($name_parts);
      }
    }
    elseif ($commas == 1) {

      // There is 1 comma in full name, such as in 'Bush, George', 'Bush, G W',
      // 'Bush, George W', 'de la Bush, George W' etc.
      // Get last name and prefix separately.
      list($lastname, $prefix) = BiblioContributorUtility::getLastname(array_shift($name_parts));
    }
    else {

      // There are 2 commas in full name, such as in 'Bush, Jr. III, George W'.
      // Middle element in array is 'Jr.', 'IV' etc.
      $appellation = implode(' ', array_splice($name_parts, 1, 1));

      // Get last name and prefix separately.
      list($lastname, $prefix) = BiblioContributorUtility::getLastname(array_shift($name_parts));
    }

    // After removing the last name, prefix and appellation from the full name,
    // we are left with first name and initials, and perhaps last name prefix.
    $remainder = implode(' ', $name_parts);
    list($firstname, $initials, $prefix2) = BiblioContributorUtility::getFirstnameInitials($remainder);
    if (!empty($prefix2)) {

      // Found a prefix in remainder, add it to the last name prefix.
      $prefix .= $prefix2;
    }

    // Fill results in the array.
    $contributor_array['firstname'] = trim($firstname);
    $contributor_array['initials'] = substr(trim($initials), 0, 10);
    $contributor_array['lastname'] = trim($lastname);
    $contributor_array['prefix'] = trim($prefix);
    $contributor_array['suffix'] = trim($appellation);
    return $contributor_array;
  }

  /**
   * Get first name, initials and last name prefix from a given string.
   *
   * @param $value
   *   String containing first name, initials and perhaps a last name prefix.
   *
   * @return
   *   Array with three separated strings: first name, initials and prefix.
   */
  public static function getFirstnameInitials($value) {
    $prefix = array();
    $firstname = array();
    $initials = array();

    // Split the given string to its parts.
    $parts = explode(' ', $value);
    foreach ($parts as $part) {
      if (ord(substr($part, 0, 1)) >= 97 && ord(substr($part, 0, 1)) <= 122) {

        // The part starts with a lowercase letter, so this is a last name prefix
        // such as 'den', 'von', 'de la' etc.
        $prefix[] = $part;
        continue;
      }
      if (preg_match("/[a-zA-Z]{2,}/", $part)) {

        // The part starts with an uppercase letter and contains two letters or
        // more and therefore is a first name such as 'George'.
        $firstname[] = $part;
        continue;
      }

      // The part contains only one uppercase letter and perhaps a dot and
      // therefore is an initial such as the W in 'George W. Bush'.
      $initials[] = trim(str_replace('.', ' ', $part));
    }

    // Convert arrays to strings.
    $prefix = !empty($prefix) ? implode(' ', $prefix) : '';
    $firstname = !empty($firstname) ? implode(' ', $firstname) : '';
    $initials = !empty($initials) ? implode(' ', $initials) : '';
    return array(
      $firstname,
      $initials,
      $prefix,
    );
  }

  /**
   * Get last name and last name prefix from a given string.
   *
   * @param $value
   *   String containing last name and last name prefix.
   *
   * @return
   *   Array with two separated strings: last name and last name prefix.
   */
  public static function getLastname($value) {
    $prefix = array();
    $lastname = array();

    // Split the given string to its parts.
    $parts = explode(' ', $value);
    foreach ($parts as $part) {
      if (empty($lastname) && ord(substr($part, 0, 1)) >= 97 && ord(substr($part, 0, 1)) <= 122) {

        // The part starts with a lowercase letter and comes before any last names
        // were found so this is a prefix such as 'den', 'von', 'de la' etc.
        $prefix[] = $part;
        continue;
      }

      // The part starts with an uppercase letter and/or comes after a last name
      // was found in the given string so this is a last name such as 'Bush'.
      $lastname[] = $part;
    }

    // Convert arrays to strings.
    $prefix = !empty($prefix) ? implode(' ', $prefix) : '';
    $lastname = !empty($lastname) ? implode(' ', $lastname) : '';
    return array(
      $lastname,
      $prefix,
    );
  }

  /**
   * Generates an md5 string based on a biblio contributor object.
   * The md5 is later used to determine whether or not two Biblio Contributor
   * objects are the same and prevent duplications.
   *
   * @param $biblio_contributor
   *  Biblio Contributor object.
   *
   * @return
   *  MD5 string that represents the given biblio contributor.
   */
  public static function generateBiblioContributorMd5(BiblioContributor $biblio_contributor) {

    // The property 'name' must be set in every contributor, since it is used as
    // the title of the entity. We set it now, right before generating the MD5,
    // so it will be included in the MD5 calculation.
    $biblio_contributor->name = $biblio_contributor->lastname ? $biblio_contributor->firstname . ' ' . $biblio_contributor->lastname : $biblio_contributor->firstname;
    $clone = clone $biblio_contributor;
    unset($clone->cid);
    unset($clone->revision_id);
    unset($clone->changed);
    unset($clone->created);
    unset($clone->is_new);
    unset($clone->md5);
    return md5(serialize($clone));
  }

  /**
   * Returns saved biblio contributor object; Returns an existing contributor
   * if the given contributor was found, otherwise creates it first.
   *
   * @param $biblio_contributor
   *  Biblio Contributor object.
   *
   * @return
   *  Saved Biblio Contributor object.
   */
  public static function getBiblioContributor(BiblioContributor $biblio_contributor) {
    $md5 = BiblioContributorUtility::generateBiblioContributorMd5($biblio_contributor);
    $query = new EntityFieldQuery();
    $result = $query
      ->entityCondition('entity_type', 'biblio_contributor')
      ->propertyCondition('md5', $md5)
      ->range(0, 1)
      ->execute();
    if (!empty($result['biblio_contributor'])) {

      // Found existing contributor.
      return biblio_contributor_load(key($result['biblio_contributor']));
    }
    $biblio_contributor->md5 = $md5;
    $biblio_contributor
      ->save();
    return $biblio_contributor;
  }

}

Classes

Name	Description
BiblioContributorUtility	@file Helper class for handling Biblio Contributors.