class SearchApiLocationMapViewsHandlerFilter in Search API Location 7.2
@file Provides the views handler for location fields
Hierarchy
- class \views_object
- class \views_handler
Expanded class hierarchy of SearchApiLocationMapViewsHandlerFilter
1 string reference to 'SearchApiLocationMapViewsHandlerFilter'
- search_api_location_map_views_data_alter in search_api_location_map/
views/ search_api_location_map.views.inc - Implements hook_views_data_alter().
File
- search_api_location_map/
views/ handler_filter_location.inc, line 8 - Provides the views handler for location fields
View source
class SearchApiLocationMapViewsHandlerFilter extends SearchApiViewsHandlerFilter {
/**
* Provide a form for setting the filter value.
*/
public function value_form(&$form, &$form_state) {
$field = $this->options['id'];
$default_value = array();
// Check if the input filter is filled in.
if (isset($form_state['input'][$field])) {
$default_value['lat'] = $form_state['input'][$field]['lat'];
$default_value['lng'] = $form_state['input'][$field]['lng'];
$default_value['radius'] = $form_state['input'][$field]['radius'];
}
else {
$default_value['lat'] = $this->options['lat'];
$default_value['lng'] = $this->options['lng'];
$default_value['radius'] = $this->options['radius'];
}
$default_value['radius_min'] = $this->options['radius_min'];
$default_value['radius_max'] = $this->options['radius_max'];
$default_value['radius_step'] = $this->options['radius_step'];
$default_value['radius_measure'] = $this->options['radius_measure'];
$form['value'] = array(
'#type' => 'search_api_location_pick',
'#default_value' => $default_value,
);
}
/**
* Default location settings
*/
public function option_definition() {
$options = parent::option_definition();
$options['lat'] = array(
'default' => '51.03826129999999',
);
$options['lng'] = array(
'default' => '3.7125661000000036',
);
$options['radius'] = array(
'default' => '5',
);
$options['radius_min'] = array(
'default' => '5',
);
$options['radius_max'] = array(
'default' => '100',
);
$options['radius_step'] = array(
'default' => '5',
);
$options['radius_measure'] = array(
'default' => 'km',
);
return $options;
}
/**
* Alter and extend the options form
*/
public function options_form(&$form, &$form_state) {
parent::options_form($form, $form_state);
unset($form['operator']);
unset($form['value']);
$form['label'] = $form['expose']['label'];
unset($form['expose']);
$form['spatial'] = array(
'#type' => 'search_api_location_pick',
'#default_value' => array(
'lat' => $this->options['lat'],
'lng' => $this->options['lng'],
'radius' => $this->options['radius'],
'radius_min' => $this->options['radius_min'],
'radius_max' => $this->options['radius_max'],
'radius_step' => $this->options['radius_step'],
'radius_measure' => $this->options['radius_measure'],
'edit_mode' => TRUE,
),
);
}
/**
* Add this filter to the query.
*/
public function query() {
$field = str_replace(":", "_", $this->real_field);
if (isset($this->view->exposed_input[$field]['radius'])) {
$spatial = array();
$spatial['lat'] = $this->view->exposed_input[$field]['lat'];
$spatial['lng'] = $this->view->exposed_input[$field]['lng'];
$spatial['radius'] = $this->view->exposed_input[$field]['radius'];
$spatial['radius_measure'] = $this->options['radius_measure'];
$spatial['field'] = $this->real_field;
$this->query
->setOption('spatial', $spatial);
}
}
}
Members
Name![]() |
Modifiers | Type | Description | Overrides |
---|---|---|---|---|
SearchApiLocationMapViewsHandlerFilter:: |
public | function |
Alter and extend the options form Overrides views_handler_filter:: |
|
SearchApiLocationMapViewsHandlerFilter:: |
public | function |
Default location settings Overrides views_handler_filter:: |
|
SearchApiLocationMapViewsHandlerFilter:: |
public | function |
Add this filter to the query. Overrides SearchApiViewsHandlerFilter:: |
|
SearchApiLocationMapViewsHandlerFilter:: |
public | function |
Provide a form for setting the filter value. Overrides SearchApiViewsHandlerFilter:: |
|
SearchApiViewsHandlerFilter:: |
public | property |
The operator used for filtering. Overrides views_handler_filter:: |
|
SearchApiViewsHandlerFilter:: |
public | property |
The associated views query object. Overrides views_handler:: |
4 |
SearchApiViewsHandlerFilter:: |
public | property |
The value to filter for. Overrides views_handler_filter:: |
|
SearchApiViewsHandlerFilter:: |
function |
Display the filter on the administrative summary Overrides views_handler_filter:: |
3 | |
SearchApiViewsHandlerFilter:: |
public | function |
Provide a list of options for the operator form. Overrides views_handler_filter:: |
5 |
views_handler:: |
public | property | The type of the handler, for example filter/footer/field. | |
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 | 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 |
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 |