summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorfago2011-10-18 11:24:07 (GMT)
committerfago2011-10-18 11:27:14 (GMT)
commitf7e754471b9a6d0096a766f027b14289bf4c468d (patch)
treeacba37d3820e90951d2179db0459dce5f0390dff
parent5a6ccb677828887823788f010bfa32cc12745b51 (diff)
limit by bundle
-rw-r--r--entity.info1
-rw-r--r--views/entity.views.inc24
-rw-r--r--views/handlers/entity_views_handler_relationship_by_bundle.inc116
3 files changed, 139 insertions, 2 deletions
diff --git a/entity.info b/entity.info
index 958e28c..5689554 100644
--- a/entity.info
+++ b/entity.info
@@ -10,3 +10,4 @@ files[] = entity.features.inc
files[] = entity.info.inc
files[] = entity.rules.inc
files[] = entity.test
+files[] = views/handlers/entity_views_handler_relationship_by_bundle.inc
diff --git a/views/entity.views.inc b/views/entity.views.inc
index a509407..34608fb 100644
--- a/views/entity.views.inc
+++ b/views/entity.views.inc
@@ -160,7 +160,7 @@ class EntityDefaultViewsController {
'help' => t("Associated @label via the @label's @property.", array('@label' => $label_lowercase, '@property' => $property_label_lowercase)),
'relationship' => array(
'label' => $this->info['label'],
- 'handler' => 'views_handler_relationship',
+ 'handler' => $this->getRelationshipHandlerClass($this->type, $type),
'base' => $this->info['base table'],
'base field' => $views_field_name,
'relationship field' => isset($info['entity keys']['name']) ? $info['entity keys']['name'] : $info['entity keys']['id'],
@@ -169,7 +169,7 @@ class EntityDefaultViewsController {
$return['relationship'] = array(
'label' => drupal_ucfirst($info['label']),
- 'handler' => 'views_handler_relationship',
+ 'handler' => $this->getRelationshipHandlerClass($type, $this->type),
'base' => $info['base table'],
'base field' => isset($info['entity keys']['name']) ? $info['entity keys']['name'] : $info['entity keys']['id'],
'relationship field' => $views_field_name,
@@ -309,6 +309,26 @@ class EntityDefaultViewsController {
}
/**
+ * Determines the handler to use for a relationship to an entity type.
+ *
+ * @param $entity_type
+ * The entity type to join to.
+ * @param $left_type
+ * The data type from which to join.
+ */
+ function getRelationshipHandlerClass($entity_type, $left_type) {
+ foreach (entity_get_info() as $type => $info) {
+ // If there is bundle entity for the given entity-type allow filtering
+ // the relation by bundle. Exception: If joined from the bundle entity
+ // we do not need to filter by bundle entity any more.
+ if (!empty($info['bundle of']) && $info['bundle of'] == $entity_type && $type != $left_type) {
+ return 'entity_views_handler_relationship_by_bundle';
+ }
+ }
+ return 'views_handler_relationship';
+ }
+
+ /**
* A callback returning property options, suitable to be used as views options callback.
*/
public static function optionsListCallback($type, $selector, $op = 'view') {
diff --git a/views/handlers/entity_views_handler_relationship_by_bundle.inc b/views/handlers/entity_views_handler_relationship_by_bundle.inc
new file mode 100644
index 0000000..f5457a0
--- /dev/null
+++ b/views/handlers/entity_views_handler_relationship_by_bundle.inc
@@ -0,0 +1,116 @@
+<?php
+/**
+ * @file
+ * Contains the entity_views_handler_relationship_by_bundle class.
+ */
+
+/**
+ * Relationship handler for entity relationships that may limit the join to one or more bundles.
+ *
+ * This handler is only applicable for entities that are using bundle entities,
+ * i.e. entities having the 'bundle of' entity info key set.
+ *
+ * For example, this allows a relationship from users to profiles of a certain
+ * profile type.
+ *
+ * @see entity_crud_hook_entity_info()
+ * @ingroup views_field_handlers
+ */
+class entity_views_handler_relationship_by_bundle extends views_handler_relationship {
+ function option_definition() {
+ $options = parent::option_definition();
+ $options['bundle_types'] = array('default' => array());
+
+ return $options;
+ }
+
+ /**
+ * Add an entity type option.
+ */
+ function options_form(&$form, &$form_state) {
+ parent::options_form($form, $form_state);
+
+ // Get the entity type and info from the table data for the base on the
+ // right hand side of the relationship join.
+ $table_data = views_fetch_data($this->definition['base']);
+ $entity_type = $table_data['table']['entity type'];
+ $entity_info = entity_get_info($entity_type);
+
+ // Get the info of the bundle entity.
+ foreach (entity_get_info() as $type => $info) {
+ if (isset($info['bundle of']) && $info['bundle of'] == $entity_type) {
+ $entity_bundle_info = $info;
+ break;
+ }
+ }
+
+ $plural_label = isset($entity_bundle_info['plural label']) ? $entity_bundle_info['plural label'] : $entity_bundle_info['label'] . 's';
+ $bundle_options = array();
+ foreach ($entity_info['bundles'] as $name => $info) {
+ $bundle_options[$name] = $info['label'];
+ }
+
+ $form['bundle_types'] = array(
+ '#title' => $plural_label,
+ '#type' => 'checkboxes',
+ '#description' => t('Restrict this relationship to one or more @bundles.', array('@bundles' => strtolower($entity_bundle_info['plural label']))),
+ '#options' => $bundle_options,
+ '#default_value' => $this->options['bundle_types'],
+ );
+ }
+
+ /**
+ * Make sure only checked bundle types are left.
+ */
+ function options_submit(&$form, &$form_state) {
+ $form_state['values']['bundle_types'] = array_filter($form_state['values']['bundle_types']);
+ parent::options_submit($form, $form_state);
+ }
+
+ /**
+ * Called to implement a relationship in a query.
+ *
+ * Mostly the same as the parent method, except we add an extra clause to
+ * the join.
+ */
+ function query() {
+ $table_data = views_fetch_data($this->definition['base']);
+ $base_field = empty($this->definition['base field']) ? $table_data['table']['base']['field'] : $this->definition['base field'];
+ $this->ensure_my_table();
+
+ $def = $this->definition;
+ $def['table'] = $this->definition['base'];
+ $def['field'] = $base_field;
+ $def['left_table'] = $this->table_alias;
+ $def['left_field'] = $this->field;
+ if (!empty($this->options['required'])) {
+ $def['type'] = 'INNER';
+ }
+
+ // Add an extra clause to the join if there are bundle types selected.
+ if ($this->options['bundle_types']) {
+ $def['extra'] = array(
+ array(
+ // The table and the IN operator are implicit.
+ 'field' => 'type',
+ 'value' => $this->options['bundle_types'],
+ ),
+ );
+ }
+
+ if (!empty($def['join_handler']) && class_exists($def['join_handler'])) {
+ $join = new $def['join_handler'];
+ }
+ else {
+ $join = new views_join();
+ }
+
+ $join->definition = $def;
+ $join->construct();
+ $join->adjusted = TRUE;
+
+ // Use a short alias for this.
+ $alias = $def['table'] . '_' . $this->table;
+ $this->alias = $this->query->add_relationship($alias, $join, $this->definition['base'], $this->relationship);
+ }
+}