class location_handler_filter_location_province in Location 7.4
Same name and namespace in other branches
- 6.3 handlers/location_handler_filter_location_province.inc \location_handler_filter_location_province
- 7.5 handlers/location_handler_filter_location_province.inc \location_handler_filter_location_province
- 7.3 handlers/location_handler_filter_location_province.inc \location_handler_filter_location_province
Filter on province.
Hierarchy
- class \views_object
- class \views_handler
Expanded class hierarchy of location_handler_filter_location_province
1 string reference to 'location_handler_filter_location_province'
- location_views_data in ./
location.views.inc - Implementation of hook_views_data().
File
- handlers/
location_handler_filter_location_province.inc, line 6
View source
class location_handler_filter_location_province extends views_handler_filter {
var $location_country = FALSE;
var $location_country_identifier = FALSE;
function option_definition() {
$options = parent::option_definition();
$options['operator'] = array(
'default' => 'is',
);
return $options;
}
function admin_summary() {
return '';
// $options = $this->operator_options('short');
// return (!empty($this->options['exposed']) ? t('exposed') : $options[$this->operator]);
}
/**
* Provide a simple textfield for equality
*/
function value_form(&$form, &$form_state) {
$country = $this
->grovel_country();
drupal_add_js(drupal_get_path('module', 'location') . '/location_autocomplete.js');
$ac = $country;
if (is_array($ac)) {
$ac = implode(',', $ac);
}
$form['value'] = array(
'#type' => 'textfield',
'#title' => t('State/Province'),
'#autocomplete_path' => 'location/autocomplete/' . $ac,
'#default_value' => $this->value,
'#size' => 64,
'#maxlength' => 64,
// Used by province autocompletion js.
'#attributes' => array(
'class' => array(
'location_auto_province',
),
),
'#multiple' => TRUE,
);
// Let location_autocomplete.js find the correct fields to attach.
if ($this->location_country_identifier) {
$form['value']['#attributes']['class'][] = 'location_auto_join_' . $this->location_country_identifier;
}
}
function operator_options() {
if ($this->options['expose']['single']) {
return array(
'is' => t('Is'),
'is not' => t('Is not'),
);
}
else {
return array(
'is' => t('Is one of'),
'is not' => t('Is not one of'),
);
}
}
function grovel_country() {
$country = variable_get('site_default_country', 'us');
if (!empty($this->view->filter)) {
foreach ($this->view->filter as $k => $v) {
if ($v->table == 'location' && $v->field == 'country' && $v->options['relationship'] == $this->options['relationship']) {
$country = $v->value;
if (!empty($v->options['expose']['identifier'])) {
if (isset($this->view->exposed_input[$v->options['expose']['identifier']])) {
$country = $this->view->exposed_input[$v->options['expose']['identifier']];
}
$this->location_country_identifier = $v->options['expose']['identifier'];
}
}
}
}
if ($country == '' || $country == 'All' || $country == ' ' || $country == 'xx') {
// It's set to something nonsensical, reset to the default to prevent malfunctions.
$country = variable_get('site_default_country', 'us');
}
$this->location_country = $country;
return $country;
}
function query() {
// Normalize values.
$value = $this->value;
if (is_array($value)) {
// At one point during development, provinces was a select box.
// Right now it's an autocomplete textfield.
// @@@ Investigate correct fix sometime.
//$value = array_keys($value);
if (count($value) == 1) {
// If multiple is allowed but only one was chosen, use a string instead.
$value = reset($value);
}
}
if (empty($value)) {
return;
}
$country = $this
->grovel_country();
$this
->ensure_my_table();
$field = "{$this->table_alias}.{$this->real_field}";
if (is_array($value)) {
// Multiple values
foreach ($value as $k => $v) {
// Convert to province codes.
$value[$k] = location_province_code($country, $v);
}
$operator = $this->operator == 'is' ? 'IN' : 'NOT IN';
$this->query
->add_where($this->options['group'], $field, $value, $operator);
}
else {
// Single value
// Convert to province code.
$value = location_province_code($country, $value);
$operator = $this->operator == 'is' ? '=' : '!=';
$this->query
->add_where($this->options['group'], $field, $value, $operator);
}
}
}
Members
Name![]() |
Modifiers | Type | Description | Overrides |
---|---|---|---|---|
location_handler_filter_location_province:: |
property | |||
location_handler_filter_location_province:: |
property | |||
location_handler_filter_location_province:: |
function |
Display the filter on the administrative summary. Overrides views_handler_filter:: |
||
location_handler_filter_location_province:: |
function | |||
location_handler_filter_location_province:: |
function |
Provide a list of options for the default operator form. Overrides views_handler_filter:: |
||
location_handler_filter_location_province:: |
function |
Information about options for all kinds of purposes will be held here. Overrides views_handler_filter:: |
||
location_handler_filter_location_province:: |
function |
Add this filter to the query. Overrides views_handler_filter:: |
||
location_handler_filter_location_province:: |
function |
Provide a simple textfield for equality Overrides views_handler_filter:: |
||
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 | Check whether current user has access to this handler. | 10 |
views_handler:: |
public | function | Determine if the handler is considered 'broken'. | 6 |
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 | Submit the exposed handler form. | |
views_handler:: |
public | function | Validate the exposed handler form. | 4 |
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 | 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 | Determine if this item is 'exposed', meaning it provides form elements to let users modify the view. | |
views_handler:: |
public | function | Determine if the argument needs a style plugin. | 1 |
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 exposed options form. | |
views_handler:: |
public | function | Return a string representing this handler's name in the UI. | 9 |
views_handler:: |
public | function | Provides the handler some groupby. | 2 |
views_handler:: |
public | function | Validates the handler against the complete View. | 1 |
views_handler_filter:: |
public | property | Disable the possibility to force a single value. | 6 |
views_handler_filter:: |
public | property | Disable the possibility to allow a exposed input to be optional. | |
views_handler_filter:: |
public | property | Contains the information of the selected item in a gruped filter. | |
views_handler_filter:: |
public | property | Disable the possibility to use operators. | 2 |
views_handler_filter:: |
public | property | Contains the operator which is used on the query. | |
views_handler_filter:: |
public | property | Contains the actual value of the field. | |
views_handler_filter:: |
public | function |
Check to see if input from the exposed filters should change the behavior. Overrides views_handler:: |
2 |
views_handler_filter:: |
public | function | Build the form to let users create the group of exposed filters. | |
views_handler_filter:: |
public | function | Provide default options for exposed filters. | |
views_handler_filter:: |
public | function | Save new group items, re-enumerates and remove groups marked to delete. | |
views_handler_filter:: |
public | function | Validate the build group options form. | 1 |
views_handler_filter:: |
public | function | Determine if a filter can be converted into a group. | |
views_handler_filter:: |
public | function |
Determine if a filter can be exposed. Overrides views_handler:: |
5 |
views_handler_filter:: |
public | function | Can this filter be used in OR groups? | 1 |
views_handler_filter:: |
public | function | Transform the input from a grouped filter into a standard filter. | |
views_handler_filter:: |
public | function |
Render our chunk of the exposed filter form when selecting. Overrides views_handler:: |
|
views_handler_filter:: |
public | function |
Tell the renderer about our exposed form. Overrides views_handler:: |
|
views_handler_filter:: |
public | function | Make some translations to a form item to make it more suitable to exposing. | |
views_handler_filter:: |
public | function |
Options form subform for exposed filter options. Overrides views_handler:: |
2 |
views_handler_filter:: |
public | function |
Provide default options for exposed filters. Overrides views_handler:: |
2 |
views_handler_filter:: |
public | function |
Validate the options form. Overrides views_handler:: |
|
views_handler_filter:: |
public | function | Build a form with a group of operator | values to apply as a single filter. | |
views_handler_filter:: |
public | function | Options available for a grouped filter which uses checkboxes. | |
views_handler_filter:: |
public | function |
Provide some extra help to get the operator/value easier to use. Overrides views_handler:: |
2 |
views_handler_filter:: |
public | function |
Returns TRUE if the exposed filter works like a grouped filter. Overrides views_handler:: |
|
views_handler_filter:: |
public | function |
Indicate whether users can select multiple group items. Overrides views_handler:: |
|
views_handler_filter:: |
public | function | Options form subform for setting the operator. | 6 |
views_handler_filter:: |
public | function | Perform any necessary changes to the form values prior to storage. | |
views_handler_filter:: |
public | function | Validate the operator form. | |
views_handler_filter:: |
public | function |
Provide the basic form which calls through to subforms. Overrides views_handler:: |
4 |
views_handler_filter:: |
public | function |
Simple submit handler. Overrides views_handler:: |
|
views_handler_filter:: |
public | function |
Simple validate handler. Overrides views_handler:: |
1 |
views_handler_filter:: |
public | function | Sanitizes the HTML select element's options. | |
views_handler_filter:: |
public | function | Shortcut to display the build_group/hide button. | |
views_handler_filter:: |
public | function | Shortcut to display the exposed options form. | |
views_handler_filter:: |
public | function |
Shortcut to display the expose/hide button. Overrides views_handler:: |
|
views_handler_filter:: |
public | function | Shortcut to display the operator form. | |
views_handler_filter:: |
public | function | Shortcut to display the value form. | |
views_handler_filter:: |
public | function |
Store the exposed input for processing later. Overrides views_handler:: |
|
views_handler_filter:: |
public | function | If set to remember exposed input in the session, store it there. | |
views_handler_filter:: |
public | function | Perform any necessary changes to the form values prior to storage. | 1 |
views_handler_filter:: |
public | function | Validate the options form. | 3 |
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 |