diff --git a/README.txt b/README.txt
index 78f2266..dbd7b8f 100644
--- a/README.txt
+++ b/README.txt
@@ -122,8 +122,7 @@ Fivestar Rating with the Stars radio button.
explain their purpose. The Node ID field is the most important field on the page
which determines exactly what node will receive the value of the rating. In a
realy simple case, you could just enter the value 10 to always rate on the same
-node with nid = 10. Usually you'll need to enter PHP code to dynamically select
-what node you want to rate.
+node with nid = 10.
A common scenario is using fivestar with nodecomments to make reviews. If using
nodecomments a separate checkbox appears the Node ID field to allow you easily
diff --git a/fivestar.install b/fivestar.install
index 1484312..97d7bec 100644
--- a/fivestar.install
+++ b/fivestar.install
@@ -251,3 +251,20 @@ function fivestar_update_7202() {
}
}
}
+
+/**
+ * Add "self" target to fields that don't have a target already set.
+ */
+function fivestar_update_7203() {
+ $fields = field_read_fields(array('module' => 'fivestar'));
+
+ foreach($fields as $field) {
+ $instances = field_read_instances(array('field_name' => $field['field_name']));
+ foreach($instances as $instance) {
+ if ($instance['settings']['target'] == '') {
+ $instance['settings']['target'] = 'self';
+ }
+ field_update_instance($instance);
+ }
+ }
+}
\ No newline at end of file
diff --git a/fivestar.module b/fivestar.module
index 9f312f9..c174892 100644
--- a/fivestar.module
+++ b/fivestar.module
@@ -108,17 +108,13 @@ function fivestar_init() {
/**
* Implementation of hook_permission().
*
- * Exposes permissions for rating content, viewing aggregate ratings, and using PHP
- * snippets when configuring fivestar CCK fields.
+ * Exposes permissions for rating content.
*/
function fivestar_permission() {
return array(
'rate content' => array(
'title' => t('rate content'),
),
- 'use PHP for fivestar target' => array(
- 'title' => t('use PHP for fivestar target'),
- ),
);
}
@@ -1459,3 +1455,86 @@ function fivestar_votingapi_metadata_alter(&$data) {
);
}
}
+
+function fivestar_get_targets($field, $instance, $key = FALSE, $entity = FALSE, $langcode = LANGUAGE_NONE) {
+ $options = array();
+ $targets = module_invoke_all('fivestar_target_info', $field, $instance);
+ if ($key == FALSE) {
+ foreach ($targets as $target => $info) {
+ $options[$target] = $info['title'];
+ }
+ return $options;
+ }
+ else {
+ if (isset($targets[$key]) && function_exists($targets[$key]['callback'])) {
+ return call_user_func($targets[$key]['callback'], $entity, $field, $instance, $langcode);
+ }
+ }
+}
+
+/**
+ * Implements hook_fivestar_target_info().
+ */
+function fivestar_fivestar_target_info($field, $instance) {
+ $options = array(
+ 'self' => array(
+ 'title' => t('Self'),
+ 'callback' => '_fivestar_target_self',
+ ),
+ );
+
+ // Add node_referrence support.
+ if (module_exists('node_reference')) {
+ $fields = field_info_fields(array('type' => 'node_reference'));
+ foreach ($fields as $field_name => $content_field) {
+ // Make sure that this field exists for this type.
+ if (in_array($field['bundles'][$instance['entity_type']][0], $content_field['bundles']['node'])) {
+ $options[$content_field['field_name']] = array(
+ 'title' => t('Node reference: @field', array('@field' => $content_field['field_name'])),
+ 'callback' => '_fivestar_target_node_reference'
+ );
+ }
+ }
+ }
+
+ // Add comment module support.
+ if ($instance['entity_type'] == 'comment') {
+ $options['parent_node'] = array(
+ 'title' => t('Parent Node'),
+ 'callback' => '_fivestar_target_comment_parent_node'
+ );
+ }
+
+ return $options;
+}
+
+/**
+ *
+ * @return (array) array('entity_type', 'entity_id')
+ */
+function _fivestar_target_node_reference($entity, $field, $instance, $langcode) {
+ $targer = array();
+
+ $node_reference = $instance['settings']['target'];
+ if (isset($entity->{$node_reference}[$langcode][0]) && is_numeric($entity->{$node_reference}[$langcode][0]['nid'])) {
+ $target['entity_id'] = $entity->{$node_reference}[$langcode][0]['nid'];
+ $target['entity_type'] = 'node';
+ }
+
+ return $target;
+}
+
+function _fivestar_target_comment_parent_node($entity, $field, $instance, $langcode) {
+ return array(
+ 'entity_id' => $entity->nid,
+ 'entity_type' => 'node',
+ );
+}
+
+function _fivestar_target_self($entity, $field, $instance, $langcode) {
+ list($id, $vid, $bundle) = entity_extract_ids($instance['entity_type'], $entity);
+ return array(
+ 'entity_id' => $id,
+ 'entity_type' => $instance['entity_type'],
+ );
+}
\ No newline at end of file
diff --git a/includes/fivestar.field.inc b/includes/fivestar.field.inc
index 5f77cc1..c572405 100644
--- a/includes/fivestar.field.inc
+++ b/includes/fivestar.field.inc
@@ -59,53 +59,13 @@ function fivestar_field_instance_settings_form($field, $instance) {
'#default_value' => isset($instance['settings']['stars']) ? $instance['settings']['stars'] : 5,
);
- $dynamic_options = array();
- if (module_exists('node_reference')) {
- $fields = field_info_fields();
- foreach ($fields as $field_name => $content_field) {
- // Make sure that this field exists for this type.
- if ($content_field['type'] == 'node_reference' && in_array($field['bundles'][$instance['entity_type']][0], $content_field['bundles']['node'])) {
- $dynamic_options[$content_field['field_name']] = t('Node reference: @field', array('@field' => $content_field['field_name']));
- }
- }
- }
- if ($instance['entity_type'] == 'comment') {
- $dynamic_options['parent_node'] = t('Parent Node');
- }
-
- if (empty($dynamic_options)) {
- drupal_set_message(t('No potential target fields are available for the %type bundle. Create a node reference field in this bundle to make it easier to assign a vote to a node.', array('%type' => $instance['bundle'])), 'warning');
- }
-
- $dynamic_options = array('' => '<'. t('none') . '>') + $dynamic_options;
- $form['target'] = array(
- '#title' => t('Voting target'),
- '#type' => 'select',
- '#default_value' => isset($instance['settings']['target']) ? $instance['settings']['target'] : '',
- '#options' => $dynamic_options,
- '#description' => t('The voting target will make the value of this field cast a vote on another node. Use node reference fields module to create advanced reviews. Use the Parent Node Target when using fivestar with comments. More information available on the Fivestar handbook page.'),
- );
-
- if (user_access('use PHP for fivestar target')) {
- $form['php_target'] = array(
- '#type' => 'fieldset',
- '#title' => t('Voting target PHP code'),
- '#collapsible' => TRUE,
- '#collapsed' => empty($field['php_target']),
- );
- $form['php_target']['php_target'] = array(
- '#title' => t('Code'),
- '#type' => 'textarea',
- '#default_value' => isset($instance['settings']['php_target']['php_target']) ? $instance['settings']['php_target']['php_target'] : '',
- '#description' => t('Advanced usage only: PHP code that returns a target node ID. Should not include <?php ?> delimiters. If this field is filled out, the value returned by this code will override any value specified above. Note that executing incorrect PHP-code can break your Drupal site.'),
- );
- }
- else {
- $form['php_target']['php_target'] = array(
- '#type' => 'value',
- '#value' => isset($instance['settings']['php_target']) ? $instance['settings']['php_target'] : '',
- );
- }
+ $form['target'] = array(
+ '#title' => t('Voting target'),
+ '#type' => 'select',
+ '#default_value' => isset($instance['settings']['target']) ? $instance['settings']['target'] : '',
+ '#options' => fivestar_get_targets($field, $instance),
+ '#description' => t('The voting target will make the value of this field cast a vote on another node. Use node reference fields module to create advanced reviews. Use the Parent Node Target when using fivestar with comments. More information available on the Fivestar handbook page.'),
+ );
return $form;
}
@@ -147,9 +107,9 @@ function _fivestar_field_helper($entity_type, $entity, $field, $instance, $langc
$rating = (isset($items[$delta]['rating'])) ? $items[$delta]['rating'] : 0;
}
$items[$delta]['target'] = _fivestar_field_target($entity, $field, $instance, $item, $langcode);
- if (is_numeric($items[$delta]['target'])) {
- _fivestar_cast_vote('node', $items[$delta]['target'], $rating, $field['settings']['axis'], $entity->uid, FALSE, TRUE);
- votingapi_recalculate_results('node', $items[$delta]['target']);
+ if (!empty($items[$delta]['target'])) {
+ _fivestar_cast_vote($items[$delta]['target']['entity_type'], $items[$delta]['target']['entity_id'], $rating, $field['settings']['axis'], $entity->uid, FALSE, TRUE);
+ votingapi_recalculate_results($items[$delta]['target']['entity_type'], $items[$delta]['target']['entity_id']);
}
}
}
@@ -158,27 +118,17 @@ function _fivestar_field_helper($entity_type, $entity, $field, $instance, $langc
* Helper function to find the id that should be rated when a field is changed.
*/
function _fivestar_field_target($entity, $field, $instance, $item, $langcode) {
- $target = NULL;
- if (isset($instance['settings']['php_target']) && !empty($instance['settings']['php_target']['php_target'])) {
- // Use eval rather than drupal_eval to allow access to local variables.
- $target = eval($instance['settings']['php_target']['php_target']);
- }
- elseif (!empty($instance['settings']['target']) && $instance['settings']['target'] == 'parent_node') {
- // Allow comments to be voted against the parent node.
- $target = $entity->nid;
+ if (isset($instance['settings']['target'])) {
+ $target = fivestar_get_targets($field, $instance, $instance['settings']['target'], $entity, $langcode);
}
- elseif (!empty($instance['settings']['target']) && !empty($entity->$instance['settings']['target'])) {
- if (isset($entity->{$instance['settings']['target']}[$langcode][0]) && is_numeric($entity->{$instance['settings']['target']}[$langcode][0]['nid'])) {
- $target = $entity->{$instance['settings']['target']}[$langcode][0]['nid'];
- }
- elseif (is_numeric($entity->$instance['settings']['target'])) {
- $target = $entity->$instance['target'];
- }
- }
- elseif (isset($item['target'][0]['nid'])) {
- $target = $item['target'][0]['nid'];
+ else {
+ // If all else fails, default to voting on the instance the field is attached to.
+ list($id, $vid, $bundle) = entity_extract_ids($instance['entity_type'], $entity);
+ $target = array(
+ 'entity_id' => $id,
+ 'entity_type' => $instance['entity_type'],
+ );
}
-
return $target;
}