taxonomy.inc in Feeds 7.2

On behalf implementation of Feeds mapping API for taxonomy.module.

File

mappers/taxonomy.inc

<?php

/**
 * @file
 * On behalf implementation of Feeds mapping API for taxonomy.module.
 */

/**
 * Search by term name.
 */
define('FEEDS_TAXONOMY_SEARCH_TERM_NAME', 0);

/**
 * Search by term id.
 */
define('FEEDS_TAXONOMY_SEARCH_TERM_ID', 1);

/**
 * Search by GUID.
 */
define('FEEDS_TAXONOMY_SEARCH_TERM_GUID', 2);

/**
 * Implements hook_feeds_parser_sources_alter().
 */
function taxonomy_feeds_parser_sources_alter(array &$sources, $content_type) {
  if (!empty($content_type)) {
    foreach (taxonomy_get_vocabularies($content_type) as $vocabulary) {
      $sources['parent:taxonomy:' . $vocabulary->machine_name] = array(
        'name' => t('Feed node: Taxonomy: @vocabulary', array(
          '@vocabulary' => $vocabulary->name,
        )),
        'description' => t('Taxonomy terms from feed node in given vocabulary.'),
        'callback' => 'taxonomy_feeds_get_source',
      );
    }
  }
}

/**
 * Callback, returns taxonomy from feed node.
 */
function taxonomy_feeds_get_source(FeedsSource $source, FeedsParserResult $result, $key) {
  if ($node = node_load($source->feed_nid)) {
    $terms = taxonomy_feeds_node_get_terms($node);
    $vocabularies = taxonomy_vocabulary_load_multiple(array(), array(
      'machine_name' => str_replace('parent:taxonomy:', '', $key),
    ));
    $vocabulary = array_shift($vocabularies);
    $result = array();
    foreach ($terms as $tid => $term) {
      if ($term->vid == $vocabulary->vid) {
        $result[] = new FeedsTermElement($term);
      }
    }
    return $result;
  }
}

/**
 * Implements hook_feeds_processor_targets().
 */
function taxonomy_feeds_processor_targets($entity_type, $bundle_name) {
  $targets = array();
  foreach (field_info_instances($entity_type, $bundle_name) as $name => $instance) {
    $info = field_info_field($name);
    if ($info['type'] == 'taxonomy_term_reference') {
      $targets[$name] = array(
        'name' => check_plain($instance['label']),
        'callback' => 'taxonomy_feeds_set_target',
        'description' => t('The @label field of the entity.', array(
          '@label' => $instance['label'],
        )),
        'summary_callbacks' => array(
          'taxonomy_feeds_summary_callback',
        ),
        'form_callbacks' => array(
          'taxonomy_feeds_form_callback',
        ),
      );
    }
  }
  if ($entity_type == 'taxonomy_term') {
    $targets['tid']['name'] = t('Term id');
    $targets['tid']['description'] = t('The tid of the taxonomy term. NOTE: use this feature with care, node ids are usually assigned by Drupal.');
    unset($targets['vocabulary']);
  }
  return $targets;
}

/**
 * Callback for mapping taxonomy terms.
 */
