From 7ebc48b81f0ddc5a16f30fb4dd44c9c69f7ebfe8 Mon Sep 17 00:00:00 2001 From: Wong Hoi Sing Edison Date: Wed, 31 Jul 2013 23:47:43 +0800 Subject: [PATCH] Issue #1580348 by bojanz: Make the formatters work with other reference fields. --- entityreference.module | 64 ++++++++++++++++++++++++++++++++++++------------ 1 file changed, 49 insertions(+), 15 deletions(-) diff --git a/entityreference.module b/entityreference.module index f01ef7b..d430328 100644 --- a/entityreference.module +++ b/entityreference.module @@ -1068,6 +1068,32 @@ function entityreference_autocomplete_callback_get_matches($type, $field, $insta } /** + * Introspects field and instance settings, and determines the correct settings + * for the functioning of the formatter. + * + * Settings: + * - entity_type - The entity_type being loaded. + * - column - The name of the ref. field column that stores the entity id. + */ +function entityreference_field_type_settings($field) { + $settings = array( + 'entity_type' => NULL, + 'column' => NULL, + ); + + if ($field['type'] == 'entityreference') { + $settings['entity_type'] = $field['settings']['target_type']; + $settings['column'] = 'target_id'; + } + elseif ($field['type'] == 'taxonomy_term_reference') { + $settings['entity_type'] = 'taxonomy_term'; + $settings['column'] = 'tid'; + } + + return $settings; +} + +/** * Implements hook_field_formatter_info(). */ function entityreference_field_formatter_info() { @@ -1088,7 +1114,7 @@ function entityreference_field_formatter_info() { 'entityreference_entity_view' => array( 'label' => t('Rendered entity'), 'description' => t('Display the referenced entities rendered by entity_view().'), - 'field types' => array('entityreference'), + 'field types' => array('entityreference', 'taxonomy_term_reference'), 'settings' => array( 'view_mode' => 'default', 'links' => TRUE, @@ -1103,6 +1129,7 @@ function entityreference_field_formatter_info() { function entityreference_field_formatter_settings_form($field, $instance, $view_mode, $form, &$form_state) { $display = $instance['display'][$view_mode]; $settings = $display['settings']; + $field_type_settings = entityreference_field_type_settings($field); if ($display['type'] == 'entityreference_label') { $element['link'] = array( @@ -1113,7 +1140,7 @@ function entityreference_field_formatter_settings_form($field, $instance, $view_ } if ($display['type'] == 'entityreference_entity_view') { - $entity_info = entity_get_info($field['settings']['target_type']); + $entity_info = entity_get_info($field_type_settings['entity_type']); $options = array('default' => t('Default')); if (!empty($entity_info['view modes'])) { foreach ($entity_info['view modes'] as $view_mode => $view_mode_settings) { @@ -1145,6 +1172,7 @@ function entityreference_field_formatter_settings_form($field, $instance, $view_ function entityreference_field_formatter_settings_summary($field, $instance, $view_mode) { $display = $instance['display'][$view_mode]; $settings = $display['settings']; + $field_type_settings = entityreference_field_type_settings($field); $summary = array(); @@ -1153,7 +1181,7 @@ function entityreference_field_formatter_settings_summary($field, $instance, $vi } if ($display['type'] == 'entityreference_entity_view') { - $entity_info = entity_get_info($field['settings']['target_type']); + $entity_info = entity_get_info($field_type_settings['entity_type']); $view_mode_label = $settings['view_mode'] == 'default' ? t('Default') : $settings['view_mode']; if (isset($entity_info['view modes'][$settings['view_mode']]['label'])) { $view_mode_label = $entity_info['view modes'][$settings['view_mode']]['label']; @@ -1169,19 +1197,22 @@ function entityreference_field_formatter_settings_summary($field, $instance, $vi * Implements hook_field_formatter_prepare_view(). */ function entityreference_field_formatter_prepare_view($entity_type, $entities, $field, $instances, $langcode, &$items, $displays) { + $field_type_settings = entityreference_field_type_settings($field); + $target_type = $field_type_settings['entity_type']; + $column = $field_type_settings['column']; $target_ids = array(); // Collect every possible entity attached to any of the entities. foreach ($entities as $id => $entity) { foreach ($items[$id] as $delta => $item) { - if (isset($item['target_id'])) { - $target_ids[] = $item['target_id']; + if (isset($item[$column])) { + $target_ids[] = $item[$column]; } } } if ($target_ids) { - $target_entities = entity_load($field['settings']['target_type'], $target_ids); + $target_entities = entity_load($target_type, $target_ids); } else { $target_entities = array(); @@ -1193,11 +1224,11 @@ function entityreference_field_formatter_prepare_view($entity_type, $entities, $ foreach ($items[$id] as $delta => $item) { // Check whether the referenced entity could be loaded. - if (isset($target_entities[$item['target_id']])) { + if (isset($target_entities[$item[$column]])) { // Replace the instance value with the term data. - $items[$id][$delta]['entity'] = $target_entities[$item['target_id']]; + $items[$id][$delta]['entity'] = $target_entities[$item[$column]]; // Check whether the user has access to the referenced entity. - $items[$id][$delta]['access'] = entity_access('view', $field['settings']['target_type'], $target_entities[$item['target_id']]); + $items[$id][$delta]['access'] = entity_access('view', $target_type, $target_entities[$item[$column]]); } // Otherwise, unset the instance value, since the entity does not exist. else { @@ -1219,6 +1250,9 @@ function entityreference_field_formatter_prepare_view($entity_type, $entities, $ function entityreference_field_formatter_view($entity_type, $entity, $field, $instance, $langcode, $items, $display) { $result = array(); $settings = $display['settings']; + $field_type_settings = entityreference_field_type_settings($field); + $target_type = $field_type_settings['entity_type']; + $column = $field_type_settings['column']; // Rebuild the items list to contain only those with access. foreach ($items as $key => $item) { @@ -1235,7 +1269,7 @@ function entityreference_field_formatter_view($entity_type, $entity, $field, $in $label = $handler->getLabel($item['entity']); // If the link is to be displayed and the entity has a uri, display a link. // Note the assignment ($url = ) here is intended to be an assignment. - if ($display['settings']['link'] && ($uri = entity_uri($field['settings']['target_type'], $item['entity']))) { + if ($display['settings']['link'] && ($uri = entity_uri($target_type, $item['entity']))) { $result[$delta] = array('#markup' => l($label, $uri['path'], $uri['options'])); } else { @@ -1246,7 +1280,7 @@ function entityreference_field_formatter_view($entity_type, $entity, $field, $in case 'entityreference_entity_id': foreach ($items as $delta => $item) { - $result[$delta] = array('#markup' => check_plain($item['target_id'])); + $result[$delta] = array('#markup' => check_plain($item[$column])); } break; @@ -1256,15 +1290,15 @@ function entityreference_field_formatter_view($entity_type, $entity, $field, $in static $depth = 0; $depth++; if ($depth > 20) { - throw new EntityReferenceRecursiveRenderingException(t('Recursive rendering detected when rendering entity @entity_type(@entity_id). Aborting rendering.', array('@entity_type' => $entity_type, '@entity_id' => $item['target_id']))); + throw new EntityReferenceRecursiveRenderingException(t('Recursive rendering detected when rendering entity @entity_type(@entity_id). Aborting rendering.', array('@entity_type' => $target_type, '@entity_id' => $item[$column]))); } $entity = clone $item['entity']; unset($entity->content); - $result[$delta] = entity_view($field['settings']['target_type'], array($item['target_id'] => $entity), $settings['view_mode'], $langcode, FALSE); + $result[$delta] = entity_view($target_type, array($item[$column] => $entity), $settings['view_mode'], $langcode, FALSE); - if (empty($settings['links']) && isset($result[$delta][$field['settings']['target_type']][$item['target_id']]['links'])) { - $result[$delta][$field['settings']['target_type']][$item['target_id']]['links']['#access'] = FALSE; + if (empty($settings['links']) && isset($result[$delta][$target_type][$column]['links'])) { + $result[$delta][$target_type][$item[$column]]['links']['#access'] = FALSE; } $depth = 0; } -- 1.7.9.5