|
|
Drupal example source code file (views_handler_relationship.inc)
The views_handler_relationship.inc Drupal example source code<?php // $Id: views_handler_relationship.inc,v 1.4.4.4 2010/12/17 21:42:19 merlinofchaos Exp $ /** * @file * Views' relationship handlers. */ /** * @defgroup views_relationship_handlers Views' relationship handlers * @{ * Handlers to tell Views how to create alternate relationships. */ /** * Simple relationship handler that allows a new version of the primary table * to be linked in. * * The base relationship handler can only handle a single join. Some relationships * are more complex and might require chains of joins; for those, you must * utilize a custom relationship handler. * * Definition items: * - base: The new base table this relationship will be adding. This does not * have to be a declared base table, but if there are no tables that * utilize this base table, it won't be very effective. * - base field: The field to use in the relationship; if left out this will be * assumed to be the primary field. * - relationship table: The actual table this relationship operates against. * This is analogous to using a 'table' override. * - relationship field: The actual field this relationship operates against. * This is analogous to using a 'real field' override. * - label: The default label to provide for this relationship, which is * shown in parentheses next to any field/sort/filter/argument that uses * the relationship. */ class views_handler_relationship extends views_handler { /** * Init handler to let relationships live on tables other than * the table they operate on. */ function init(&$view, &$options) { parent::init($view, $options); if (isset($this->definition['relationship table'])) { $this->table = $this->definition['relationship table']; } if (isset($this->definition['relationship field'])) { $this->field = $this->definition['relationship field']; } } /** * Get this field's label. */ function label() { if (!isset($this->options['label'])) { return $this->ui_name(); } return $this->options['label']; } function option_definition() { $options = parent::option_definition(); $label = !empty($this->definition['label']) ? $this->definition['label'] : $this->definition['field']; $options['label'] = array('default' => $label, 'translatable' => TRUE); $options['required'] = array('default' => FALSE); return $options; } /** * Default options form that provides the label widget that all fields * should have. */ function options_form(&$form, &$form_state) { parent::options_form($form, $form_state); $form['label'] = array( '#type' => 'textfield', '#title' => t('Label'), '#default_value' => isset($this->options['label']) ? $this->options['label'] : '', '#description' => t('The label for this relationship that will be displayed only administratively.'), ); $form['required'] = array( '#type' => 'checkbox', '#title' => t('Require this relationship'), '#description' => t('If required, items that do not contain this relationship will not appear.'), '#default_value' => !empty($this->options['required']), ); } /** * Called to implement a relationship in a query. */ function query() { // Figure out what base table this relationship brings to the party. $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'; } 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); } } /** * A special handler to take the place of missing or broken handlers. */ class views_handler_relationship_broken extends views_handler_relationship { function ui_name($short = FALSE) { return t('Broken/missing handler'); } function ensure_my_table() { /* No table to ensure! */ } function query() { /* No query to run */ } function options_form(&$form, &$form_state) { $form['markup'] = array( '#markup' => '<div class="form-item description">' . t('The handler for this item is broken or missing and cannot be used. If a module provided the handler and was disabled, re-enabling the module may restore it. Otherwise, you should probably delete this item.') . '</div>', ); } /** * Determine if the handler is considered 'broken' */ function broken() { return TRUE; } } /** * @} */ Other Drupal examples (source code examples)Here is a short list of links related to this Drupal views_handler_relationship.inc source code file: |
"Drupal" is a registered trademark of Dries Buytaert.
my drupal tutorials and examples
Copyright
1998-2016 Alvin Alexander, alvinalexander.com
All Rights Reserved.
Beginning in 2016, a portion of the proceeds from pages under the '/drupal-code-examples/' URI will be donated to charity.