function taxonomy_feeds_set_target(FeedsSource $source, $entity, $target, array $terms, array $mapping) {
  $language = $mapping['language'];

  // Add in default values.
  $mapping += array(
    'term_search' => FEEDS_TAXONOMY_SEARCH_TERM_NAME,
    'autocreate' => FALSE,
  );
  $info = field_info_field($target);
  $cache =& drupal_static(__FUNCTION__);
  if (!isset($cache['allowed_values'][$target])) {
    $cache['allowed_values'][$target] = taxonomy_allowed_values($info);
  }
  if (!isset($cache['allowed_vocabularies'][$target])) {
    foreach ($info['settings']['allowed_values'] as $tree) {
      if ($vocabulary = taxonomy_vocabulary_machine_name_load($tree['vocabulary'])) {
        $vid = $vocabulary->vid;
        $cache['allowed_vocabularies'][$target][$vid] = $vocabulary->machine_name;
        $cache['vocabulary_targets'][$vid][] = $target;
      }
    }
  }

  // Some kind of configuration issue. Perhaps the vocabulary was deleted.
  // Nothing we can do about it.
  if (empty($cache['allowed_vocabularies'][$target])) {
    return;
  }
  $query = new EntityFieldQuery();
  $query
    ->entityCondition('entity_type', 'taxonomy_term')
    ->entityCondition('bundle', $cache['allowed_vocabularies'][$target])
    ->range(0, 1);
  $field = isset($entity->{$target}) ? $entity->{$target} : array(
    $language => array(),
  );
  if (!isset($field[$language])) {
    $field[$language] = array();
  }

  // Allow for multiple mappings to the same target.
  $delta = count($field[$language]);

  // Iterate over all values.
  foreach ($terms as $term) {
    if ($info['cardinality'] == $delta) {
      break;
    }
    $tid = FALSE;

    // FeedsTermElement already is a term.
    if ($term instanceof FeedsTermElement) {
      $tid = $term->tid;
    }
    else {
      switch ($mapping['term_search']) {

        // Lookup by name.
        case FEEDS_TAXONOMY_SEARCH_TERM_NAME:
          $term = trim($term);
          $name_query = clone $query;
          if (strlen($term) && ($tids = $name_query
            ->propertyCondition('name', $term)
            ->execute())) {

            // Find the first allowed term.
            foreach ($tids['taxonomy_term'] as $possible_term) {
              if (isset($cache['allowed_values'][$target][$possible_term->tid])) {
                $tid = $possible_term->tid;
                break;
              }
            }
          }
          elseif ($mapping['autocreate'] && strlen($term)) {
            $term_vid = key($cache['allowed_vocabularies'][$target]);
            $term = (object) array(
              'name' => drupal_substr($term, 0, 255),
              'vid' => $term_vid,
              'vocabulary_machine_name' => reset($cache['allowed_vocabularies'][$target]),
            );

            // Set language if the taxonomy is multilingual.
            if ($language !== LANGUAGE_NONE) {
              $info = entity_get_info('taxonomy_term');
              if (!empty($info['entity keys']['language'])) {
                $term->{$info['entity keys']['language']} = $language;
              }
            }
            taxonomy_term_save($term);
            $tid = $term->tid;

            // Add to the list of allowed values.
            $cache['allowed_values'][$target][$tid] = $term->name;

            // Invalidate caches for other fields targeting the same vocabulary.
            foreach ($cache['vocabulary_targets'][$term_vid] as $clear_target) {
              if ($clear_target !== $target) {
                unset($cache['allowed_values'][$clear_target]);
              }
            }
          }
          break;

        // Lookup by tid.
        case FEEDS_TAXONOMY_SEARCH_TERM_ID:
          if (is_numeric($term)) {
            $tid = (int) $term;
          }
          break;

        // Lookup by GUID.
        case FEEDS_TAXONOMY_SEARCH_TERM_GUID:
          $tid = taxonomy_feeds_term_lookup_term_by_guid($term);
          break;
      }
    }
    if ($tid && isset($cache['allowed_values'][$target][$tid])) {
      $field[$language][] = array(
        'tid' => $tid,
      );
      $delta++;
    }
  }
  $entity->{$target} = $field;
}

/**
 * Finds all terms associated with the given node, within one vocabulary.
 */
function taxonomy_feeds_node_get_terms($node, $key = 'tid') {
  $terms =& drupal_static(__FUNCTION__);
  if (!isset($terms[$node->nid][$key])) {

    // Get tids from all taxonomy_term_reference fields.
    $tids = array();
    $fields = field_info_fields();
    foreach ($fields as $field_name => $field) {
      if ($field['type'] == 'taxonomy_term_reference' && field_info_instance('node', $field_name, $node->type)) {
        if (($items = field_get_items('node', $node, $field_name)) && is_array($items)) {
          $tids = array_merge($tids, array_map('_taxonomy_feeds_extract_tid', $items));
        }
      }
    }

    // Load terms and cache them in static var.
    $curr_terms = taxonomy_term_load_multiple($tids);
    $terms[$node->nid][$key] = array();
    foreach ($curr_terms as $term) {
      $terms[$node->nid][$key][$term->{$key}] = $term;
    }
  }
  return $terms[$node->nid][$key];
}

