class views_handler_filter_boolean_operator
Same name in other branches
- 6.x-3.x handlers/views_handler_filter_boolean_operator.inc \views_handler_filter_boolean_operator
Simple filter to handle matching of boolean values.
Definition items:
- label: (REQUIRED) The label for the checkbox.
- type: For basic 'true false' types, an item can specify the following:
- true-false: True/false (this is the default)
- yes-no: Yes/No
- on-off: On/Off
- enabled-disabled: Enabled/Disabled
- accept null: Treat a NULL value as false.
- use equal: If you use this flag the query will use = 1 instead of <> 0. This might be helpful for performance reasons.
Hierarchy
- class \views_object
- class \views_handler extends \views_object
- class \views_handler_filter extends \views_handler
- class \views_handler_filter_boolean_operator extends \views_handler_filter
- class \views_handler_filter extends \views_handler
- class \views_handler extends \views_object
Expanded class hierarchy of views_handler_filter_boolean_operator
Related topics
9 string references to 'views_handler_filter_boolean_operator'
- comment_views_data in modules/
comment.views.inc - Implements hook_views_data().
- hook_views_data in ./
views.api.php - Describes data tables (or the equivalent) to Views.
- locale_views_data in modules/
locale.views.inc - Implements hook_views_data().
- node_views_data in modules/
node.views.inc - Implements hook_views_data().
- poll_views_data in modules/
poll.views.inc - Implements hook_views_data().
File
-
handlers/
views_handler_filter_boolean_operator.inc, line 24
View source
class views_handler_filter_boolean_operator extends views_handler_filter {
/**
* Exposed filter options.
*/
public $always_multiple = TRUE;
/**
* Don't display empty space where the operator would be.
*/
public $no_operator = TRUE;
/**
* Whether to accept NULL as a false value or not.
*/
public $accept_null = FALSE;
/**
* {@inheritdoc}
*/
public function construct() {
$this->value_value = t('True');
if (isset($this->definition['label'])) {
$this->value_value = $this->definition['label'];
}
if (isset($this->definition['accept null'])) {
$this->accept_null = (bool) $this->definition['accept null'];
}
elseif (isset($this->definition['accept_null'])) {
$this->accept_null = (bool) $this->definition['accept_null'];
}
$this->value_options = NULL;
parent::construct();
}
/**
* Return the possible options for this filter.
*
* Child classes should override this function to set the possible values
* for the filter. Since this is a boolean filter, the array should have
* two possible keys: 1 for "True" and 0 for "False", although the labels
* can be whatever makes sense for the filter. These values are used for
* configuring the filter, when the filter is exposed, and in the admin
* summary of the filter. Normally, this should be static data, but if it's
* dynamic for some reason, child classes should use a guard to reduce
* database hits as much as possible.
*/
public function get_value_options() {
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'),
);
}
if ($this->definition['type'] == 'enabled-disabled') {
$this->value_options = array(
1 => t('Enabled'),
0 => t('Disabled'),
);
}
}
// 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'),
);
}
}
/**
* {@inheritdoc}
*/
public function option_definition() {
$options = parent::option_definition();
$options['value']['default'] = FALSE;
return $options;
}
/**
* {@inheritdoc}
*/
public function operator_form(&$form, &$form_state) {
$form['operator'] = array();
}
/**
* {@inheritdoc}
*/
public function value_form(&$form, &$form_state) {
if (empty($this->value_options)) {
// Initialize the array of possible values for this filter.
$this->get_value_options();
}
if (!empty($form_state['exposed'])) {
// Exposed filter: use a select box to save space.
$filter_form_type = 'select';
}
else {
// Configuring a filter: use radios for clarity.
$filter_form_type = 'radios';
}
$form['value'] = array(
'#type' => $filter_form_type,
'#title' => $this->value_value,
'#options' => $this->value_options,
'#default_value' => $this->value,
);
if (!empty($this->options['exposed'])) {
$identifier = $this->options['expose']['identifier'];
if (!empty($form_state['exposed']) && !isset($form_state['input'][$identifier])) {
$form_state['input'][$identifier] = $this->value;
}
// If we're configuring an exposed filter, add an <Any> option.
if (empty($form_state['exposed']) || empty($this->options['expose']['required'])) {
$any_label = variable_get('views_exposed_filter_any_label', 'new_any') == 'old_any' ? '<Any>' : t('- Any -');
if ($form['value']['#type'] != 'select') {
$any_label = check_plain($any_label);
}
$form['value']['#options'] = array(
'All' => $any_label,
) + $form['value']['#options'];
}
}
}
/**
* {@inheritdoc}
*/
public function value_validate($form, &$form_state) {
if ($form_state['values']['options']['value'] == 'All' && !empty($form_state['values']['options']['expose']['required'])) {
form_set_error('value', t('You must select a value unless this is an non-required exposed filter.'));
}
}
/**
* {@inheritdoc}
*/
public function admin_summary() {
if ($this->is_a_group()) {
return t('grouped');
}
if (!empty($this->options['exposed'])) {
return t('exposed');
}
if (empty($this->value_options)) {
$this->get_value_options();
}
// Now that we have the valid options for this filter, just return the
// human-readable label based on the current value. The value_options
// array is keyed with either 0 or 1, so if the current value is not
// empty, use the label for 1, and if it's empty, use the label for 0.
return $this->value_options[!empty($this->value)];
}
/**
* {@inheritdoc}
*/
public function expose_options() {
parent::expose_options();
$this->options['expose']['operator_id'] = '';
$this->options['expose']['label'] = $this->value_value;
$this->options['expose']['required'] = TRUE;
}
/**
* {@inheritdoc}
*/
public function query() {
$this->ensure_my_table();
$field = "{$this->table_alias}.{$this->real_field}";
if (empty($this->value)) {
if ($this->accept_null) {
$or = db_or()->condition($field, 0, '=')
->condition($field, NULL, 'IS NULL');
$this->query
->add_where($this->options['group'], $or);
}
else {
$this->query
->add_where($this->options['group'], $field, 0, '=');
}
}
else {
if (!empty($this->definition['use equal'])) {
$this->query
->add_where($this->options['group'], $field, 1, '=');
}
else {
$this->query
->add_where($this->options['group'], $field, 0, '<>');
}
}
}
}
Members
Title Sort descending | Deprecated | Modifiers | Object type | Summary | Overriden Title | Overrides |
---|---|---|---|---|---|---|
views_handler::$handler_type | public | property | The type of the handler, for example filter/footer/field. | |||
views_handler::$query | public | property | Where the $query object will reside:. | 1 | ||
views_handler::$real_field | public | property | The actual field in the database table, maybe different on other kind of query plugins/special handlers. |
|||
views_handler::$relationship | public | property | The relationship used for this field. | |||
views_handler::$table_alias | public | property | The alias of the table of this handler which is used in the query. | |||
views_handler::$view | public | property | The top object of a view. | Overrides views_object::$view | ||
views_handler::access | public | function | Check whether current user has access to this handler. | 10 | ||
views_handler::broken | public | function | Determine if the handler is considered 'broken'. | 6 | ||
views_handler::case_transform | public | function | Transform a string by a certain method. | |||
views_handler::ensure_my_table | public | function | Ensure the main table for this handler is in the query. This is used a lot. |
8 | ||
views_handler::exposed_submit | public | function | Submit the exposed handler form. | |||
views_handler::exposed_validate | public | function | Validate the exposed handler form. | 4 | ||
views_handler::expose_submit | 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::extra_options | public | function | Provide defaults for the handler. | |||
views_handler::extra_options_form | public | function | Provide a form for setting options. | 1 | ||
views_handler::extra_options_submit | 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::extra_options_validate | public | function | Validate the options form. | |||
views_handler::get_field | public | function | Shortcut to get a handler's raw field value. | |||
views_handler::get_join | public | function | Get the join object that should be used for this handler. | |||
views_handler::groupby_form | public | function | Provide a form for aggregation settings. | 1 | ||
views_handler::groupby_form_submit | 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::has_extra_options | public | function | If a handler has 'extra options' it will get a little settings widget and another form called extra_options. |
1 | ||
views_handler::is_exposed | public | function | Determine if this item is 'exposed', meaning it provides form elements to let users modify the view. |
|||
views_handler::needs_style_plugin | public | function | Determine if the argument needs a style plugin. | 1 | ||
views_handler::placeholder | public | function | Provides a unique placeholders for handlers. | |||
views_handler::post_execute | public | function | Run after the view is executed, before the result is cached. | 1 | ||
views_handler::pre_query | public | function | Run before the view is built. | 1 | ||
views_handler::sanitize_value | public | function | Sanitize the value for output. | |||
views_handler::set_relationship | public | function | Called just prior to query(), this lets a handler set up any relationship it needs. |
|||
views_handler::show_expose_form | public | function | Shortcut to display the exposed options form. | |||
views_handler::ui_name | public | function | Return a string representing this handler's name in the UI. | 9 | ||
views_handler::use_group_by | public | function | Provides the handler some groupby. | 2 | ||
views_handler::validate | public | function | Validates the handler against the complete View. | 1 | ||
views_handler_filter::$always_required | public | property | Disable the possibility to allow a exposed input to be optional. | |||
views_handler_filter::$group_info | public | property | Contains the information of the selected item in a gruped filter. | |||
views_handler_filter::$operator | public | property | Contains the operator which is used on the query. | |||
views_handler_filter::$value | public | property | Contains the actual value of the field. | |||
views_handler_filter::accept_exposed_input | public | function | Check to see if input from the exposed filters should change the behavior. | Overrides views_handler::accept_exposed_input | 2 | |
views_handler_filter::build_group_form | public | function | Build the form to let users create the group of exposed filters. | |||
views_handler_filter::build_group_options | public | function | Provide default options for exposed filters. | |||
views_handler_filter::build_group_submit | public | function | Save new group items, re-enumerates and remove groups marked to delete. | |||
views_handler_filter::build_group_validate | public | function | Validate the build group options form. | 1 | ||
views_handler_filter::can_build_group | public | function | Determine if a filter can be converted into a group. | |||
views_handler_filter::can_expose | public | function | Determine if a filter can be exposed. | Overrides views_handler::can_expose | 5 | |
views_handler_filter::can_group | public | function | Can this filter be used in OR groups? | 1 | ||
views_handler_filter::convert_exposed_input | public | function | Transform the input from a grouped filter into a standard filter. | |||
views_handler_filter::exposed_form | public | function | Render our chunk of the exposed filter form when selecting. | Overrides views_handler::exposed_form | ||
views_handler_filter::exposed_info | public | function | Tell the renderer about our exposed form. | Overrides views_handler::exposed_info | ||
views_handler_filter::exposed_translate | public | function | Make some translations to a form item to make it more suitable to exposing. | |||
views_handler_filter::expose_form | public | function | Options form subform for exposed filter options. | Overrides views_handler::expose_form | 2 | |
views_handler_filter::expose_validate | public | function | Validate the options form. | Overrides views_handler::expose_validate | ||
views_handler_filter::group_form | public | function | Build a form with a group of operator | values to apply as a single filter. | |||
views_handler_filter::group_multiple_exposed_input | public | function | Options available for a grouped filter which uses checkboxes. | |||
views_handler_filter::init | public | function | Provide some extra help to get the operator/value easier to use. | Overrides views_handler::init | 2 | |
views_handler_filter::is_a_group | public | function | Returns TRUE if the exposed filter works like a grouped filter. | Overrides views_handler::is_a_group | ||
views_handler_filter::multiple_exposed_input | public | function | Indicate whether users can select multiple group items. | Overrides views_handler::multiple_exposed_input | ||
views_handler_filter::operator_options | public | function | Provide a list of options for the default operator form. | 4 | ||
views_handler_filter::operator_submit | public | function | Perform any necessary changes to the form values prior to storage. | |||
views_handler_filter::operator_validate | public | function | Validate the operator form. | |||
views_handler_filter::options_form | public | function | Provide the basic form which calls through to subforms. | Overrides views_handler::options_form | 4 | |
views_handler_filter::options_submit | public | function | Simple submit handler. | Overrides views_handler::options_submit | ||
views_handler_filter::options_validate | public | function | Simple validate handler. | Overrides views_handler::options_validate | 1 | |
views_handler_filter::prepare_filter_select_options | public | function | Sanitizes the HTML select element's options. | |||
views_handler_filter::show_build_group_button | public | function | Shortcut to display the build_group/hide button. | |||
views_handler_filter::show_build_group_form | public | function | Shortcut to display the exposed options form. | |||
views_handler_filter::show_expose_button | public | function | Shortcut to display the expose/hide button. | Overrides views_handler::show_expose_button | ||
views_handler_filter::show_operator_form | public | function | Shortcut to display the operator form. | |||
views_handler_filter::show_value_form | public | function | Shortcut to display the value form. | |||
views_handler_filter::store_exposed_input | public | function | Store the exposed input for processing later. | Overrides views_handler::store_exposed_input | ||
views_handler_filter::store_group_input | public | function | If set to remember exposed input in the session, store it there. | |||
views_handler_filter::value_submit | public | function | Perform any necessary changes to the form values prior to storage. | 1 | ||
views_handler_filter_boolean_operator::$accept_null | public | property | Whether to accept NULL as a false value or not. | |||
views_handler_filter_boolean_operator::$always_multiple | public | property | Exposed filter options. | Overrides views_handler_filter::$always_multiple | ||
views_handler_filter_boolean_operator::$no_operator | public | property | Don't display empty space where the operator would be. | Overrides views_handler_filter::$no_operator | ||
views_handler_filter_boolean_operator::admin_summary | public | function | Display the filter on the administrative summary. | Overrides views_handler_filter::admin_summary | ||
views_handler_filter_boolean_operator::construct | public | function | Views handlers use a special construct function. | Overrides views_object::construct | 1 | |
views_handler_filter_boolean_operator::expose_options | public | function | Provide default options for exposed filters. | Overrides views_handler_filter::expose_options | ||
views_handler_filter_boolean_operator::get_value_options | public | function | Return the possible options for this filter. | |||
views_handler_filter_boolean_operator::operator_form | public | function | Options form subform for setting the operator. | Overrides views_handler_filter::operator_form | ||
views_handler_filter_boolean_operator::option_definition | public | function | Information about options for all kinds of purposes will be held here. | Overrides views_handler_filter::option_definition | ||
views_handler_filter_boolean_operator::query | public | function | Add this filter to the query. | Overrides views_handler_filter::query | 3 | |
views_handler_filter_boolean_operator::value_form | public | function | Options form subform for setting options. | Overrides views_handler_filter::value_form | ||
views_handler_filter_boolean_operator::value_validate | public | function | Validate the options form. | Overrides views_handler_filter::value_validate | ||
views_object::$definition | public | property | Handler's definition. | |||
views_object::$options | public | property | Except for displays, options for the object will be held here. | 1 | ||
views_object::altered_option_definition | public | function | Collect this handler's option definition and alter them, ready for use. | |||
views_object::destroy | public | function | Destructor. | 2 | ||
views_object::export_option | public | function | 1 | |||
views_object::export_options | public | function | ||||
views_object::export_option_always | public | function | Always exports the option, regardless of the default value. | |||
views_object::options | Deprecated | public | function | Set default options on this object. | 1 | |
views_object::set_default_options | public | function | Set default options. | |||
views_object::set_definition | public | function | Let the handler know what its full definition is. | |||
views_object::unpack_options | public | function | Unpack options over our existing defaults, drilling down into arrays so that defaults don't get totally blown away. |
|||
views_object::unpack_translatable | public | function | Unpack a single option definition. | |||
views_object::unpack_translatables | public | function | Unpacks each handler to store translatable texts. | |||
views_object::_set_option_defaults | public | function |