class tripal_views_handler_filter_select_id
- 2.x tripal_views/views/handlers/tripal_views_handler_filter_select_id.inc tripal_views_handler_filter_select_id
- 3.x tripal_chado_views/views/handlers/tripal_views_handler_filter_select_id.inc tripal_views_handler_filter_select_id
This Handler provides a select list for the type field
NOTE: This handler only works when applied to the type_id field in the base_table of this view.
Hierarchy
- class \views_object
- class \views_handler
Expanded class hierarchy of tripal_views_handler_filter_select_id
Related topics
File
- tripal_views/
views/ handlers/ tripal_views_handler_filter_select_id.inc, line 15 - Contains tripal_views_handler_filter_select_string
View source
class tripal_views_handler_filter_select_id extends tripal_views_handler_filter_select_string {
/**
* {@inheritdoc}
*/
function init(&$view, &$options) {
parent::init($view, $options);
if (preg_match('/(\w+)_id/', $this->field, $matches)) {
$this->parent_table = $matches[1];
}
}
/**
* Provide the options used in the select list.
* Override this function in extended handlers to easily change option list.
*
* @return
* An array of options where the key is the value of this field in the database
*/
function get_select_options() {
// @TODO: Make name field configurable.
$name_field = 'common_name';
// First check that this table has a name field.
$table_desc = chado_get_schema($this->parent_table);
if (!isset($table_desc['fields'][$name_field])) {
return array();
}
// If the "Show All" options is set then show all the "names" from
// the table referenced by the foreign key constraint.
if (isset($this->options['show_all']) AND $this->options['show_all'] == TRUE) {
// We still want to use any hidden fitlers on the parent table
// but the arguments will need to be field names rather than
// generic placeholders so we need to tell get_select_option_where() that.
$return = $this->get_select_option_where($this->parent_table, FALSE);
$args = $return['arguments'];
// Simply grab all the values from the table referenced by
// the foreign key constraint. Since we use the id as the key of
// the options there is no need to use DISTRINCT in the query.
$resource = chado_select_record($this->parent_table, array($this->field, $name_field), $args);
$options = array();
foreach ($resource as $r) {
$options[$r->{$this->field}] = $r->{$name_field};
}
}
// Otherwise, only show those that are actually used in the base table.
else {
$return = $this->get_select_option_where($this->parent_table);
$where_clauses = $return['where_clauses'];
$arguments = $return['arguments'];
$where = '';
if (!empty($where_clauses)) {
$where = implode(' AND ', $where_clauses);
}
// Using a "Loose Index Scan" to get a list of all the unique values for
// the name in the table referenced by the foreign key constraint.
// See https://wiki.postgresql.org/wiki/Loose_indexscan
$sql = "WITH RECURSIVE t AS (
SELECT MIN(filter_table.!id_field) AS col
FROM {!filter_table} filter_table
LEFT JOIN {!foreign_table} foreign_table ON filter_table.!id_field=foreign_table.!id_field
" . ($where == '' ? '' : "WHERE " . $where) . "
UNION ALL
SELECT (
SELECT MIN(filter_table.!id_field)
FROM {!filter_table} filter_table
LEFT JOIN {!foreign_table} foreign_table ON filter_table.!id_field=foreign_table.!id_field
WHERE filter_table.!id_field > col " . ($where == '' ? '' : " AND " . $where) . "
)
FROM t WHERE col IS NOT NULL
)
SELECT !id_field as id, !name_field as name
FROM {!foreign_table}
WHERE !id_field IN (SELECT col FROM t where col IS NOT NULL)
ORDER BY !name_field ASC";
$sql = format_string($sql, array(
'!filter_table' => $this->table,
'!foreign_table' => $this->parent_table,
'!id_field' => $this->field,
'!name_field' => $name_field
));
$resource = chado_query($sql, $arguments);
$options = array();
if ($this->options['select_optional']) {
$options['All'] = '- Any -';
}
foreach ($resource as $r) {
$options[$r->id] = $r->name;
}
}
return $options;
}
/**
* For the SQL generating the options, determine the WHERE clauses
*
* @return
* An array of full qualified where clauses (ie: table.myfield = 'fred')
*/
function get_select_option_where($table = NULL, $generic_placeholder = TRUE) {
return parent::get_select_option_where($table, $generic_placeholder);
}
/**
* {@inheritdoc}
*/
function option_definition() {
return parent::option_definition();
}
/**
* {@inheritdoc}
*/
function expose_form(&$form, &$form_state) {
parent::expose_form($form, $form_state);
return $form;
}
/**
* {@inheritdoc}
*/
function expose_submit($form, &$form_state) {
parent::expose_submit($form, $form_state);
}
/**
* {@inheritdoc}
*/
function expose_options() {
parent::expose_options();
}
/**
* {@inheritdoc}
*/
function value_form(&$form, &$form_state) {
parent::value_form($form, $form_state);
}
}
Members
Name | Modifiers | Type | Description |
---|---|---|---|
tripal_views_handler_filter_select_id:: |
function |
Provide some extra help to get the operator/value easier to use. Overrides tripal_views_handler_filter_select_string:: |
|
tripal_views_handler_filter_select_id:: |
function |
Provide the options used in the select list.
Override this function in extended handlers to easily change option list. Overrides tripal_views_handler_filter_select_string:: |
|
tripal_views_handler_filter_select_id:: |
function |
For the SQL generating the options, determine the WHERE clauses Overrides tripal_views_handler_filter_select_string:: |
|
tripal_views_handler_filter_select_id:: |
function |
Information about options for all kinds of purposes will be held here.
@code
'option_name' => array( Overrides tripal_views_handler_filter_select_string:: |
|
tripal_views_handler_filter_select_id:: |
function |
Options form subform for exposed filter options. Overrides views_handler_filter:: |
|
tripal_views_handler_filter_select_id:: |
function |
Perform any necessary changes to the form exposes prior to storage.
There is no need for this function to actually store the data. Overrides views_handler:: |
|
tripal_views_handler_filter_select_id:: |
function |
Provide default options for exposed filters. Overrides views_handler_filter:: |
|
tripal_views_handler_filter_select_id:: |
function |
Provide a simple textfield for equality Overrides tripal_views_handler_filter_select_string:: |
|
tripal_views_handler_filter_select_string:: |
function |
Render our chunk of the exposed filter form when selecting Overrides views_handler_filter:: |
|
tripal_views_handler_filter_select_string:: |
function |
Add this filter to the query. Overrides views_handler_filter_string:: |
|
tripal_views_handler_filter_select_string:: |
function |
If a handler has 'extra options' it will get a little settings widget and
another form called extra_options. Overrides views_handler:: |
|
tripal_views_handler_filter_select_string:: |
function |
Provide a form for setting options. Overrides views_handler:: |
|
tripal_views_handler_filter_select_string:: |
function |
Perform any necessary changes to the form values prior to storage.
There is no need for this function to actually store the data. Overrides views_handler:: |
|
tripal_views_handler_filter_select_string:: |
function | ||
views_handler_filter_string:: |
function | This kind of construct makes it relatively easy for a child class to add or remove functionality by overriding this function and adding/removing items from this array. | |
views_handler_filter_string:: |
function |
Build strings from the operators() for 'select' options Overrides views_handler_filter:: |
|
views_handler_filter_string:: |
function |
Display the filter on the administrative summary Overrides views_handler_filter:: |
|
views_handler_filter_string:: |
function | ||
views_handler_filter_string:: |
function | ||
views_handler_filter_string:: |
function | ||
views_handler_filter_string:: |
function | ||
views_handler_filter_string:: |
function | ||
views_handler_filter_string:: |
function | ||
views_handler_filter_string:: |
function | ||
views_handler_filter_string:: |
function | ||
views_handler_filter_string:: |
function | ||
views_handler_filter_string:: |
function | ||
views_handler_filter_string:: |
function | ||
views_handler_filter_string:: |
function | ||
views_handler_filter_string:: |
function | ||
views_handler_filter_string:: |
function | ||
views_handler_filter:: |
function |
Determine if a filter can be exposed. Overrides views_handler:: |
|
views_handler_filter:: |
function | Determine if a filter can be converted into a group. Only exposed filters with operators available can be converted into groups. | |
views_handler_filter:: |
function |
Returns TRUE if the exposed filter works like a grouped filter. Overrides views_handler:: |
|
views_handler_filter:: |
function |
Provide the basic form which calls through to subforms.
If overridden, it is best to call through to the parent,
or to at least make sure all of the functions in this form
are called. Overrides views_handler:: |
|
views_handler_filter:: |
function |
Simple validate handler Overrides views_handler:: |
|
views_handler_filter:: |
function |
Simple submit handler Overrides views_handler:: |
|
views_handler_filter:: |
function | Shortcut to display the operator form. | |
views_handler_filter:: |
function | Options form subform for setting the operator. | |
views_handler_filter:: |
function | Validate the operator form. | |
views_handler_filter:: |
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_filter:: |
function | Shortcut to display the value form. | |
views_handler_filter:: |
function | Validate the options form. | |
views_handler_filter:: |
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_filter:: |
function | Shortcut to display the exposed options form. | |
views_handler_filter:: |
function | Shortcut to display the build_group/hide button. | |
views_handler_filter:: |
function |
Shortcut to display the expose/hide button. Overrides views_handler:: |
|
views_handler_filter:: |
function |
Validate the options form. Overrides views_handler:: |
|
views_handler_filter:: |
function | Validate the build group options form. | |
views_handler_filter:: |
function | Save new group items, re-enumerates and remove groups marked to delete. | |
views_handler_filter:: |
function | Provide default options for exposed filters. | |
views_handler_filter:: |
function | Build a form containing a group of operator | values to apply as a single filter. | |
views_handler_filter:: |
function | Build the form to let users create the group of exposed filters. This form is displayed when users click on button 'Build group' | |
views_handler_filter:: |
function | Make some translations to a form item to make it more suitable to exposing. | |
views_handler_filter:: |
function | Sanitizes the HTML select element's options. | |
views_handler_filter:: |
function |
Tell the renderer about our exposed form. This only needs to be
overridden for particularly complex forms. And maybe not even then. Overrides views_handler:: |
|
views_handler_filter:: |
function | ||
views_handler_filter:: |
function | Returns the options available for a grouped filter that users checkboxes as widget, and therefore has to be applied several times, one per item selected. | |
views_handler_filter:: |
function |
Returns TRUE if users can select multiple groups items of a
grouped exposed filter. Overrides views_handler:: |
|
views_handler_filter:: |
function | If set to remember exposed input in the session, store it there. This function is similar to store_exposed_input but modified to work properly when the filter is a group. | |
views_handler_filter:: |
function |
Check to see if input from the exposed filters should change
the behavior of this filter. Overrides views_handler:: |
|
views_handler_filter:: |
function |
If set to remember exposed input in the session, store it there. Overrides views_handler:: |
|
views_handler_filter:: |
function | Can this filter be used in OR groups? | |
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 | Provides the handler some groupby. | |
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 | Provide defaults for the handler. | |
views_handler:: |
function | Validate the options form. | |
views_handler:: |
function | Validate the exposed handler form | |
views_handler:: |
function | Submit the exposed handler form | |
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 | 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 | 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. |