class farm_asset_handler_relationship_entity_reverse in farmOS 7
A relationship handler for reverse entity references.
Hierarchy
- class \views_object
Expanded class hierarchy of farm_asset_handler_relationship_entity_reverse
1 string reference to 'farm_asset_handler_relationship_entity_reverse'
- farm_asset_views_data_alter in modules/
farm/ farm_asset/ farm_asset.views.inc - Implements hook_views_data_alter().
File
- modules/
farm/ farm_asset/ includes/ views/ handlers/ farm_asset_handler_relationship_entity_reverse.inc, line 13 - Definition of farm_asset_handler_relationship_entity_reverse.
View source
class farm_asset_handler_relationship_entity_reverse extends views_handler_relationship_entity_reverse {
function option_definition() {
$options = parent::option_definition();
// Add an option for limiting the join to non-archived assets.
$options['archived'] = array(
'default' => FALSE,
'bool' => TRUE,
);
return $options;
}
/**
* Default options form that provides the "archived" checkbox.
*/
function options_form(&$form, &$form_state) {
parent::options_form($form, $form_state);
$form['archived'] = array(
'#type' => 'checkbox',
'#title' => t('Archived assets'),
'#description' => t('Include archived assets.'),
'#default_value' => !empty($this->options['archived']),
);
}
/**
* Called to implement a relationship in a query.
*/
function query() {
// Execute the parent method first.
parent::query();
// Start the definition of a second join. This is copied directly from
// views_handler_relationship_entity_reverse.inc.
$second = array(
'left_table' => $this->first_alias,
'left_field' => 'entity_id',
'table' => $this->definition['base'],
'field' => $this->definition['base field'],
);
// If the "archived" option is not set, add an extra join condition that
// excludes archived assets from the join.
if (empty($this->options['archived'])) {
$second['extra'] = array(
0 => array(
'field' => 'archived',
'operator' => '=',
'value' => 0,
'numeric' => TRUE,
),
);
}
/**
* Everything below this comment is copied directly from
* views_handler_relationship_entity_reverse.inc.
*/
if (!empty($this->options['required'])) {
$second['type'] = 'INNER';
}
if (!empty($this->definition['join_handler']) && class_exists($this->definition['join_handler'])) {
$second_join = new $this->definition['join_handler']();
}
else {
$second_join = new views_join();
}
$second_join->definition = $second;
$second_join
->construct();
$second_join->adjusted = TRUE;
// use a short alias for this:
$alias = $this->definition['field_name'] . '_' . $this->table;
$this->alias = $this->query
->add_relationship($alias, $second_join, $this->definition['base'], $this->relationship);
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
farm_asset_handler_relationship_entity_reverse:: |
function |
Default options form that provides the "archived" checkbox. Overrides views_handler_relationship:: |
||
farm_asset_handler_relationship_entity_reverse:: |
function |
Information about options for all kinds of purposes will be held here. Overrides views_handler_relationship:: |
||
farm_asset_handler_relationship_entity_reverse:: |
function |
Called to implement a relationship in a query. Overrides views_handler_relationship_entity_reverse:: |
||
views_handler:: |
public | property | The type of the handler, for example filter/footer/field. | |
views_handler:: |
public | property | Where the $query object will reside:. | 1 |
views_handler:: |
public | property | The actual field in the database table, maybe different on other kind of query plugins/special handlers. | |
views_handler:: |
public | property | The relationship used for this field. | |
views_handler:: |
public | property | The alias of the table of this handler which is used in the query. | |
views_handler:: |
public | property |
The top object of a view. Overrides views_object:: |
|
views_handler:: |
public | function | Take input from exposed handlers and assign to this handler, if necessary. | 1 |
views_handler:: |
public | function | Check whether current user has access to this handler. | 10 |
views_handler:: |
public | function | Provide text for the administrative summary. | 4 |
views_handler:: |
public | function | Determine if the handler is considered 'broken'. | 6 |
views_handler:: |
public | function | Determine if a handler can be exposed. | 2 |
views_handler:: |
public | function | Transform a string by a certain method. | |
views_handler:: |
public | function | Ensure the main table for this handler is in the query. This is used a lot. | 8 |
views_handler:: |
public | function | Render our chunk of the exposed handler form when selecting. | 1 |
views_handler:: |
public | function | Get information about the exposed form for the form renderer. | 1 |
views_handler:: |
public | function | Submit the exposed handler form. | |
views_handler:: |
public | function | Validate the exposed handler form. | 4 |
views_handler:: |
public | function | Form for exposed handler options. | 2 |
views_handler:: |
public | function | Set new exposed option defaults when exposed setting is flipped on. | 2 |
views_handler:: |
public | 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:: |
public | function | Validate the options form. | 1 |
views_handler:: |
public | function | Provide defaults for the handler. | |
views_handler:: |
public | function | Provide a form for setting options. | 1 |
views_handler:: |
public | 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:: |
public | function | Validate the options form. | |
views_handler:: |
public | function | Shortcut to get a handler's raw field value. | |
views_handler:: |
public | function | Get the join object that should be used for this handler. | |
views_handler:: |
public | function | Provide a form for aggregation settings. | 1 |
views_handler:: |
public | function | Perform any necessary changes to the form values prior to storage. There is no need for this function to actually store the data. | 1 |
views_handler:: |
public | function | If a handler has 'extra options' it will get a little settings widget and another form called extra_options. | 1 |
views_handler:: |
public | function | Returns TRUE if the exposed filter works like a grouped filter. | 1 |
views_handler:: |
public | function | Determine if this item is 'exposed', meaning it provides form elements to let users modify the view. | |
views_handler:: |
public | function | Define if the exposed input has to be submitted multiple times. This is TRUE when exposed filters grouped are using checkboxes as widgets. | 1 |
views_handler:: |
public | function | Determine if the argument needs a style plugin. | 1 |
views_handler:: |
public | function | Perform any necessary changes to the form values prior to storage. There is no need for this function to actually store the data. | 5 |
views_handler:: |
public | function | Validate the options form. | 4 |
views_handler:: |
public | function | Provides a unique placeholders for handlers. | |
views_handler:: |
public | function | Run after the view is executed, before the result is cached. | 1 |
views_handler:: |
public | function | Run before the view is built. | 1 |
views_handler:: |
public | function | Sanitize the value for output. | |
views_handler:: |
public | function | Called just prior to query(), this lets a handler set up any relationship it needs. | |
views_handler:: |
public | function | Shortcut to display the expose/hide button. | 2 |
views_handler:: |
public | function | Shortcut to display the exposed options form. | |
views_handler:: |
public | function | If set to remember exposed input in the session, store it there. | 1 |
views_handler:: |
public | function | Return a string representing this handler's name in the UI. | 9 |
views_handler:: |
public | function | Validates the handler against the complete View. | 1 |
views_handler_relationship:: |
public | function | Get this field's label. | |
views_handler_relationship:: |
public | function |
You can't groupby a relationship. Overrides views_handler:: |
|
views_handler_relationship_entity_reverse:: |
public | function |
Let relationships live on tables other than the table they operate on. Overrides views_handler_relationship:: |
|
views_object:: |
public | property | Handler's definition. | |
views_object:: |
public | property | Except for displays, options for the object will be held here. | 1 |
views_object:: |
function | Collect this handler's option definition and alter them, ready for use. | ||
views_object:: |
public | function | Views handlers use a special construct function. | 4 |
views_object:: |
public | function | Destructor. | 2 |
views_object:: |
public | function | 1 | |
views_object:: |
public | function | ||
views_object:: |
public | function | Always exports the option, regardless of the default value. | |
views_object:: |
public | function | Set default options on this object. | 1 |
views_object:: |
public | function | Set default options. | |
views_object:: |
public | function | Let the handler know what its full definition is. | |
views_object:: |
public | function | Unpack options over our existing defaults, drilling down into arrays so that defaults don't get totally blown away. | |
views_object:: |
public | function | Unpack a single option definition. | |
views_object:: |
public | function | Unpacks each handler to store translatable texts. | |
views_object:: |
public | function |