class views_handler_filter_chado_boolean
@file Purpose: This handler provides a TRUE/FALSE or YES/NO select for chado fields of type boolean (includes both 0/1 and t/f booleans)
Hierarchy
- class \views_object
- class \views_handler
Expanded class hierarchy of views_handler_filter_chado_boolean
Related topics
File
- tripal_views/
views/ handlers/ deprecated/ views_handler_filter_chado_boolean.inc, line 11 - Purpose: This handler provides a TRUE/FALSE or YES/NO select for chado fields of type boolean (includes both 0/1 and t/f booleans)
View source
class views_handler_filter_chado_boolean extends views_handler_filter_boolean_operator {
/**
* Checks if this field uses 0/1 or t/f
* @todo Implement LIMIT 1 functionality for tripal_core_chado_select().
*/
function init(&$view, $options) {
parent::init($view, $options);
$results = tripal_core_chado_select($this->table, array($this->field), array());
$this->boolean_type_tf = FALSE;
if (preg_match('/[tf]/', $results[0]->{$this->field})) {
$this->boolean_type_tf = TRUE;
}
}
/**
* This function sets the options array for the select.
* If we are using a t/f boolean then the options need to evaluate to either t or f
* Otherwise, (0/1 boolean) the options evaluate to 0 or 1
*/
function get_value_options() {
if ($this->boolean_type_tf) {
if (isset($this->definition['type'])) {
if ($this->definition['type'] == 'yes-no') {
$this->value_options = array('t' => t('Yes'), 'f' => t('No'));
}
if ($this->definition['type'] == 'on-off') {
$this->value_options = array('t' => t('On'), 'f' => t('Off'));
}
}
// Provide a fallback if the above didn't set anything.
if (!isset($this->value_options)) {
$this->value_options = array('t' => t('True'), 'f' => t('False'));
}
}
else { //end of t/f boolean
if (isset($this->definition['type'])) {
if ($this->definition['type'] == 'yes-no') {
$this->value_options = array(1 => t('Yes'), 0 => t('No'));
}
if ($this->definition['type'] == 'on-off') {
$this->value_options = array(1 => t('On'), 0 => t('Off'));
}
}
// Provide a fallback if the above didn't set anything.
if (!isset($this->value_options)) {
$this->value_options = array(1 => t('True'), 0 => t('False'));
}
} //end of 0/1 boolean
}
function query() {
$this->ensure_my_table();
$where = "$this->table_alias.$this->real_field ";
if ($this->boolean_type_tf) {
if (preg_match('/f/', $this->value)) {
$where .= "= 'f'";
}
else {
$where .= "= 't'";
}
$this->query->add_where($this->options['group'], $where);
}
else {
if (empty($this->value)) {
$where .= '= 0';
if ($this->accept_null) {
$where = '(' . $where . " OR $this->table_alias.$this->real_field IS NULL)";
}
}
else {
$where .= '<> 0';
}
$this->query->add_where($this->options['group'], $where);
}
}
}
Members
Name | Modifiers | Type | Description |
---|---|---|---|
views_handler:: |
function | Check whether current user has access to this handler. | |
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_handler:: |
function | Ensure the main table for this handler is in the query. This is used a lot. | |
views_handler:: |
function | Submit the exposed filter form | |
views_handler:: |
function | Validate the exposed filter form | |
views_handler:: |
function | Provide defaults for the handler. | |
views_handler:: |
function | Provide a form for setting options. | |
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 | Validate the options form. | |
views_handler:: |
function | Get the join object that should be used for this handler. | |
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 | Determine if this item is 'exposed', meaning it provides form elements to let users modify the view. | |
views_handler:: |
function | Determine if the argument needs a style plugin. | |
views_handler:: |
function | Run before the view is built. | |
views_handler:: |
function | Called just prior to query(), this lets a handler set up any relationship it needs. | |
views_handler:: |
function | Return a string representing this handler's name in the UI. | |
views_handler:: |
function | Validates the handler against the complete View. | |
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 |
Determine if a filter can be exposed. Overrides views_handler:: |
|
views_handler_filter:: |
function |
Render our chunk of the exposed filter form when selecting Overrides views_handler:: |
|
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 | Make some translations to a form item to make it more suitable to exposing. | |
views_handler_filter:: |
function | Overridable form for exposed filter options. | |
views_handler_filter:: |
function | Handle the 'left' side fo the exposed options form. | |
views_handler_filter:: |
function | Handle the 'right' side fo the exposed options form. | |
views_handler_filter:: |
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_filter:: |
function | Validate the options form. | |
views_handler_filter:: |
function | Provide a list of options for the default operator form. Should be overridden by classes that don't override 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 | Validate the operator form. | |
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 submit handler Overrides views_handler:: |
|
views_handler_filter:: |
function |
Simple validate handler Overrides views_handler:: |
|
views_handler_filter:: |
function | Shortcut to display the expose/hide button. | |
views_handler_filter:: |
function | Shortcut to display the exposed options form. | |
views_handler_filter:: |
function | Shortcut to display the operator form. | |
views_handler_filter:: |
function | Shortcut to display the value form. | |
views_handler_filter:: |
function |
If set to remember exposed input in the session, store it there. Overrides views_handler:: |
|
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_boolean_operator:: |
function |
Display the filter on the administrative summary Overrides views_handler_filter:: |
|
views_handler_filter_boolean_operator:: |
function |
Views handlers use a special construct function so that we can more
easily construct them with variable arguments. Overrides views_object:: |
|
views_handler_filter_boolean_operator:: |
function |
Provide default options for exposed filters. Overrides views_handler_filter:: |
|
views_handler_filter_boolean_operator:: |
function |
Provide a form for setting the operator. Overrides views_handler_filter:: |
|
views_handler_filter_boolean_operator:: |
function |
Information about options for all kinds of purposes will be held here. Overrides views_handler_filter:: |
|
views_handler_filter_boolean_operator:: |
function |
Provide a form for setting options. Overrides views_handler_filter:: |
|
views_handler_filter_boolean_operator:: |
function |
Validate the options form. Overrides views_handler_filter:: |
|
views_handler_filter_chado_boolean:: |
function |
This function sets the options array for the select.
If we are using a t/f boolean then the options need to evaluate to either t or f
Otherwise, (0/1 boolean) the options evaluate to 0 or 1 Overrides views_handler_filter_boolean_operator:: |
|
views_handler_filter_chado_boolean:: |
function |
Checks if this field uses 0/1 or t/f
@todo Implement LIMIT 1 functionality for tripal_core_chado_select(). Overrides views_handler_filter:: |
|
views_handler_filter_chado_boolean:: |
function |
Add this filter to the query. Overrides views_handler_filter_boolean_operator:: |
|
views_object:: |
function | ||
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 | Let the handler know what its full definition is. | |
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 |