class views_handler_relationship
- 3.x handlers/views_handler_relationship.inc views_handler_relationship
- 2.x handlers/views_handler_relationship.inc views_handler_relationship
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.
Hierarchy
- class \views_object
- class \views_handler
- class \views_handler_relationship
- class \views_handler
Expanded class hierarchy of views_handler_relationship
Related topics
13 string references to 'views_handler_relationship'
- book_views_data in modules/
book.views.inc - Implements hook_views_data().
- comment_views_data in modules/
comment.views.inc - comment_views_data_alter in modules/
comment.views.inc - Use views_data_alter to add items to the node table that are relevant to comments.
- file_field_views_data in modules/
file.views.inc - Implements hook_field_views_data().
- hook_views_data in ./
views.api.php - Describes data tables (or the equivalent) to Views.
File
- handlers/
views_handler_relationship.inc, line 38 - Views' relationship handlers.
View source
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'])) {
// Set both real_field and field so custom handler
// can rely on the old field value.
$this->real_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();
// Relationships definitions should define a default label, but if they aren't get another default value.
if (!empty($this->definition['label'])) {
$label = $this->definition['label'];
}
else {
$label = !empty($this->definition['field']) ? $this->definition['field'] : $this->definition['base field'];
}
$options['label'] = array('default' => $label, 'translatable' => TRUE);
$options['required'] = array('default' => FALSE, 'bool' => TRUE);
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('Identifier'),
'#default_value' => isset($this->options['label']) ? $this->options['label'] : '',
'#description' => t('Edit the administrative label displayed when referencing this relationship from filters, etc.'),
'#required' => TRUE,
);
$form['required'] = array(
'#type' => 'checkbox',
'#title' => t('Require this relationship'),
'#description' => t('Enable to hide items that do not contain this relationship'),
'#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->real_field;
if (!empty($this->options['required'])) {
$def['type'] = 'INNER';
}
if (!empty($this->definition['extra'])) {
$def['extra'] = $this->definition['extra'];
}
if (!empty($def['join_handler']) && class_exists($def['join_handler'])) {
$join = new $def['join_handler'];
}
else {
$join = new views_join();
}
$join->definition = $def;
$join->options = $this->options;
$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);
// Add access tags if the base table provide it.
if (empty($this->query->options['disable_sql_rewrite']) && isset($table_data['table']['base']['access query tag'])) {
$access_tag = $table_data['table']['base']['access query tag'];
$this->query->add_tag($access_tag);
}
}
/**
* You can't groupby a relationship.
*/
function use_group_by() {
return FALSE;
}
}
Members
Name | Modifiers | Type | Description |
---|---|---|---|
views_handler_relationship:: |
function |
Init handler to let relationships live on tables other than
the table they operate on. Overrides views_handler:: |
|
views_handler_relationship:: |
function | Get this field's label. | |
views_handler_relationship:: |
function |
Information about options for all kinds of purposes will be held here.
@code
'option_name' => array( Overrides views_handler:: |
|
views_handler_relationship:: |
function |
Default options form that provides the label widget that all fields
should have. Overrides views_handler:: |
|
views_handler_relationship:: |
function | Called to implement a relationship in a query. | |
views_handler_relationship:: |
function |
You can't groupby a relationship. Overrides views_handler:: |
|
views_handler:: |
function | Return a string representing this handler's name in the UI. | |
views_handler:: |
function | Shortcut to get a handler's raw field value. | |
views_handler:: |
function | Sanitize the value for output. | |
views_handler:: |
function | Transform a string by a certain method. | |
views_handler:: |
function | Validate the options form. | |
views_handler:: |
function | Perform any necessary changes to the form values prior to storage. There is no need for this function to actually store the data. | |
views_handler:: |
function | Provide a form for aggregation settings. | |
views_handler:: |
function | Perform any necessary changes to the form values prior to storage. There is no need for this function to actually store the data. | |
views_handler:: |
function | If a handler has 'extra options' it will get a little settings widget and another form called extra_options. | |
views_handler:: |
function | Provide defaults for the handler. | |
views_handler:: |
function | Provide a form for setting options. | |
views_handler:: |
function | Validate the options form. | |
views_handler:: |
function | Perform any necessary changes to the form values prior to storage. There is no need for this function to actually store the data. | |
views_handler:: |
function | Determine if a handler can be exposed. | |
views_handler:: |
function | Set new exposed option defaults when exposed setting is flipped on. | |
views_handler:: |
function | Get information about the exposed form for the form renderer. | |
views_handler:: |
function | Render our chunk of the exposed handler form when selecting | |
views_handler:: |
function | Validate the exposed handler form | |
views_handler:: |
function | Submit the exposed handler form | |
views_handler:: |
function | Form for exposed handler options. | |
views_handler:: |
function | Validate the options form. | |
views_handler:: |
function | Perform any necessary changes to the form exposes prior to storage. There is no need for this function to actually store the data. | |
views_handler:: |
function | Shortcut to display the expose/hide button. | |
views_handler:: |
function | Shortcut to display the exposed options form. | |
views_handler:: |
function | Check whether current user has access to this handler. | |
views_handler:: |
function | Run before the view is built. | |
views_handler:: |
function | Run after the view is executed, before the result is cached. | |
views_handler:: |
function | Provides a unique placeholders for handlers. | |
views_handler:: |
function | Called just prior to query(), this lets a handler set up any relationship it needs. | |
views_handler:: |
function | Ensure the main table for this handler is in the query. This is used a lot. | |
views_handler:: |
function | Provide text for the administrative summary | |
views_handler:: |
function | Determine if the argument needs a style plugin. | |
views_handler:: |
function | Determine if this item is 'exposed', meaning it provides form elements to let users modify the view. | |
views_handler:: |
function | Returns TRUE if the exposed filter works like a grouped filter. | |
views_handler:: |
function | Define if the exposed input has to be submitted multiple times. This is TRUE when exposed filters grouped are using checkboxes as widgets. | |
views_handler:: |
function | Take input from exposed handlers and assign to this handler, if necessary. | |
views_handler:: |
function | If set to remember exposed input in the session, store it there. | |
views_handler:: |
function | Get the join object that should be used for this handler. | |
views_handler:: |
function | Validates the handler against the complete View. | |
views_handler:: |
function | Determine if the handler is considered 'broken', meaning it's a a placeholder used when a handler can't be found. | |
views_object:: |
function | Views handlers use a special construct function so that we can more easily construct them with variable arguments. | |
views_object:: |
function | Set default options on this object. Called by the constructor in a complex chain to deal with backward compatibility. | |
views_object:: |
function | Set default options. For backward compatibility, it sends the options array; this is a feature that will likely disappear at some point. | |
views_object:: |
function | ||
views_object:: |
function | Unpack options over our existing defaults, drilling down into arrays so that defaults don't get totally blown away. | |
views_object:: |
function | Let the handler know what its full definition is. | |
views_object:: |
function | ||
views_object:: |
function | ||
views_object:: |
function | ||
views_object:: |
function | Always exports the option, regardless of the default value. | |
views_object:: |
function | Unpacks each handler to store translatable texts. | |
views_object:: |
function | Unpack a single option definition. | |
views_handler:: |
public | property | The alias of the table of this handler which is used in the query. |