danielebarchiesi@4: array('class'),
danielebarchiesi@4: );
danielebarchiesi@4: $plugins['behavior'] = array(
danielebarchiesi@4: 'classes' => array('class'),
danielebarchiesi@4: 'process' => 'entityreference_behavior_plugin_process',
danielebarchiesi@4: );
danielebarchiesi@4: return $plugins;
danielebarchiesi@4: }
danielebarchiesi@4:
danielebarchiesi@4: /**
danielebarchiesi@4: * CTools callback; Process the behavoir plugins.
danielebarchiesi@4: */
danielebarchiesi@4: function entityreference_behavior_plugin_process(&$plugin, $info) {
danielebarchiesi@4: $plugin += array(
danielebarchiesi@4: 'description' => '',
danielebarchiesi@4: 'behavior type' => 'field',
danielebarchiesi@4: 'access callback' => FALSE,
danielebarchiesi@4: 'force enabled' => FALSE,
danielebarchiesi@4: );
danielebarchiesi@4: }
danielebarchiesi@4:
danielebarchiesi@4: /**
danielebarchiesi@4: * Implements hook_field_info().
danielebarchiesi@4: */
danielebarchiesi@4: function entityreference_field_info() {
danielebarchiesi@4: $field_info['entityreference'] = array(
danielebarchiesi@4: 'label' => t('Entity Reference'),
danielebarchiesi@4: 'description' => t('This field reference another entity.'),
danielebarchiesi@4: 'settings' => array(
danielebarchiesi@4: // Default to the core target entity type node.
danielebarchiesi@4: 'target_type' => 'node',
danielebarchiesi@4: // The handler for this field.
danielebarchiesi@4: 'handler' => 'base',
danielebarchiesi@4: // The handler settings.
danielebarchiesi@4: 'handler_settings' => array(),
danielebarchiesi@4: ),
danielebarchiesi@4: 'instance_settings' => array(),
danielebarchiesi@4: 'default_widget' => 'entityreference_autocomplete',
danielebarchiesi@4: 'default_formatter' => 'entityreference_label',
danielebarchiesi@4: 'property_callbacks' => array('entityreference_field_property_callback'),
danielebarchiesi@4: );
danielebarchiesi@4: return $field_info;
danielebarchiesi@4: }
danielebarchiesi@4:
danielebarchiesi@4: /**
danielebarchiesi@4: * Implements hook_flush_caches().
danielebarchiesi@4: */
danielebarchiesi@4: function entityreference_flush_caches() {
danielebarchiesi@4: // Because of the intricacies of the info hooks, we are forced to keep a
danielebarchiesi@4: // separate list of the base tables of each entities, so that we can use
danielebarchiesi@4: // it in entityreference_field_schema() without calling entity_get_info().
danielebarchiesi@4: // See http://drupal.org/node/1416558 for details.
danielebarchiesi@4: $base_tables = array();
danielebarchiesi@4: foreach (entity_get_info() as $entity_type => $entity_info) {
danielebarchiesi@4: if (!empty($entity_info['base table']) && !empty($entity_info['entity keys']['id'])) {
danielebarchiesi@4: $base_tables[$entity_type] = array($entity_info['base table'], $entity_info['entity keys']['id']);
danielebarchiesi@4: }
danielebarchiesi@4: }
danielebarchiesi@4: // We are using a variable because cache is going to be cleared right after
danielebarchiesi@4: // hook_flush_caches() is finished.
danielebarchiesi@4: variable_set('entityreference:base-tables', $base_tables);
danielebarchiesi@4: }
danielebarchiesi@4:
danielebarchiesi@4: /**
danielebarchiesi@4: * Implements hook_menu().
danielebarchiesi@4: */
danielebarchiesi@4: function entityreference_menu() {
danielebarchiesi@4: $items = array();
danielebarchiesi@4:
danielebarchiesi@4: $items['entityreference/autocomplete/single/%/%/%'] = array(
danielebarchiesi@4: 'title' => 'Entity Reference Autocomplete',
danielebarchiesi@4: 'page callback' => 'entityreference_autocomplete_callback',
danielebarchiesi@4: 'page arguments' => array(2, 3, 4, 5),
danielebarchiesi@4: 'access callback' => 'entityreference_autocomplete_access_callback',
danielebarchiesi@4: 'access arguments' => array(2, 3, 4, 5),
danielebarchiesi@4: 'type' => MENU_CALLBACK,
danielebarchiesi@4: );
danielebarchiesi@4: $items['entityreference/autocomplete/tags/%/%/%'] = array(
danielebarchiesi@4: 'title' => 'Entity Reference Autocomplete',
danielebarchiesi@4: 'page callback' => 'entityreference_autocomplete_callback',
danielebarchiesi@4: 'page arguments' => array(2, 3, 4, 5),
danielebarchiesi@4: 'access callback' => 'entityreference_autocomplete_access_callback',
danielebarchiesi@4: 'access arguments' => array(2, 3, 4, 5),
danielebarchiesi@4: 'type' => MENU_CALLBACK,
danielebarchiesi@4: );
danielebarchiesi@4:
danielebarchiesi@4: return $items;
danielebarchiesi@4: }
danielebarchiesi@4:
danielebarchiesi@4: /**
danielebarchiesi@4: * Implements hook_field_is_empty().
danielebarchiesi@4: */
danielebarchiesi@4: function entityreference_field_is_empty($item, $field) {
danielebarchiesi@4: $empty = !isset($item['target_id']) || !is_numeric($item['target_id']);
danielebarchiesi@4:
danielebarchiesi@4: // Invoke the behaviors to allow them to override the empty status.
danielebarchiesi@4: foreach (entityreference_get_behavior_handlers($field) as $handler) {
danielebarchiesi@4: $handler->is_empty_alter($empty, $item, $field);
danielebarchiesi@4: }
danielebarchiesi@4: return $empty;
danielebarchiesi@4: }
danielebarchiesi@4:
danielebarchiesi@4: /**
danielebarchiesi@4: * Get the behavior handlers for a given entityreference field.
danielebarchiesi@4: */
danielebarchiesi@4: function entityreference_get_behavior_handlers($field, $instance = NULL) {
danielebarchiesi@4: $object_cache = drupal_static(__FUNCTION__);
danielebarchiesi@4: $identifier = $field['field_name'];
danielebarchiesi@4: if (!empty($instance)) {
danielebarchiesi@4: $identifier .= ':' . $instance['entity_type'] . ':' . $instance['bundle'];
danielebarchiesi@4: }
danielebarchiesi@4:
danielebarchiesi@4: if (!isset($object_cache[$identifier])) {
danielebarchiesi@4: $object_cache[$identifier] = array();
danielebarchiesi@4:
danielebarchiesi@4: // Merge in defaults.
danielebarchiesi@4: $field['settings'] += array('behaviors' => array());
danielebarchiesi@4:
danielebarchiesi@4: $object_cache[$field['field_name']] = array();
danielebarchiesi@4: $behaviors = !empty($field['settings']['handler_settings']['behaviors']) ? $field['settings']['handler_settings']['behaviors'] : array();
danielebarchiesi@4: if (!empty($instance['settings']['behaviors'])) {
danielebarchiesi@4: $behaviors = array_merge($behaviors, $instance['settings']['behaviors']);
danielebarchiesi@4: }
danielebarchiesi@4: foreach ($behaviors as $behavior => $settings) {
danielebarchiesi@4: if (empty($settings['status'])) {
danielebarchiesi@4: // Behavior is not enabled.
danielebarchiesi@4: continue;
danielebarchiesi@4: }
danielebarchiesi@4:
danielebarchiesi@4: $object_cache[$identifier][] = _entityreference_get_behavior_handler($behavior);
danielebarchiesi@4: }
danielebarchiesi@4: }
danielebarchiesi@4:
danielebarchiesi@4: return $object_cache[$identifier];
danielebarchiesi@4: }
danielebarchiesi@4:
danielebarchiesi@4: /**
danielebarchiesi@4: * Get the behavior handler for a given entityreference field and instance.
danielebarchiesi@4: *
danielebarchiesi@4: * @param $handler
danielebarchiesi@4: * The behavior handler name.
danielebarchiesi@4: */
danielebarchiesi@4: function _entityreference_get_behavior_handler($behavior) {
danielebarchiesi@4: $object_cache = drupal_static(__FUNCTION__);
danielebarchiesi@4:
danielebarchiesi@4: if (!isset($object_cache[$behavior])) {
danielebarchiesi@4: ctools_include('plugins');
danielebarchiesi@4: $class = ctools_plugin_load_class('entityreference', 'behavior', $behavior, 'class');
danielebarchiesi@4:
danielebarchiesi@4: $class = class_exists($class) ? $class : 'EntityReference_BehaviorHandler_Broken';
danielebarchiesi@4: $object_cache[$behavior] = new $class($behavior);
danielebarchiesi@4: }
danielebarchiesi@4:
danielebarchiesi@4: return $object_cache[$behavior];
danielebarchiesi@4: }
danielebarchiesi@4:
danielebarchiesi@4: /**
danielebarchiesi@4: * Get the selection handler for a given entityreference field.
danielebarchiesi@4: */
danielebarchiesi@4: function entityreference_get_selection_handler($field, $instance = NULL, $entity_type = NULL, $entity = NULL) {
danielebarchiesi@4: ctools_include('plugins');
danielebarchiesi@4: $handler = $field['settings']['handler'];
danielebarchiesi@4: $class = ctools_plugin_load_class('entityreference', 'selection', $handler, 'class');
danielebarchiesi@4:
danielebarchiesi@4: if (class_exists($class)) {
danielebarchiesi@4: return call_user_func(array($class, 'getInstance'), $field, $instance, $entity_type, $entity);
danielebarchiesi@4: }
danielebarchiesi@4: else {
danielebarchiesi@4: return EntityReference_SelectionHandler_Broken::getInstance($field, $instance, $entity_type, $entity);
danielebarchiesi@4: }
danielebarchiesi@4: }
danielebarchiesi@4:
danielebarchiesi@4: /**
danielebarchiesi@4: * Implements hook_field_load().
danielebarchiesi@4: */
danielebarchiesi@4: function entityreference_field_load($entity_type, $entities, $field, $instances, $langcode, &$items) {
danielebarchiesi@4: // Invoke the behaviors.
danielebarchiesi@4: foreach (entityreference_get_behavior_handlers($field) as $handler) {
danielebarchiesi@4: $handler->load($entity_type, $entities, $field, $instances, $langcode, $items);
danielebarchiesi@4: }
danielebarchiesi@4: }
danielebarchiesi@4:
danielebarchiesi@4: /**
danielebarchiesi@4: * Implements hook_field_validate().
danielebarchiesi@4: */
danielebarchiesi@4: function entityreference_field_validate($entity_type, $entity, $field, $instance, $langcode, $items, &$errors) {
danielebarchiesi@4: $ids = array();
danielebarchiesi@4: foreach ($items as $delta => $item) {
danielebarchiesi@4: if (!entityreference_field_is_empty($item, $field) && $item['target_id'] !== NULL) {
danielebarchiesi@4: $ids[$item['target_id']] = $delta;
danielebarchiesi@4: }
danielebarchiesi@4: }
danielebarchiesi@4:
danielebarchiesi@4: if ($ids) {
danielebarchiesi@4: $valid_ids = entityreference_get_selection_handler($field, $instance, $entity_type, $entity)->validateReferencableEntities(array_keys($ids));
danielebarchiesi@4:
danielebarchiesi@4: $invalid_entities = array_diff_key($ids, array_flip($valid_ids));
danielebarchiesi@4: if ($invalid_entities) {
danielebarchiesi@4: foreach ($invalid_entities as $id => $delta) {
danielebarchiesi@4: $errors[$field['field_name']][$langcode][$delta][] = array(
danielebarchiesi@4: 'error' => 'entityreference_invalid_entity',
danielebarchiesi@4: 'message' => t('The referenced entity (@type: @id) is invalid.', array('@type' => $field['settings']['target_type'], '@id' => $id)),
danielebarchiesi@4: );
danielebarchiesi@4: }
danielebarchiesi@4: }
danielebarchiesi@4: }
danielebarchiesi@4:
danielebarchiesi@4: // Invoke the behaviors.
danielebarchiesi@4: foreach (entityreference_get_behavior_handlers($field, $instance) as $handler) {
danielebarchiesi@4: $handler->validate($entity_type, $entity, $field, $instance, $langcode, $items, $errors);
danielebarchiesi@4: }
danielebarchiesi@4: }
danielebarchiesi@4:
danielebarchiesi@4: /**
danielebarchiesi@4: * Implements hook_field_presave().
danielebarchiesi@4: *
danielebarchiesi@4: * Adds the target type to the field data structure when saving.
danielebarchiesi@4: */
danielebarchiesi@4: function entityreference_field_presave($entity_type, $entity, $field, $instance, $langcode, &$items) {
danielebarchiesi@4: // Invoke the behaviors.
danielebarchiesi@4: foreach (entityreference_get_behavior_handlers($field, $instance) as $handler) {
danielebarchiesi@4: $handler->presave($entity_type, $entity, $field, $instance, $langcode, $items);
danielebarchiesi@4: }
danielebarchiesi@4: }
danielebarchiesi@4:
danielebarchiesi@4: /**
danielebarchiesi@4: * Implements hook_field_insert().
danielebarchiesi@4: */
danielebarchiesi@4: function entityreference_field_insert($entity_type, $entity, $field, $instance, $langcode, &$items) {
danielebarchiesi@4: // Invoke the behaviors.
danielebarchiesi@4: foreach (entityreference_get_behavior_handlers($field, $instance) as $handler) {
danielebarchiesi@4: $handler->insert($entity_type, $entity, $field, $instance, $langcode, $items);
danielebarchiesi@4: }
danielebarchiesi@4: }
danielebarchiesi@4:
danielebarchiesi@4: /**
danielebarchiesi@4: * Implements hook_field_attach_insert().
danielebarchiesi@4: *
danielebarchiesi@4: * Emulates a post-insert hook.
danielebarchiesi@4: */
danielebarchiesi@4: function entityreference_field_attach_insert($entity_type, $entity) {
danielebarchiesi@4: list(, , $bundle) = entity_extract_ids($entity_type, $entity);
danielebarchiesi@4: foreach (field_info_instances($entity_type, $bundle) as $field_name => $instance) {
danielebarchiesi@4: $field = field_info_field($field_name);
danielebarchiesi@4: if ($field['type'] == 'entityreference') {
danielebarchiesi@4: foreach (entityreference_get_behavior_handlers($field, $instance) as $handler) {
danielebarchiesi@4: $handler->postInsert($entity_type, $entity, $field, $instance);
danielebarchiesi@4: }
danielebarchiesi@4: }
danielebarchiesi@4: }
danielebarchiesi@4: }
danielebarchiesi@4:
danielebarchiesi@4: /**
danielebarchiesi@4: * Implements hook_field_update().
danielebarchiesi@4: */
danielebarchiesi@4: function entityreference_field_update($entity_type, $entity, $field, $instance, $langcode, &$items) {
danielebarchiesi@4: // Invoke the behaviors.
danielebarchiesi@4: foreach (entityreference_get_behavior_handlers($field, $instance) as $handler) {
danielebarchiesi@4: $handler->update($entity_type, $entity, $field, $instance, $langcode, $items);
danielebarchiesi@4: }
danielebarchiesi@4: }
danielebarchiesi@4:
danielebarchiesi@4: /**
danielebarchiesi@4: * Implements hook_field_attach_update().
danielebarchiesi@4: *
danielebarchiesi@4: * Emulates a post-update hook.
danielebarchiesi@4: */
danielebarchiesi@4: function entityreference_field_attach_update($entity_type, $entity) {
danielebarchiesi@4: list(, , $bundle) = entity_extract_ids($entity_type, $entity);
danielebarchiesi@4: foreach (field_info_instances($entity_type, $bundle) as $field_name => $instance) {
danielebarchiesi@4: $field = field_info_field($field_name);
danielebarchiesi@4: if ($field['type'] == 'entityreference') {
danielebarchiesi@4: foreach (entityreference_get_behavior_handlers($field, $instance) as $handler) {
danielebarchiesi@4: $handler->postUpdate($entity_type, $entity, $field, $instance);
danielebarchiesi@4: }
danielebarchiesi@4: }
danielebarchiesi@4: }
danielebarchiesi@4: }
danielebarchiesi@4:
danielebarchiesi@4: /**
danielebarchiesi@4: * Implements hook_field_delete().
danielebarchiesi@4: */
danielebarchiesi@4: function entityreference_field_delete($entity_type, $entity, $field, $instance, $langcode, &$items) {
danielebarchiesi@4: // Invoke the behaviors.
danielebarchiesi@4: foreach (entityreference_get_behavior_handlers($field, $instance) as $handler) {
danielebarchiesi@4: $handler->delete($entity_type, $entity, $field, $instance, $langcode, $items);
danielebarchiesi@4: }
danielebarchiesi@4: }
danielebarchiesi@4:
danielebarchiesi@4: /**
danielebarchiesi@4: * Implements hook_field_attach_delete().
danielebarchiesi@4: *
danielebarchiesi@4: * Emulates a post-delete hook.
danielebarchiesi@4: */
danielebarchiesi@4: function entityreference_field_attach_delete($entity_type, $entity) {
danielebarchiesi@4: list(, , $bundle) = entity_extract_ids($entity_type, $entity);
danielebarchiesi@4: foreach (field_info_instances($entity_type, $bundle) as $field_name => $instance) {
danielebarchiesi@4: $field = field_info_field($field_name);
danielebarchiesi@4: if ($field['type'] == 'entityreference') {
danielebarchiesi@4: foreach (entityreference_get_behavior_handlers($field, $instance) as $handler) {
danielebarchiesi@4: $handler->postDelete($entity_type, $entity, $field, $instance);
danielebarchiesi@4: }
danielebarchiesi@4: }
danielebarchiesi@4: }
danielebarchiesi@4: }
danielebarchiesi@4:
danielebarchiesi@4: /**
danielebarchiesi@4: * Implements hook_entity_insert().
danielebarchiesi@4: */
danielebarchiesi@4: function entityreference_entity_insert($entity, $entity_type) {
danielebarchiesi@4: entityreference_entity_crud($entity, $entity_type, 'entityPostInsert');
danielebarchiesi@4: }
danielebarchiesi@4:
danielebarchiesi@4: /**
danielebarchiesi@4: * Implements hook_entity_update().
danielebarchiesi@4: */
danielebarchiesi@4: function entityreference_entity_update($entity, $entity_type) {
danielebarchiesi@4: entityreference_entity_crud($entity, $entity_type, 'entityPostUpdate');
danielebarchiesi@4: }
danielebarchiesi@4:
danielebarchiesi@4: /**
danielebarchiesi@4: * Implements hook_entity_delete().
danielebarchiesi@4: */
danielebarchiesi@4: function entityreference_entity_delete($entity, $entity_type) {
danielebarchiesi@4: entityreference_entity_crud($entity, $entity_type, 'entityPostDelete');
danielebarchiesi@4: }
danielebarchiesi@4:
danielebarchiesi@4: /**
danielebarchiesi@4: * Invoke a behavior based on entity CRUD.
danielebarchiesi@4: *
danielebarchiesi@4: * @param $entity
danielebarchiesi@4: * The entity object.
danielebarchiesi@4: * @param $entity_type
danielebarchiesi@4: * The entity type.
danielebarchiesi@4: * @param $method_name
danielebarchiesi@4: * The method to invoke.
danielebarchiesi@4: */
danielebarchiesi@4: function entityreference_entity_crud($entity, $entity_type, $method_name) {
danielebarchiesi@4: list(, , $bundle) = entity_extract_ids($entity_type, $entity);
danielebarchiesi@4: foreach (field_info_instances($entity_type, $bundle) as $field_name => $instance) {
danielebarchiesi@4: $field = field_info_field($field_name);
danielebarchiesi@4: if ($field['type'] == 'entityreference') {
danielebarchiesi@4: foreach (entityreference_get_behavior_handlers($field, $instance) as $handler) {
danielebarchiesi@4: $handler->{$method_name}($entity_type, $entity, $field, $instance);
danielebarchiesi@4: }
danielebarchiesi@4: }
danielebarchiesi@4: }
danielebarchiesi@4: }
danielebarchiesi@4:
danielebarchiesi@4: /**
danielebarchiesi@4: * Implements hook_field_settings_form().
danielebarchiesi@4: */
danielebarchiesi@4: function entityreference_field_settings_form($field, $instance, $has_data) {
danielebarchiesi@4: // The field settings infrastructure is not AJAX enabled by default,
danielebarchiesi@4: // because it doesn't pass over the $form_state.
danielebarchiesi@4: // Build the whole form into a #process in which we actually have access
danielebarchiesi@4: // to the form state.
danielebarchiesi@4: $form = array(
danielebarchiesi@4: '#type' => 'container',
danielebarchiesi@4: '#attached' => array(
danielebarchiesi@4: 'css' => array(drupal_get_path('module', 'entityreference') . '/entityreference.admin.css'),
danielebarchiesi@4: ),
danielebarchiesi@4: '#process' => array(
danielebarchiesi@4: '_entityreference_field_settings_process',
danielebarchiesi@4: '_entityreference_field_settings_ajax_process',
danielebarchiesi@4: ),
danielebarchiesi@4: '#element_validate' => array('_entityreference_field_settings_validate'),
danielebarchiesi@4: '#field' => $field,
danielebarchiesi@4: '#instance' => $instance,
danielebarchiesi@4: '#has_data' => $has_data,
danielebarchiesi@4: );
danielebarchiesi@4: return $form;
danielebarchiesi@4: }
danielebarchiesi@4:
danielebarchiesi@4: function _entityreference_field_settings_process($form, $form_state) {
danielebarchiesi@4: $field = isset($form_state['entityreference']['field']) ? $form_state['entityreference']['field'] : $form['#field'];
danielebarchiesi@4: $instance = isset($form_state['entityreference']['instance']) ? $form_state['entityreference']['instance'] : $form['#instance'];
danielebarchiesi@4: $has_data = $form['#has_data'];
danielebarchiesi@4:
danielebarchiesi@4: $settings = $field['settings'];
danielebarchiesi@4: $settings += array('handler' => 'base');
danielebarchiesi@4:
danielebarchiesi@4: // Select the target entity type.
danielebarchiesi@4: $entity_type_options = array();
danielebarchiesi@4: foreach (entity_get_info() as $entity_type => $entity_info) {
danielebarchiesi@4: $entity_type_options[$entity_type] = $entity_info['label'];
danielebarchiesi@4: }
danielebarchiesi@4:
danielebarchiesi@4: $form['target_type'] = array(
danielebarchiesi@4: '#type' => 'select',
danielebarchiesi@4: '#title' => t('Target type'),
danielebarchiesi@4: '#options' => $entity_type_options,
danielebarchiesi@4: '#default_value' => $field['settings']['target_type'],
danielebarchiesi@4: '#required' => TRUE,
danielebarchiesi@4: '#description' => t('The entity type that can be referenced through this field.'),
danielebarchiesi@4: '#disabled' => $has_data,
danielebarchiesi@4: '#size' => 1,
danielebarchiesi@4: '#ajax' => TRUE,
danielebarchiesi@4: '#limit_validation_errors' => array(),
danielebarchiesi@4: );
danielebarchiesi@4:
danielebarchiesi@4: ctools_include('plugins');
danielebarchiesi@4: $handlers = ctools_get_plugins('entityreference', 'selection');
danielebarchiesi@4: uasort($handlers, 'ctools_plugin_sort');
danielebarchiesi@4: $handlers_options = array();
danielebarchiesi@4: foreach ($handlers as $handler => $handler_info) {
danielebarchiesi@4: $handlers_options[$handler] = check_plain($handler_info['title']);
danielebarchiesi@4: }
danielebarchiesi@4:
danielebarchiesi@4: $form['handler'] = array(
danielebarchiesi@4: '#type' => 'fieldset',
danielebarchiesi@4: '#title' => t('Entity selection'),
danielebarchiesi@4: '#tree' => TRUE,
danielebarchiesi@4: '#process' => array('_entityreference_form_process_merge_parent'),
danielebarchiesi@4: );
danielebarchiesi@4:
danielebarchiesi@4: $form['handler']['handler'] = array(
danielebarchiesi@4: '#type' => 'select',
danielebarchiesi@4: '#title' => t('Mode'),
danielebarchiesi@4: '#options' => $handlers_options,
danielebarchiesi@4: '#default_value' => $settings['handler'],
danielebarchiesi@4: '#required' => TRUE,
danielebarchiesi@4: '#ajax' => TRUE,
danielebarchiesi@4: '#limit_validation_errors' => array(),
danielebarchiesi@4: );
danielebarchiesi@4: $form['handler_submit'] = array(
danielebarchiesi@4: '#type' => 'submit',
danielebarchiesi@4: '#value' => t('Change handler'),
danielebarchiesi@4: '#limit_validation_errors' => array(),
danielebarchiesi@4: '#attributes' => array(
danielebarchiesi@4: 'class' => array('js-hide'),
danielebarchiesi@4: ),
danielebarchiesi@4: '#submit' => array('entityreference_settings_ajax_submit'),
danielebarchiesi@4: );
danielebarchiesi@4:
danielebarchiesi@4: $form['handler']['handler_settings'] = array(
danielebarchiesi@4: '#type' => 'container',
danielebarchiesi@4: '#attributes' => array('class' => array('entityreference-settings')),
danielebarchiesi@4: );
danielebarchiesi@4:
danielebarchiesi@4: $handler = entityreference_get_selection_handler($field, $instance);
danielebarchiesi@4: $form['handler']['handler_settings'] += $handler->settingsForm($field, $instance);
danielebarchiesi@4:
danielebarchiesi@4: _entityreference_get_behavior_elements($form, $field, $instance, 'field');
danielebarchiesi@4: if (!empty($form['behaviors'])) {
danielebarchiesi@4: $form['behaviors'] += array(
danielebarchiesi@4: '#type' => 'fieldset',
danielebarchiesi@4: '#title' => t('Additional behaviors'),
danielebarchiesi@4: '#parents' => array_merge($form['#parents'], array('handler_settings', 'behaviors')),
danielebarchiesi@4: );
danielebarchiesi@4: }
danielebarchiesi@4:
danielebarchiesi@4: return $form;
danielebarchiesi@4: }
danielebarchiesi@4:
danielebarchiesi@4: function _entityreference_field_settings_ajax_process($form, $form_state) {
danielebarchiesi@4: _entityreference_field_settings_ajax_process_element($form, $form);
danielebarchiesi@4: return $form;
danielebarchiesi@4: }
danielebarchiesi@4:
danielebarchiesi@4: function _entityreference_field_settings_ajax_process_element(&$element, $main_form) {
danielebarchiesi@4: if (isset($element['#ajax']) && $element['#ajax'] === TRUE) {
danielebarchiesi@4: $element['#ajax'] = array(
danielebarchiesi@4: 'callback' => 'entityreference_settings_ajax',
danielebarchiesi@4: 'wrapper' => $main_form['#id'],
danielebarchiesi@4: 'element' => $main_form['#array_parents'],
danielebarchiesi@4: );
danielebarchiesi@4: }
danielebarchiesi@4:
danielebarchiesi@4: foreach (element_children($element) as $key) {
danielebarchiesi@4: _entityreference_field_settings_ajax_process_element($element[$key], $main_form);
danielebarchiesi@4: }
danielebarchiesi@4: }
danielebarchiesi@4:
danielebarchiesi@4: function _entityreference_form_process_merge_parent($element) {
danielebarchiesi@4: $parents = $element['#parents'];
danielebarchiesi@4: array_pop($parents);
danielebarchiesi@4: $element['#parents'] = $parents;
danielebarchiesi@4: return $element;
danielebarchiesi@4: }
danielebarchiesi@4:
danielebarchiesi@4: function _entityreference_element_validate_filter(&$element, &$form_state) {
danielebarchiesi@4: $element['#value'] = array_filter($element['#value']);
danielebarchiesi@4: form_set_value($element, $element['#value'], $form_state);
danielebarchiesi@4: }
danielebarchiesi@4:
danielebarchiesi@4: function _entityreference_field_settings_validate($form, &$form_state) {
danielebarchiesi@4: // Store the new values in the form state.
danielebarchiesi@4: $field = $form['#field'];
danielebarchiesi@4: if (isset($form_state['values']['field'])) {
danielebarchiesi@4: $field['settings'] = $form_state['values']['field']['settings'];
danielebarchiesi@4: }
danielebarchiesi@4: $form_state['entityreference']['field'] = $field;
danielebarchiesi@4:
danielebarchiesi@4: unset($form_state['values']['field']['settings']['handler_submit']);
danielebarchiesi@4: }
danielebarchiesi@4:
danielebarchiesi@4: /**
danielebarchiesi@4: * Implements hook_field_instance_settings_form().
danielebarchiesi@4: */
danielebarchiesi@4: function entityreference_field_instance_settings_form($field, $instance) {
danielebarchiesi@4: $form['settings'] = array(
danielebarchiesi@4: '#type' => 'container',
danielebarchiesi@4: '#attached' => array(
danielebarchiesi@4: 'css' => array(drupal_get_path('module', 'entityreference') . '/entityreference.admin.css'),
danielebarchiesi@4: ),
danielebarchiesi@4: '#weight' => 10,
danielebarchiesi@4: '#tree' => TRUE,
danielebarchiesi@4: '#process' => array(
danielebarchiesi@4: '_entityreference_form_process_merge_parent',
danielebarchiesi@4: '_entityreference_field_instance_settings_form',
danielebarchiesi@4: '_entityreference_field_settings_ajax_process',
danielebarchiesi@4: ),
danielebarchiesi@4: '#element_validate' => array('_entityreference_field_instance_settings_validate'),
danielebarchiesi@4: '#field' => $field,
danielebarchiesi@4: '#instance' => $instance,
danielebarchiesi@4: );
danielebarchiesi@4:
danielebarchiesi@4: return $form;
danielebarchiesi@4: }
danielebarchiesi@4:
danielebarchiesi@4: function _entityreference_field_instance_settings_form($form, $form_state) {
danielebarchiesi@4: $field = isset($form_state['entityreference']['field']) ? $form_state['entityreference']['field'] : $form['#field'];
danielebarchiesi@4: $instance = isset($form_state['entityreference']['instance']) ? $form_state['entityreference']['instance'] : $form['#instance'];
danielebarchiesi@4:
danielebarchiesi@4: _entityreference_get_behavior_elements($form, $field, $instance, 'instance');
danielebarchiesi@4: if (!empty($form['behaviors'])) {
danielebarchiesi@4: $form['behaviors'] += array(
danielebarchiesi@4: '#type' => 'fieldset',
danielebarchiesi@4: '#title' => t('Additional behaviors'),
danielebarchiesi@4: '#process' => array(
danielebarchiesi@4: '_entityreference_field_settings_ajax_process',
danielebarchiesi@4: ),
danielebarchiesi@4: );
danielebarchiesi@4: }
danielebarchiesi@4: return $form;
danielebarchiesi@4: }
danielebarchiesi@4:
danielebarchiesi@4: function _entityreference_field_instance_settings_validate($form, &$form_state) {
danielebarchiesi@4: // Store the new values in the form state.
danielebarchiesi@4: $instance = $form['#instance'];
danielebarchiesi@4: if (isset($form_state['values']['instance'])) {
danielebarchiesi@4: $instance = drupal_array_merge_deep($instance, $form_state['values']['instance']);
danielebarchiesi@4: }
danielebarchiesi@4: $form_state['entityreference']['instance'] = $instance;
danielebarchiesi@4: }
danielebarchiesi@4:
danielebarchiesi@4: /**
danielebarchiesi@4: * Get the field or instance elements for the field configuration.
danielebarchiesi@4: */
danielebarchiesi@4: function _entityreference_get_behavior_elements(&$element, $field, $instance, $level) {
danielebarchiesi@4: // Add the accessible behavior handlers.
danielebarchiesi@4: $behavior_plugins = entityreference_get_accessible_behavior_plugins($field, $instance);
danielebarchiesi@4:
danielebarchiesi@4: if ($behavior_plugins[$level]) {
danielebarchiesi@4: $element['behaviors'] = array();
danielebarchiesi@4:
danielebarchiesi@4: foreach ($behavior_plugins[$level] as $name => $plugin) {
danielebarchiesi@4: if ($level == 'field') {
danielebarchiesi@4: $settings = !empty($field['settings']['handler_settings']['behaviors'][$name]) ? $field['settings']['handler_settings']['behaviors'][$name] : array();
danielebarchiesi@4: }
danielebarchiesi@4: else {
danielebarchiesi@4: $settings = !empty($instance['settings']['behaviors'][$name]) ? $instance['settings']['behaviors'][$name] : array();
danielebarchiesi@4: }
danielebarchiesi@4: $settings += array('status' => $plugin['force enabled']);
danielebarchiesi@4:
danielebarchiesi@4: // Render the checkbox.
danielebarchiesi@4: $element['behaviors'][$name] = array(
danielebarchiesi@4: '#tree' => TRUE,
danielebarchiesi@4: );
danielebarchiesi@4: $element['behaviors'][$name]['status'] = array(
danielebarchiesi@4: '#type' => 'checkbox',
danielebarchiesi@4: '#title' => check_plain($plugin['title']),
danielebarchiesi@4: '#description' => $plugin['description'],
danielebarchiesi@4: '#default_value' => $settings['status'],
danielebarchiesi@4: '#disabled' => $plugin['force enabled'],
danielebarchiesi@4: '#ajax' => TRUE,
danielebarchiesi@4: );
danielebarchiesi@4:
danielebarchiesi@4: if ($settings['status']) {
danielebarchiesi@4: $handler = _entityreference_get_behavior_handler($name);
danielebarchiesi@4: if ($behavior_elements = $handler->settingsForm($field, $instance)) {
danielebarchiesi@4: foreach ($behavior_elements as $key => &$behavior_element) {
danielebarchiesi@4: $behavior_element += array(
danielebarchiesi@4: '#default_value' => !empty($settings[$key]) ? $settings[$key] : NULL,
danielebarchiesi@4: );
danielebarchiesi@4: }
danielebarchiesi@4:
danielebarchiesi@4: // Get the behavior settings.
danielebarchiesi@4: $behavior_elements += array(
danielebarchiesi@4: '#type' => 'container',
danielebarchiesi@4: '#process' => array('_entityreference_form_process_merge_parent'),
danielebarchiesi@4: '#attributes' => array(
danielebarchiesi@4: 'class' => array('entityreference-settings'),
danielebarchiesi@4: ),
danielebarchiesi@4: );
danielebarchiesi@4: $element['behaviors'][$name]['settings'] = $behavior_elements;
danielebarchiesi@4: }
danielebarchiesi@4: }
danielebarchiesi@4: }
danielebarchiesi@4: }
danielebarchiesi@4: }
danielebarchiesi@4:
danielebarchiesi@4: /**
danielebarchiesi@4: * Get all accessible behavior plugins.
danielebarchiesi@4: */
danielebarchiesi@4: function entityreference_get_accessible_behavior_plugins($field, $instance) {
danielebarchiesi@4: ctools_include('plugins');
danielebarchiesi@4: $plugins = array('field' => array(), 'instance' => array());
danielebarchiesi@4: foreach (ctools_get_plugins('entityreference', 'behavior') as $name => $plugin) {
danielebarchiesi@4: $handler = _entityreference_get_behavior_handler($name);
danielebarchiesi@4: $level = $plugin['behavior type'];
danielebarchiesi@4: if ($handler->access($field, $instance)) {
danielebarchiesi@4: $plugins[$level][$name] = $plugin;
danielebarchiesi@4: }
danielebarchiesi@4: }
danielebarchiesi@4: return $plugins;
danielebarchiesi@4: }
danielebarchiesi@4:
danielebarchiesi@4: /**
danielebarchiesi@4: * Ajax callback for the handler settings form.
danielebarchiesi@4: *
danielebarchiesi@4: * @see entityreference_field_settings_form()
danielebarchiesi@4: */
danielebarchiesi@4: function entityreference_settings_ajax($form, $form_state) {
danielebarchiesi@4: $trigger = $form_state['triggering_element'];
danielebarchiesi@4: return drupal_array_get_nested_value($form, $trigger['#ajax']['element']);
danielebarchiesi@4: }
danielebarchiesi@4:
danielebarchiesi@4: /**
danielebarchiesi@4: * Submit handler for the non-JS case.
danielebarchiesi@4: *
danielebarchiesi@4: * @see entityreference_field_settings_form()
danielebarchiesi@4: */
danielebarchiesi@4: function entityreference_settings_ajax_submit($form, &$form_state) {
danielebarchiesi@4: $form_state['rebuild'] = TRUE;
danielebarchiesi@4: }
danielebarchiesi@4:
danielebarchiesi@4: /**
danielebarchiesi@4: * Property callback for the Entity Metadata framework.
danielebarchiesi@4: */
danielebarchiesi@4: function entityreference_field_property_callback(&$info, $entity_type, $field, $instance, $field_type) {
danielebarchiesi@4: // Set the property type based on the targe type.
danielebarchiesi@4: $field_type['property_type'] = $field['settings']['target_type'];
danielebarchiesi@4:
danielebarchiesi@4: // Then apply the default.
danielebarchiesi@4: entity_metadata_field_default_property_callback($info, $entity_type, $field, $instance, $field_type);
danielebarchiesi@4:
danielebarchiesi@4: // Invoke the behaviors to allow them to change the properties.
danielebarchiesi@4: foreach (entityreference_get_behavior_handlers($field, $instance) as $handler) {
danielebarchiesi@4: $handler->property_info_alter($info, $entity_type, $field, $instance, $field_type);
danielebarchiesi@4: }
danielebarchiesi@4: }
danielebarchiesi@4:
danielebarchiesi@4: /**
danielebarchiesi@4: * Implements hook_field_widget_info().
danielebarchiesi@4: */
danielebarchiesi@4: function entityreference_field_widget_info() {
danielebarchiesi@4: $widgets['entityreference_autocomplete'] = array(
danielebarchiesi@4: 'label' => t('Autocomplete'),
danielebarchiesi@4: 'description' => t('An autocomplete text field.'),
danielebarchiesi@4: 'field types' => array('entityreference'),
danielebarchiesi@4: 'settings' => array(
danielebarchiesi@4: 'match_operator' => 'CONTAINS',
danielebarchiesi@4: 'size' => 60,
danielebarchiesi@4: // We don't have a default here, because it's not the same between
danielebarchiesi@4: // the two widgets, and the Field API doesn't update default
danielebarchiesi@4: // settings when the widget changes.
danielebarchiesi@4: 'path' => '',
danielebarchiesi@4: ),
danielebarchiesi@4: );
danielebarchiesi@4:
danielebarchiesi@4: $widgets['entityreference_autocomplete_tags'] = array(
danielebarchiesi@4: 'label' => t('Autocomplete (Tags style)'),
danielebarchiesi@4: 'description' => t('An autocomplete text field.'),
danielebarchiesi@4: 'field types' => array('entityreference'),
danielebarchiesi@4: 'settings' => array(
danielebarchiesi@4: 'match_operator' => 'CONTAINS',
danielebarchiesi@4: 'size' => 60,
danielebarchiesi@4: // We don't have a default here, because it's not the same between
danielebarchiesi@4: // the two widgets, and the Field API doesn't update default
danielebarchiesi@4: // settings when the widget changes.
danielebarchiesi@4: 'path' => '',
danielebarchiesi@4: ),
danielebarchiesi@4: 'behaviors' => array(
danielebarchiesi@4: 'multiple values' => FIELD_BEHAVIOR_CUSTOM,
danielebarchiesi@4: ),
danielebarchiesi@4: );
danielebarchiesi@4:
danielebarchiesi@4: return $widgets;
danielebarchiesi@4: }
danielebarchiesi@4:
danielebarchiesi@4: /**
danielebarchiesi@4: * Implements hook_field_widget_info_alter().
danielebarchiesi@4: */
danielebarchiesi@4: function entityreference_field_widget_info_alter(&$info) {
danielebarchiesi@4: if (module_exists('options')) {
danielebarchiesi@4: $info['options_select']['field types'][] = 'entityreference';
danielebarchiesi@4: $info['options_buttons']['field types'][] = 'entityreference';
danielebarchiesi@4: }
danielebarchiesi@4: }
danielebarchiesi@4:
danielebarchiesi@4: /**
danielebarchiesi@4: * Implements hook_field_widget_settings_form().
danielebarchiesi@4: */
danielebarchiesi@4: function entityreference_field_widget_settings_form($field, $instance) {
danielebarchiesi@4: $widget = $instance['widget'];
danielebarchiesi@4: $settings = $widget['settings'] + field_info_widget_settings($widget['type']);
danielebarchiesi@4:
danielebarchiesi@4: $form = array();
danielebarchiesi@4:
danielebarchiesi@4: if ($widget['type'] == 'entityreference_autocomplete' || $widget['type'] == 'entityreference_autocomplete_tags') {
danielebarchiesi@4: $form['match_operator'] = array(
danielebarchiesi@4: '#type' => 'select',
danielebarchiesi@4: '#title' => t('Autocomplete matching'),
danielebarchiesi@4: '#default_value' => $settings['match_operator'],
danielebarchiesi@4: '#options' => array(
danielebarchiesi@4: 'STARTS_WITH' => t('Starts with'),
danielebarchiesi@4: 'CONTAINS' => t('Contains'),
danielebarchiesi@4: ),
danielebarchiesi@4: '#description' => t('Select the method used to collect autocomplete suggestions. Note that Contains can cause performance issues on sites with thousands of nodes.'),
danielebarchiesi@4: );
danielebarchiesi@4: $form['size'] = array(
danielebarchiesi@4: '#type' => 'textfield',
danielebarchiesi@4: '#title' => t('Size of textfield'),
danielebarchiesi@4: '#default_value' => $settings['size'],
danielebarchiesi@4: '#element_validate' => array('_element_validate_integer_positive'),
danielebarchiesi@4: '#required' => TRUE,
danielebarchiesi@4: );
danielebarchiesi@4: }
danielebarchiesi@4:
danielebarchiesi@4: return $form;
danielebarchiesi@4: }
danielebarchiesi@4:
danielebarchiesi@4: /**
danielebarchiesi@4: * Implements hook_options_list().
danielebarchiesi@4: */
danielebarchiesi@4: function entityreference_options_list($field, $instance = NULL, $entity_type = NULL, $entity = NULL) {
danielebarchiesi@4: if (!$options = entityreference_get_selection_handler($field, $instance, $entity_type, $entity)->getReferencableEntities()) {
danielebarchiesi@4: return array();
danielebarchiesi@4: }
danielebarchiesi@4:
danielebarchiesi@4: // Rebuild the array, by changing the bundle key into the bundle label.
danielebarchiesi@4: $target_type = $field['settings']['target_type'];
danielebarchiesi@4: $entity_info = entity_get_info($target_type);
danielebarchiesi@4:
danielebarchiesi@4: $return = array();
danielebarchiesi@4: foreach ($options as $bundle => $entity_ids) {
danielebarchiesi@4: $bundle_label = check_plain($entity_info['bundles'][$bundle]['label']);
danielebarchiesi@4: $return[$bundle_label] = $entity_ids;
danielebarchiesi@4: }
danielebarchiesi@4:
danielebarchiesi@4: return count($return) == 1 ? reset($return) : $return;
danielebarchiesi@4: }
danielebarchiesi@4:
danielebarchiesi@4: /**
danielebarchiesi@4: * Implements hook_query_TAG_alter().
danielebarchiesi@4: */
danielebarchiesi@4: function entityreference_query_entityreference_alter(QueryAlterableInterface $query) {
danielebarchiesi@4: $handler = $query->getMetadata('entityreference_selection_handler');
danielebarchiesi@4: $handler->entityFieldQueryAlter($query);
danielebarchiesi@4: }
danielebarchiesi@4:
danielebarchiesi@4: /**
danielebarchiesi@4: * Implements hook_field_widget_form().
danielebarchiesi@4: */
danielebarchiesi@4: function entityreference_field_widget_form(&$form, &$form_state, $field, $instance, $langcode, $items, $delta, $element) {
danielebarchiesi@4: $entity_type = $instance['entity_type'];
danielebarchiesi@4: $entity = isset($element['#entity']) ? $element['#entity'] : NULL;
danielebarchiesi@4: $handler = entityreference_get_selection_handler($field, $instance, $entity_type, $entity);
danielebarchiesi@4:
danielebarchiesi@4: if ($instance['widget']['type'] == 'entityreference_autocomplete' || $instance['widget']['type'] == 'entityreference_autocomplete_tags') {
danielebarchiesi@4:
danielebarchiesi@4: if ($instance['widget']['type'] == 'entityreference_autocomplete') {
danielebarchiesi@4: // We let the Field API handles multiple values for us, only take
danielebarchiesi@4: // care of the one matching our delta.
danielebarchiesi@4: if (isset($items[$delta])) {
danielebarchiesi@4: $items = array($items[$delta]);
danielebarchiesi@4: }
danielebarchiesi@4: else {
danielebarchiesi@4: $items = array();
danielebarchiesi@4: }
danielebarchiesi@4: }
danielebarchiesi@4:
danielebarchiesi@4: $entity_ids = array();
danielebarchiesi@4: $entity_labels = array();
danielebarchiesi@4:
danielebarchiesi@4: // Build an array of entities ID.
danielebarchiesi@4: foreach ($items as $item) {
danielebarchiesi@4: $entity_ids[] = $item['target_id'];
danielebarchiesi@4: }
danielebarchiesi@4:
danielebarchiesi@4: // Load those entities and loop through them to extract their labels.
danielebarchiesi@4: $entities = entity_load($field['settings']['target_type'], $entity_ids);
danielebarchiesi@4:
danielebarchiesi@4: foreach ($entities as $entity_id => $entity_item) {
danielebarchiesi@4: $label = $handler->getLabel($entity_item);
danielebarchiesi@4: $key = "$label ($entity_id)";
danielebarchiesi@4: // Labels containing commas or quotes must be wrapped in quotes.
danielebarchiesi@4: if (strpos($key, ',') !== FALSE || strpos($key, '"') !== FALSE) {
danielebarchiesi@4: $key = '"' . str_replace('"', '""', $key) . '"';
danielebarchiesi@4: }
danielebarchiesi@4: $entity_labels[] = $key;
danielebarchiesi@4: }
danielebarchiesi@4:
danielebarchiesi@4: // Prepare the autocomplete path.
danielebarchiesi@4: if (!empty($instance['widget']['settings']['path'])) {
danielebarchiesi@4: $autocomplete_path = $instance['widget']['settings']['path'];
danielebarchiesi@4: }
danielebarchiesi@4: else {
danielebarchiesi@4: $autocomplete_path = $instance['widget']['type'] == 'entityreference_autocomplete' ? 'entityreference/autocomplete/single' : 'entityreference/autocomplete/tags';
danielebarchiesi@4: }
danielebarchiesi@4:
danielebarchiesi@4: $autocomplete_path .= '/' . $field['field_name'] . '/' . $instance['entity_type'] . '/' . $instance['bundle'] . '/';
danielebarchiesi@4: // Use as a placeholder in the URL when we don't have an entity.
danielebarchiesi@4: // Most webservers collapse two consecutive slashes.
danielebarchiesi@4: $id = 'NULL';
danielebarchiesi@4: if ($entity) {
danielebarchiesi@4: list($eid) = entity_extract_ids($entity_type, $entity);
danielebarchiesi@4: if ($eid) {
danielebarchiesi@4: $id = $eid;
danielebarchiesi@4: }
danielebarchiesi@4: }
danielebarchiesi@4: $autocomplete_path .= $id;
danielebarchiesi@4:
danielebarchiesi@4: if ($instance['widget']['type'] == 'entityreference_autocomplete') {
danielebarchiesi@4: $element += array(
danielebarchiesi@4: '#type' => 'textfield',
danielebarchiesi@4: '#maxlength' => 1024,
danielebarchiesi@4: '#default_value' => implode(', ', $entity_labels),
danielebarchiesi@4: '#autocomplete_path' => $autocomplete_path,
danielebarchiesi@4: '#size' => $instance['widget']['settings']['size'],
danielebarchiesi@4: '#element_validate' => array('_entityreference_autocomplete_validate'),
danielebarchiesi@4: );
danielebarchiesi@4: return array('target_id' => $element);
danielebarchiesi@4: }
danielebarchiesi@4: else {
danielebarchiesi@4: $element += array(
danielebarchiesi@4: '#type' => 'textfield',
danielebarchiesi@4: '#maxlength' => 1024,
danielebarchiesi@4: '#default_value' => implode(', ', $entity_labels),
danielebarchiesi@4: '#autocomplete_path' => $autocomplete_path,
danielebarchiesi@4: '#size' => $instance['widget']['settings']['size'],
danielebarchiesi@4: '#element_validate' => array('_entityreference_autocomplete_tags_validate'),
danielebarchiesi@4: );
danielebarchiesi@4: return $element;
danielebarchiesi@4: }
danielebarchiesi@4: }
danielebarchiesi@4: }
danielebarchiesi@4:
danielebarchiesi@4: function _entityreference_autocomplete_validate($element, &$form_state, $form) {
danielebarchiesi@4: // If a value was entered into the autocomplete...
danielebarchiesi@4: $value = '';
danielebarchiesi@4: if (!empty($element['#value'])) {
danielebarchiesi@4: // Take "label (entity id)', match the id from parenthesis.
danielebarchiesi@4: if (preg_match("/.+\((\d+)\)/", $element['#value'], $matches)) {
danielebarchiesi@4: $value = $matches[1];
danielebarchiesi@4: }
danielebarchiesi@4: else {
danielebarchiesi@4: // Try to get a match from the input string when the user didn't use the
danielebarchiesi@4: // autocomplete but filled in a value manually.
danielebarchiesi@4: $field = field_info_field($element['#field_name']);
danielebarchiesi@4: $handler = entityreference_get_selection_handler($field);
danielebarchiesi@4: $field_name = $element['#field_name'];
danielebarchiesi@4: $field = field_info_field($field_name);
danielebarchiesi@4: $instance = field_info_instance($element['#entity_type'], $field_name, $element['#bundle']);
danielebarchiesi@4: $handler = entityreference_get_selection_handler($field, $instance);
danielebarchiesi@4: $value = $handler->validateAutocompleteInput($element['#value'], $element, $form_state, $form);
danielebarchiesi@4: }
danielebarchiesi@4: }
danielebarchiesi@4: // Update the value of this element so the field can validate the product IDs.
danielebarchiesi@4: form_set_value($element, $value, $form_state);
danielebarchiesi@4: }
danielebarchiesi@4:
danielebarchiesi@4: function _entityreference_autocomplete_tags_validate($element, &$form_state, $form) {
danielebarchiesi@4: $value = array();
danielebarchiesi@4: // If a value was entered into the autocomplete...
danielebarchiesi@4: if (!empty($element['#value'])) {
danielebarchiesi@4: $entities = drupal_explode_tags($element['#value']);
danielebarchiesi@4: $value = array();
danielebarchiesi@4: foreach ($entities as $entity) {
danielebarchiesi@4: // Take "label (entity id)', match the id from parenthesis.
danielebarchiesi@4: if (preg_match("/.+\((\d+)\)/", $entity, $matches)) {
danielebarchiesi@4: $value[] = array(
danielebarchiesi@4: 'target_id' => $matches[1],
danielebarchiesi@4: );
danielebarchiesi@4: }
danielebarchiesi@4: else {
danielebarchiesi@4: // Try to get a match from the input string when the user didn't use the
danielebarchiesi@4: // autocomplete but filled in a value manually.
danielebarchiesi@4: $field = field_info_field($element['#field_name']);
danielebarchiesi@4: $handler = entityreference_get_selection_handler($field);
danielebarchiesi@4: $value[] = array(
danielebarchiesi@4: 'target_id' => $handler->validateAutocompleteInput($entity, $element, $form_state, $form),
danielebarchiesi@4: );
danielebarchiesi@4: }
danielebarchiesi@4: }
danielebarchiesi@4: }
danielebarchiesi@4: // Update the value of this element so the field can validate the product IDs.
danielebarchiesi@4: form_set_value($element, $value, $form_state);
danielebarchiesi@4: }
danielebarchiesi@4:
danielebarchiesi@4: /**
danielebarchiesi@4: * Implements hook_field_widget_error().
danielebarchiesi@4: */
danielebarchiesi@4: function entityreference_field_widget_error($element, $error) {
danielebarchiesi@4: form_error($element, $error['message']);
danielebarchiesi@4: }
danielebarchiesi@4:
danielebarchiesi@4: /**
danielebarchiesi@4: * Menu Access callback for the autocomplete widget.
danielebarchiesi@4: *
danielebarchiesi@4: * @param $type
danielebarchiesi@4: * The widget type (i.e. 'single' or 'tags').
danielebarchiesi@4: * @param $field_name
danielebarchiesi@4: * The name of the entity-reference field.
danielebarchiesi@4: * @param $entity_type
danielebarchiesi@4: * The entity type.
danielebarchiesi@4: * @param $bundle_name
danielebarchiesi@4: * The bundle name.
danielebarchiesi@4: * @return
danielebarchiesi@4: * True if user can access this menu item.
danielebarchiesi@4: */
danielebarchiesi@4: function entityreference_autocomplete_access_callback($type, $field_name, $entity_type, $bundle_name) {
danielebarchiesi@4: $field = field_info_field($field_name);
danielebarchiesi@4: $instance = field_info_instance($entity_type, $field_name, $bundle_name);
danielebarchiesi@4:
danielebarchiesi@4: if (!$field || !$instance || $field['type'] != 'entityreference' || !field_access('edit', $field, $entity_type)) {
danielebarchiesi@4: return FALSE;
danielebarchiesi@4: }
danielebarchiesi@4: return TRUE;
danielebarchiesi@4: }
danielebarchiesi@4:
danielebarchiesi@4: /**
danielebarchiesi@4: * Menu callback: autocomplete the label of an entity.
danielebarchiesi@4: *
danielebarchiesi@4: * @param $type
danielebarchiesi@4: * The widget type (i.e. 'single' or 'tags').
danielebarchiesi@4: * @param $field_name
danielebarchiesi@4: * The name of the entity-reference field.
danielebarchiesi@4: * @param $entity_type
danielebarchiesi@4: * The entity type.
danielebarchiesi@4: * @param $bundle_name
danielebarchiesi@4: * The bundle name.
danielebarchiesi@4: * @param $entity_id
danielebarchiesi@4: * Optional; The entity ID the entity-reference field is attached to.
danielebarchiesi@4: * Defaults to ''.
danielebarchiesi@4: * @param $string
danielebarchiesi@4: * The label of the entity to query by.
danielebarchiesi@4: */
danielebarchiesi@4: function entityreference_autocomplete_callback($type, $field_name, $entity_type, $bundle_name, $entity_id = '', $string = '') {
danielebarchiesi@4: $field = field_info_field($field_name);
danielebarchiesi@4: $instance = field_info_instance($entity_type, $field_name, $bundle_name);
danielebarchiesi@4:
danielebarchiesi@4: return entityreference_autocomplete_callback_get_matches($type, $field, $instance, $entity_type, $entity_id, $string);
danielebarchiesi@4: }
danielebarchiesi@4:
danielebarchiesi@4: /**
danielebarchiesi@4: * Return JSON based on given field, instance and string.
danielebarchiesi@4: *
danielebarchiesi@4: * This function can be used by other modules that wish to pass a mocked
danielebarchiesi@4: * definition of the field on instance.
danielebarchiesi@4: *
danielebarchiesi@4: * @param $type
danielebarchiesi@4: * The widget type (i.e. 'single' or 'tags').
danielebarchiesi@4: * @param $field
danielebarchiesi@4: * The field array defintion.
danielebarchiesi@4: * @param $instance
danielebarchiesi@4: * The instance array defintion.
danielebarchiesi@4: * @param $entity_type
danielebarchiesi@4: * The entity type.
danielebarchiesi@4: * @param $entity_id
danielebarchiesi@4: * Optional; The entity ID the entity-reference field is attached to.
danielebarchiesi@4: * Defaults to ''.
danielebarchiesi@4: * @param $string
danielebarchiesi@4: * The label of the entity to query by.
danielebarchiesi@4: */
danielebarchiesi@4: function entityreference_autocomplete_callback_get_matches($type, $field, $instance, $entity_type, $entity_id = '', $string = '') {
danielebarchiesi@4: $matches = array();
danielebarchiesi@4:
danielebarchiesi@4: $entity = NULL;
danielebarchiesi@4: if ($entity_id !== 'NULL') {
danielebarchiesi@4: $entity = entity_load_single($entity_type, $entity_id);
danielebarchiesi@4: if (!$entity || !entity_access('view', $entity_type, $entity)) {
danielebarchiesi@4: return MENU_ACCESS_DENIED;
danielebarchiesi@4: }
danielebarchiesi@4: }
danielebarchiesi@4:
danielebarchiesi@4: $handler = entityreference_get_selection_handler($field, $instance, $entity_type, $entity);
danielebarchiesi@4:
danielebarchiesi@4: if ($type == 'tags') {
danielebarchiesi@4: // The user enters a comma-separated list of tags. We only autocomplete the last tag.
danielebarchiesi@4: $tags_typed = drupal_explode_tags($string);
danielebarchiesi@4: $tag_last = drupal_strtolower(array_pop($tags_typed));
danielebarchiesi@4: if (!empty($tag_last)) {
danielebarchiesi@4: $prefix = count($tags_typed) ? implode(', ', $tags_typed) . ', ' : '';
danielebarchiesi@4: }
danielebarchiesi@4: }
danielebarchiesi@4: else {
danielebarchiesi@4: // The user enters a single tag.
danielebarchiesi@4: $prefix = '';
danielebarchiesi@4: $tag_last = $string;
danielebarchiesi@4: }
danielebarchiesi@4:
danielebarchiesi@4: if (isset($tag_last)) {
danielebarchiesi@4: // Get an array of matching entities.
danielebarchiesi@4: $entity_labels = $handler->getReferencableEntities($tag_last, $instance['widget']['settings']['match_operator'], 10);
danielebarchiesi@4:
danielebarchiesi@4: // Loop through the products and convert them into autocomplete output.
danielebarchiesi@4: foreach ($entity_labels as $values) {
danielebarchiesi@4: foreach ($values as $entity_id => $label) {
danielebarchiesi@4: $key = "$label ($entity_id)";
danielebarchiesi@4: // Strip things like starting/trailing white spaces, line breaks and tags.
danielebarchiesi@4: $key = preg_replace('/\s\s+/', ' ', str_replace("\n", '', trim(decode_entities(strip_tags($key)))));
danielebarchiesi@4: // Names containing commas or quotes must be wrapped in quotes.
danielebarchiesi@4: if (strpos($key, ',') !== FALSE || strpos($key, '"') !== FALSE) {
danielebarchiesi@4: $key = '"' . str_replace('"', '""', $key) . '"';
danielebarchiesi@4: }
danielebarchiesi@4: $matches[$prefix . $key] = '' . $label . '
';
danielebarchiesi@4: }
danielebarchiesi@4: }
danielebarchiesi@4: }
danielebarchiesi@4:
danielebarchiesi@4: drupal_json_output($matches);
danielebarchiesi@4: }
danielebarchiesi@4:
danielebarchiesi@4: /**
danielebarchiesi@4: * Implements hook_field_formatter_info().
danielebarchiesi@4: */
danielebarchiesi@4: function entityreference_field_formatter_info() {
danielebarchiesi@4: return array(
danielebarchiesi@4: 'entityreference_label' => array(
danielebarchiesi@4: 'label' => t('Label'),
danielebarchiesi@4: 'description' => t('Display the label of the referenced entities.'),
danielebarchiesi@4: 'field types' => array('entityreference'),
danielebarchiesi@4: 'settings' => array(
danielebarchiesi@4: 'link' => FALSE,
danielebarchiesi@4: ),
danielebarchiesi@4: ),
danielebarchiesi@4: 'entityreference_entity_id' => array(
danielebarchiesi@4: 'label' => t('Entity id'),
danielebarchiesi@4: 'description' => t('Display the id of the referenced entities.'),
danielebarchiesi@4: 'field types' => array('entityreference'),
danielebarchiesi@4: ),
danielebarchiesi@4: 'entityreference_entity_view' => array(
danielebarchiesi@4: 'label' => t('Rendered entity'),
danielebarchiesi@4: 'description' => t('Display the referenced entities rendered by entity_view().'),
danielebarchiesi@4: 'field types' => array('entityreference'),
danielebarchiesi@4: 'settings' => array(
danielebarchiesi@4: 'view_mode' => '',
danielebarchiesi@4: 'links' => TRUE,
danielebarchiesi@4: ),
danielebarchiesi@4: ),
danielebarchiesi@4: );
danielebarchiesi@4: }
danielebarchiesi@4:
danielebarchiesi@4: /**
danielebarchiesi@4: * Implements hook_field_formatter_settings_form().
danielebarchiesi@4: */
danielebarchiesi@4: function entityreference_field_formatter_settings_form($field, $instance, $view_mode, $form, &$form_state) {
danielebarchiesi@4: $display = $instance['display'][$view_mode];
danielebarchiesi@4: $settings = $display['settings'];
danielebarchiesi@4:
danielebarchiesi@4: if ($display['type'] == 'entityreference_label') {
danielebarchiesi@4: $element['link'] = array(
danielebarchiesi@4: '#title' => t('Link label to the referenced entity'),
danielebarchiesi@4: '#type' => 'checkbox',
danielebarchiesi@4: '#default_value' => $settings['link'],
danielebarchiesi@4: );
danielebarchiesi@4: }
danielebarchiesi@4:
danielebarchiesi@4: if ($display['type'] == 'entityreference_entity_view') {
danielebarchiesi@4: $entity_info = entity_get_info($field['settings']['target_type']);
danielebarchiesi@4: $options = array();
danielebarchiesi@4: if (!empty($entity_info['view modes'])) {
danielebarchiesi@4: foreach ($entity_info['view modes'] as $view_mode => $view_mode_settings) {
danielebarchiesi@4: $options[$view_mode] = $view_mode_settings['label'];
danielebarchiesi@4: }
danielebarchiesi@4: }
danielebarchiesi@4:
danielebarchiesi@4: if (count($options) > 1) {
danielebarchiesi@4: $element['view_mode'] = array(
danielebarchiesi@4: '#type' => 'select',
danielebarchiesi@4: '#options' => $options,
danielebarchiesi@4: '#title' => t('View mode'),
danielebarchiesi@4: '#default_value' => $settings['view_mode'],
danielebarchiesi@4: );
danielebarchiesi@4: }
danielebarchiesi@4:
danielebarchiesi@4: $element['links'] = array(
danielebarchiesi@4: '#type' => 'checkbox',
danielebarchiesi@4: '#title' => t('Show links'),
danielebarchiesi@4: '#default_value' => $settings['links'],
danielebarchiesi@4: );
danielebarchiesi@4: }
danielebarchiesi@4:
danielebarchiesi@4: return $element;
danielebarchiesi@4: }
danielebarchiesi@4:
danielebarchiesi@4: /**
danielebarchiesi@4: * Implements hook_field_formatter_settings_summary().
danielebarchiesi@4: */
danielebarchiesi@4: function entityreference_field_formatter_settings_summary($field, $instance, $view_mode) {
danielebarchiesi@4: $display = $instance['display'][$view_mode];
danielebarchiesi@4: $settings = $display['settings'];
danielebarchiesi@4:
danielebarchiesi@4: $summary = array();
danielebarchiesi@4:
danielebarchiesi@4: if ($display['type'] == 'entityreference_label') {
danielebarchiesi@4: $summary[] = $settings['link'] ? t('Link to the referenced entity') : t('No link');
danielebarchiesi@4: }
danielebarchiesi@4:
danielebarchiesi@4: if ($display['type'] == 'entityreference_entity_view') {
danielebarchiesi@4: $entity_info = entity_get_info($field['settings']['target_type']);
danielebarchiesi@4: $summary[] = t('Rendered as @mode', array('@mode' => isset($entity_info['view modes'][$settings['view_mode']]['label']) ? $entity_info['view modes'][$settings['view_mode']]['label'] : $settings['view_mode']));
danielebarchiesi@4: $summary[] = !empty($settings['links']) ? t('Display links') : t('Do not display links');
danielebarchiesi@4: }
danielebarchiesi@4:
danielebarchiesi@4: return implode('
', $summary);
danielebarchiesi@4: }
danielebarchiesi@4:
danielebarchiesi@4: /**
danielebarchiesi@4: * Implements hook_field_formatter_prepare_view().
danielebarchiesi@4: */
danielebarchiesi@4: function entityreference_field_formatter_prepare_view($entity_type, $entities, $field, $instances, $langcode, &$items, $displays) {
danielebarchiesi@4: $target_ids = array();
danielebarchiesi@4:
danielebarchiesi@4: // Collect every possible entity attached to any of the entities.
danielebarchiesi@4: foreach ($entities as $id => $entity) {
danielebarchiesi@4: foreach ($items[$id] as $delta => $item) {
danielebarchiesi@4: if (isset($item['target_id'])) {
danielebarchiesi@4: $target_ids[] = $item['target_id'];
danielebarchiesi@4: }
danielebarchiesi@4: }
danielebarchiesi@4: }
danielebarchiesi@4:
danielebarchiesi@4: if ($target_ids) {
danielebarchiesi@4: $target_entities = entity_load($field['settings']['target_type'], $target_ids);
danielebarchiesi@4: }
danielebarchiesi@4: else {
danielebarchiesi@4: $target_entities = array();
danielebarchiesi@4: }
danielebarchiesi@4:
danielebarchiesi@4: // Iterate through the fieldable entities again to attach the loaded data.
danielebarchiesi@4: foreach ($entities as $id => $entity) {
danielebarchiesi@4: $rekey = FALSE;
danielebarchiesi@4:
danielebarchiesi@4: foreach ($items[$id] as $delta => $item) {
danielebarchiesi@4: // Check whether the referenced entity could be loaded.
danielebarchiesi@4: if (isset($target_entities[$item['target_id']])) {
danielebarchiesi@4: // Replace the instance value with the term data.
danielebarchiesi@4: $items[$id][$delta]['entity'] = $target_entities[$item['target_id']];
danielebarchiesi@4: // Check whether the user has access to the referenced entity.
danielebarchiesi@4: $items[$id][$delta]['access'] = entity_access('view', $field['settings']['target_type'], $target_entities[$item['target_id']]);
danielebarchiesi@4: }
danielebarchiesi@4: // Otherwise, unset the instance value, since the entity does not exist.
danielebarchiesi@4: else {
danielebarchiesi@4: unset($items[$id][$delta]);
danielebarchiesi@4: $rekey = TRUE;
danielebarchiesi@4: }
danielebarchiesi@4: }
danielebarchiesi@4:
danielebarchiesi@4: if ($rekey) {
danielebarchiesi@4: // Rekey the items array.
danielebarchiesi@4: $items[$id] = array_values($items[$id]);
danielebarchiesi@4: }
danielebarchiesi@4: }
danielebarchiesi@4: }
danielebarchiesi@4:
danielebarchiesi@4: /**
danielebarchiesi@4: * Implements hook_field_formatter_view().
danielebarchiesi@4: */
danielebarchiesi@4: function entityreference_field_formatter_view($entity_type, $entity, $field, $instance, $langcode, $items, $display) {
danielebarchiesi@4: $result = array();
danielebarchiesi@4: $settings = $display['settings'];
danielebarchiesi@4:
danielebarchiesi@4: // Rebuild the items list to contain only those with access.
danielebarchiesi@4: foreach ($items as $key => $item) {
danielebarchiesi@4: if (empty($item['access'])) {
danielebarchiesi@4: unset($items[$key]);
danielebarchiesi@4: }
danielebarchiesi@4: }
danielebarchiesi@4:
danielebarchiesi@4: switch ($display['type']) {
danielebarchiesi@4: case 'entityreference_label':
danielebarchiesi@4: $handler = entityreference_get_selection_handler($field, $instance, $entity_type, $entity);
danielebarchiesi@4:
danielebarchiesi@4: foreach ($items as $delta => $item) {
danielebarchiesi@4: $label = $handler->getLabel($item['entity']);
danielebarchiesi@4: // If the link is to be displayed and the entity has a uri, display a link.
danielebarchiesi@4: // Note the assignment ($url = ) here is intended to be an assignment.
danielebarchiesi@4: if ($display['settings']['link'] && ($uri = entity_uri($field['settings']['target_type'], $item['entity']))) {
danielebarchiesi@4: $result[$delta] = array('#markup' => l($label, $uri['path'], $uri['options']));
danielebarchiesi@4: }
danielebarchiesi@4: else {
danielebarchiesi@4: $result[$delta] = array('#markup' => check_plain($label));
danielebarchiesi@4: }
danielebarchiesi@4: }
danielebarchiesi@4: break;
danielebarchiesi@4:
danielebarchiesi@4: case 'entityreference_entity_id':
danielebarchiesi@4: foreach ($items as $delta => $item) {
danielebarchiesi@4: $result[$delta] = array('#markup' => check_plain($item['target_id']));
danielebarchiesi@4: }
danielebarchiesi@4: break;
danielebarchiesi@4:
danielebarchiesi@4: case 'entityreference_entity_view':
danielebarchiesi@4: foreach ($items as $delta => $item) {
danielebarchiesi@4: // Protect ourselves from recursive rendering.
danielebarchiesi@4: static $depth = 0;
danielebarchiesi@4: $depth++;
danielebarchiesi@4: if ($depth > 20) {
danielebarchiesi@4: 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'])));
danielebarchiesi@4: }
danielebarchiesi@4:
danielebarchiesi@4: $entity = clone $item['entity'];
danielebarchiesi@4: unset($entity->content);
danielebarchiesi@4: $result[$delta] = entity_view($field['settings']['target_type'], array($item['target_id'] => $entity), $settings['view_mode'], $langcode, FALSE);
danielebarchiesi@4:
danielebarchiesi@4: if (empty($settings['links']) && isset($result[$delta][$field['settings']['target_type']][$item['target_id']]['links'])) {
danielebarchiesi@4: $result[$delta][$field['settings']['target_type']][$item['target_id']]['links']['#access'] = FALSE;
danielebarchiesi@4: }
danielebarchiesi@4: $depth = 0;
danielebarchiesi@4: }
danielebarchiesi@4: break;
danielebarchiesi@4: }
danielebarchiesi@4:
danielebarchiesi@4: return $result;
danielebarchiesi@4: }
danielebarchiesi@4:
danielebarchiesi@4: /**
danielebarchiesi@4: * Exception thrown when the entity view renderer goes into a potentially infinite loop.
danielebarchiesi@4: */
danielebarchiesi@4: class EntityReferenceRecursiveRenderingException extends Exception {}
danielebarchiesi@4:
danielebarchiesi@4: /**
danielebarchiesi@4: * Implements hook_views_api().
danielebarchiesi@4: */
danielebarchiesi@4: function entityreference_views_api() {
danielebarchiesi@4: return array(
danielebarchiesi@4: 'api' => 3,
danielebarchiesi@4: 'path' => drupal_get_path('module', 'entityreference') . '/views',
danielebarchiesi@4: );
danielebarchiesi@4: }