/**
 * Extracts tid from array item returned by field_get_items().
 *
 * @param array $item
 *   Tid information in the form of a single element array
 *   (key == 'tid', value == tid we're looking for)
 *
 * @return int
 *   Term id extracted from $item.
 *
 * @see taxonomy_feeds_node_get_terms()
 * @see field_get_items()
 */
function _taxonomy_feeds_extract_tid($item) {
  return $item['tid'];
}

/**
 * Looks up a term by GUID, assumes SQL storage backend.
 *
 * @param string $guid
 *   The Feeds GUID to compare against.
 *
 * @return int|false
 *   The term id, or FALSE if one was not found.
 */
function taxonomy_feeds_term_lookup_term_by_guid($guid) {
  return db_select('feeds_item')
    ->fields('feeds_item', array(
    'entity_id',
  ))
    ->condition('entity_type', 'taxonomy_term')
    ->condition('guid', $guid)
    ->execute()
    ->fetchField();
}

/**
 * Mapping configuration summary for taxonomy.module.
 */
function taxonomy_feeds_summary_callback(array $mapping, $target, array $form, array $form_state) {
  $options = _taxonomy_feeds_form_callback_options();
  if (empty($mapping['term_search'])) {
    return t('Search taxonomy terms by: <strong>@search</strong>', array(
      '@search' => $options[FEEDS_TAXONOMY_SEARCH_TERM_NAME],
    ));
  }
  return t('Search taxonomy terms by: <strong>@search</strong>', array(
    '@search' => $options[$mapping['term_search']],
  ));
}

/**
 * Settings form callback.
 */
function taxonomy_feeds_form_callback(array $mapping, $target, array $form, array $form_state) {
  return array(
    'term_search' => array(
      '#type' => 'select',
      '#title' => t('Search taxonomy terms by'),
      '#options' => _taxonomy_feeds_form_callback_options(),
      '#default_value' => !empty($mapping['term_search']) ? $mapping['term_search'] : FEEDS_TAXONOMY_SEARCH_TERM_NAME,
    ),
    'autocreate' => array(
      '#type' => 'checkbox',
      '#title' => t('Auto create'),
      '#description' => t("Create the term if it doesn't exist."),
      '#default_value' => !empty($mapping['autocreate']) ? $mapping['autocreate'] : 0,
      '#states' => array(
        'visible' => array(
          ':input[name$="[settings][term_search]"]' => array(
            'value' => FEEDS_TAXONOMY_SEARCH_TERM_NAME,
          ),
        ),
      ),
    ),
  );
}

/**
 * Returns the list of available term search methods.
 *
 * @return array
 *   An array of taxonomy search option titles.
 */
function _taxonomy_feeds_form_callback_options() {
  return array(
    FEEDS_TAXONOMY_SEARCH_TERM_NAME => 'Term name',
    FEEDS_TAXONOMY_SEARCH_TERM_ID => 'Term ID',
    FEEDS_TAXONOMY_SEARCH_TERM_GUID => 'GUID',
  );
}

Functions

Name	Description
taxonomy_feeds_form_callback	Settings form callback.
taxonomy_feeds_get_source	Callback, returns taxonomy from feed node.
taxonomy_feeds_node_get_terms	Finds all terms associated with the given node, within one vocabulary.
taxonomy_feeds_parser_sources_alter	Implements hook_feeds_parser_sources_alter().
taxonomy_feeds_processor_targets	Implements hook_feeds_processor_targets().
taxonomy_feeds_set_target	Callback for mapping taxonomy terms.
taxonomy_feeds_summary_callback	Mapping configuration summary for taxonomy.module.
taxonomy_feeds_term_lookup_term_by_guid	Looks up a term by GUID, assumes SQL storage backend.
_taxonomy_feeds_extract_tid	Extracts tid from array item returned by field_get_items().
_taxonomy_feeds_form_callback_options	Returns the list of available term search methods.

Constants

Name	Description
FEEDS_TAXONOMY_SEARCH_TERM_GUID	Search by GUID.
FEEDS_TAXONOMY_SEARCH_TERM_ID	Search by term id.
FEEDS_TAXONOMY_SEARCH_TERM_NAME	Search by term name.