class paragraphs_handler_relationship in Paragraphs 7
Provide relationship handler for paragraphs fields.
Hierarchy
- class \views_object
- class \views_handler
Expanded class hierarchy of paragraphs_handler_relationship
1 string reference to 'paragraphs_handler_relationship'
- paragraphs_field_views_data in views/
paragraphs.views.inc - Implements hook_field_views_data().
File
- views/
paragraphs_handler_relationship.inc, line 6
View source
class paragraphs_handler_relationship extends views_handler_relationship {
/**
* Returns extra option definitions for the form.
*
* @return array
* An array of option definitions.
*/
public function option_definition() {
$options = parent::option_definition();
$options['delta'] = array(
'default' => -1,
);
return $options;
}
/**
* Add a delta selector for multiple fields.
*
* @param $form
* The form structure array.
* @param $form_state
* An associative array containing the current state of the form.
*/
public function options_form(&$form, &$form_state) {
parent::options_form($form, $form_state);
$field = field_info_field($this->definition['field_name']);
// Only add the delta selector if the field is multiple.
if ($field['cardinality']) {
$max_delta = $field['cardinality'] == FIELD_CARDINALITY_UNLIMITED ? 10 : $field['cardinality'];
$options = array(
'-1' => t('All'),
);
for ($i = 0; $i < $max_delta; $i++) {
$options[$i] = $i + 1;
}
$form['delta'] = array(
'#type' => 'select',
'#options' => $options,
'#default_value' => $this->options['delta'],
'#title' => t('Delta'),
'#description' => t('The delta allows you to select which item in a multiple value field to key the relationship off of. Select "1" to use the first item, "2" for the second item, and so on. If you select "All", each item in the field will create a new row, which may appear to cause duplicates.'),
);
}
}
/**
* Makes sure our table is added to the join.
*
* @return mixed
* The alias of the table of this handler which is used in the query.
*/
public function ensure_my_table() {
$field = field_info_field($this->definition['field_name']);
if (!isset($this->table_alias)) {
$join = $this
->get_join();
if ($this->options['delta'] != -1 && $field['cardinality']) {
$join->extra[] = array(
'field' => 'delta',
'value' => $this->options['delta'],
'numeric' => TRUE,
);
}
$this->table_alias = $this->query
->add_table($this->table, $this->relationship, $join);
}
return $this->table_alias;
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
paragraphs_handler_relationship:: |
public | function |
Makes sure our table is added to the join. Overrides views_handler:: |
|
paragraphs_handler_relationship:: |
public | function |
Add a delta selector for multiple fields. Overrides views_handler_relationship:: |
|
paragraphs_handler_relationship:: |
public | function |
Returns extra option definitions for the form. Overrides views_handler_relationship:: |
|
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 | 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 |
Let relationships live on tables other than the table they operate on. Overrides views_handler:: |
2 |
views_handler_relationship:: |
public | function | Get this field's label. | |
views_handler_relationship:: |
public | function | Called to implement a relationship in a query. | 5 |
views_handler_relationship:: |
public | function |
You can't groupby a relationship. Overrides views_handler:: |
|
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 |