<?php
/**
* @file
* FeedsTermProcessor class.
*/
/**
* Feeds processor plugin. Create taxonomy terms from feed items.
*/
class FeedsTermProcessor extends FeedsProcessor {
/**
* Define entity type.
*/
public function entityType() {
return 'taxonomy_term';
}
/**
* Implements parent::entityInfo().
*/
protected function entityInfo() {
$info = parent::entityInfo();
$info['label plural'] = t('Terms');
return $info;
}
/**
* Creates a new term in memory and returns it.
*/
protected function newEntity(FeedsSource $source) {
$vocabulary = $this->vocabulary();
$term = new stdClass();
$term->vid = $vocabulary->vid;
$term->vocabulary_machine_name = $vocabulary->machine_name;
return $term;
}
/**
* Loads an existing term.
*/
protected function entityLoad(FeedsSource $source, $tid) {
return taxonomy_term_load($tid);
}
/**
* Validates a term.
*/
protected function entityValidate($term) {
if (empty($term->name)) {
throw new FeedsValidationException(t('Term name missing.'));
}
}
/**
* Saves a term.
*
* We de-array parent fields with only one item.
* This stops leftandright module from freaking out.
*/
protected function entitySave($term) {
if (isset($term->parent)) {
if (is_array($term->parent) && count($term->parent) == 1) {
$term->parent = reset($term->parent);
}
if (isset($term->tid) && ($term->parent == $term->tid || (is_array($term->parent) && in_array($term->tid, $term->parent)))) {
throw new FeedsValidationException(t("A term can't be its own child. GUID:@guid", array('@guid' => $term->feeds_item->guid)));
}
}
taxonomy_term_save($term);
}
/**
* Deletes a series of terms.
*/
protected function entityDeleteMultiple($tids) {
foreach ($tids as $tid) {
taxonomy_term_delete($tid);
}
}
/**
* Override parent::configDefaults().
*/
public function configDefaults() {
return array(
'vocabulary' => 0,
'force_update' => TRUE,
) + parent::configDefaults();
}
/**
* Override parent::configForm().
*/
public function configForm(&$form_state) {
$options = array(0 => t('Select a vocabulary'));
foreach (taxonomy_get_vocabularies() as $vocab) {
$options[$vocab->machine_name] = $vocab->name;
}
$form = parent::configForm($form_state);
$form['vocabulary'] = array(
'#type' => 'select',
'#title' => t('Import to vocabulary'),
'#description' => t('Choose the vocabulary to import into. <strong>CAUTION:</strong> when deleting terms through the "Delete items" tab, Feeds will delete <em>all</em> terms from this vocabulary.'),
'#options' => $options,
'#default_value' => $this->config['vocabulary'],
);
$form['force_update'] = array(
'#type' => 'checkbox',
'#title' => t('Force update'),
'#description' => t('Force update of imported terms even if no data change. For import of <strong>term parents</strong> you need to import twice and set this in the second pass.'),
'#default_value' => $this->config['force_update'],
);
return $form;
}
/**
* Override parent::configFormValidate().
*/
public function configFormValidate(&$values) {
if (empty($values['vocabulary'])) {
form_set_error('vocabulary', t('Choose a vocabulary'));
}
}
/**
* Override setTargetElement to operate on a target item that is a taxonomy term.
*/
public function setTargetElement(FeedsSource $source, $target_term, $target_element, $value) {
switch ($target_element) {
case 'parent':
if (!empty($value)) {
$terms = taxonomy_get_term_by_name($value);
$parent_tid = '';
foreach ($terms as $term) {
if ($term->vid == $target_term->vid) {
$parent_tid = $term->tid;
}
}
if (!empty($parent_tid)) {
$target_term->parent[] = $parent_tid;
}
else {
$target_term->parent[] = 0;
}
}
else {
$target_term->parent[] = 0;
}
break;
case 'parentguid':
// value is parent_guid field value
$query = db_select('feeds_item')
->fields('feeds_item', array('entity_id'))
->condition('entity_type', $this->entityType());
$parent_tid = $query->condition('guid', $value)->execute()->fetchField();
$target_term->parent[] = ($parent_tid) ? $parent_tid : 0;
break;
case 'weight':
if (!empty($value)) {
$weight = intval($value);
}
else {
$weight = 0;
}
$target_term->weight = $weight;
break;
case 'path_alias':
$target_term->path = array();
// Check for existing aliases.
if (!empty($target_term->tid)) {
if ($path = path_load('taxonomy/term/' . $target_term->tid)) {
$target_term->path = $path;
}
}
$target_term->path['alias'] = $value;
break;
default:
parent::setTargetElement($source, $target_term, $target_element, $value);
break;
}
}
/**
* Return available mapping targets.
*/
public function getMappingTargets() {
$targets = parent::getMappingTargets();
$targets += array(
'name' => array(
'name' => t('Term name'),
'description' => t('Name of the taxonomy term.'),
'optional_unique' => TRUE,
),
'parent' => array(
'name' => t('Parent Term Name'),
'description' => t('Name of the Parent Term.'),
'optional_unique' => TRUE,
),
'parentguid' => array(
'name' => t('Parent GUID'),
'description' => t('The globally unique identifier of the item\'s parent term.'),
'optional_unique' => TRUE,
),
'weight' => array(
'name' => t('Term Weight'),
'description' => t('Weight of the Term.'),
'optional_unique' => TRUE,
),
'description' => array(
'name' => t('Term description'),
'description' => t('Description of the taxonomy term.'),
),
);
// If path is enabled expose path alias.
if (module_exists('path')) {
$targets['path_alias'] = array(
'name' => t('Path alias'),
'description' => t('URL path alias for the taxonomy term.'),
);
}
// Let implementers of hook_feeds_term_processor_targets() add their targets.
try {
self::loadMappers();
feeds_alter('feeds_processor_targets', $targets, 'taxonomy_term', $this->vocabulary()->machine_name);
}
catch (Exception $e) {
// Do nothing.
}
return $targets;
}
/**
* Get id of an existing feed item term if available.
*/
protected function existingEntityId(FeedsSource $source, FeedsParserResult $result) {
if ($tid = parent::existingEntityId($source, $result)) {
return $tid;
}
// The only possible unique target is name.
foreach ($this->uniqueTargets($source, $result) as $target => $value) {
if ($target == 'name') {
$vocabulary = $this->vocabulary();
if ($tid = db_query("SELECT tid FROM {taxonomy_term_data} WHERE name = :name AND vid = :vid", array(':name' => $value, ':vid' => $vocabulary->vid))->fetchField()) {
return $tid;
}
} else if($target == 'guid') {
$query = db_select('feeds_item')
->fields('feeds_item', array('entity_id'))
->condition('entity_type', 'taxonomy_term');
$tid = $query->condition('guid', $value)->execute()->fetchField();
return ($tid) ? $tid : 0;
}
}
return 0;
}
/**
* Return vocabulary to map to.
*/
public function vocabulary() {
if (isset($this->config['vocabulary'])) {
if ($vocabulary = taxonomy_vocabulary_machine_name_load($this->config['vocabulary'])) {
return $vocabulary;
}
}
throw new Exception(t('No vocabulary defined for Taxonomy Term processor.'));
}
/**
* Override getHash()
*
* @return string
*/
protected function getHash($entity_id) {
if($this->config['force_update']) {
return ''; // dummy to always update
} else {
return parent::getHash($entity_id);
}
}
}