class location_handler_field_location_distance in Location 7.3
Same name and namespace in other branches
- 6.3 handlers/location_handler_field_location_distance.inc \location_handler_field_location_distance
- 7.5 handlers/location_handler_field_location_distance.inc \location_handler_field_location_distance
- 7.4 handlers/location_handler_field_location_distance.inc \location_handler_field_location_distance
Hierarchy
- class \views_object
- class \views_handler
Expanded class hierarchy of location_handler_field_location_distance
1 string reference to 'location_handler_field_location_distance'
- location_views_data in ./
location.views.inc - Implementation of hook_views_data().
File
- handlers/
location_handler_field_location_distance.inc, line 9 - Coordinates field handler.
View source
class location_handler_field_location_distance extends views_handler_field {
/**
* {@inheritdoc}
*/
public function option_definition() {
$options = parent::option_definition();
$options['origin'] = array(
'default' => 'user',
);
$options['units'] = array(
'default' => 'km',
);
$options['latitude'] = array(
'default' => '',
);
$options['longitude'] = array(
'default' => '',
);
$options['postal_code'] = array(
'default' => '',
);
$options['country'] = array(
'default' => '',
);
$options['php_code'] = array(
'default' => '',
);
$options['nid_arg'] = array(
'default' => '',
);
$options['nid_loc_field'] = array(
'default' => 'node',
);
$options['uid_arg'] = array(
'default' => '',
);
return $options;
}
/**
* {@inheritdoc}
*/
public function has_extra_options() {
return TRUE;
}
/**
* {@inheritdoc}
*/
public function extra_options_form(&$form, &$form_state) {
$form['units'] = array(
'#type' => 'radios',
'#title' => t('Units'),
'#options' => array(
'km' => t('Kilometers'),
'mi' => t('Miles'),
),
'#default_value' => $this->options['units'],
);
$form['origin'] = array(
'#type' => 'select',
'#title' => t('Origin'),
'#options' => array(
'user' => t("User's Latitude / Longitude (blank if unset)"),
'hybrid' => t("User's Latitude / Longitude (fall back to static if unset)"),
'static' => t('Static Latitude / Longitude'),
'tied' => t("Use Distance / Proximity filter"),
'postal' => t('Postal Code / Country'),
'postal_default' => t('Postal Code (assume default country)'),
'php' => t('Use PHP code to determine latitude/longitude'),
'nid_arg' => t("Node's Latitude / Longitude from views nid argument"),
'uid_arg' => t("User's Latitude / Longitude from views uid argument"),
'distance_arg' => t("Latitude / Longitude from views argument"),
),
'#description' => t("This will be the way the latitude/longitude of origin is determined. When using the user's latitude / longitude, if a user has multiple locations the first will be used."),
'#default_value' => $this->options['origin'],
);
$form['latitude'] = array(
'#type' => 'textfield',
'#title' => t('Latitude'),
'#default_value' => $this->options['latitude'],
'#process' => array(
'ctools_dependent_process',
),
'#dependency' => array(
'edit-options-origin' => array(
'hybrid',
'static',
),
),
);
$form['longitude'] = array(
'#type' => 'textfield',
'#title' => t('Longitude'),
'#default_value' => $this->options['longitude'],
'#process' => array(
'ctools_dependent_process',
),
'#dependency' => array(
'edit-options-origin' => array(
'hybrid',
'static',
),
),
);
$form['postal_code'] = array(
'#type' => 'textfield',
'#title' => t('Postal code'),
'#default_value' => $this->options['postal_code'],
'#process' => array(
'ctools_dependent_process',
),
'#dependency' => array(
'edit-options-origin' => array(
'postal',
'postal_default',
),
),
'#maxlength' => 16,
);
$form['country'] = array(
'#type' => 'select',
'#title' => t('Country'),
'#options' => array(
'' => '',
) + location_get_iso3166_list(),
'#default_value' => $this->options['country'],
'#process' => array(
'ctools_dependent_process',
),
'#dependency' => array(
'edit-options-origin' => array(
'postal',
),
),
);
$form['php_code'] = array(
'#type' => 'textarea',
'#title' => t('PHP code for latitude, longitude'),
'#default_value' => $this->options['php_code'],
'#process' => array(
'ctools_dependent_process',
),
'#dependency' => array(
'edit-options-origin' => array(
'php',
),
),
'#description' => t("Enter PHP code that returns a latitude/longitude. Do not use <?php ?>. You must return only an array with float values set for the 'latitude' and 'longitude' keys."),
);
list($nid_argument_options, $uid_argument_options) = location_views_proximity_get_argument_options($this->view);
$nid_loc_field_options = location_views_proximity_get_location_field_options();
$form['nid_arg'] = array(
'#type' => 'select',
'#title' => t('Node ID argument to use'),
'#options' => $nid_argument_options,
'#default_value' => $this->options['nid_arg'],
'#description' => empty($nid_argument_options) ? t("Select which of the view's arguments to use as the node ID. The latitude / longitude of the first location of that node will be used as the origin. Use the 'Global: Null' argument if you don't want to also restrict results to that node ID. You must have added arguments to the view to use this option.") : t("Select which of the view's arguments to use as the node ID. The latitude / longitude of the first location of that node will be used as the origin. Use the 'Global: Null' argument if you don't want to also restrict results to that node ID."),
'#process' => array(
'ctools_dependent_process',
),
'#dependency' => array(
'edit-options-origin' => array(
'nid_arg',
),
),
);
$form['nid_loc_field'] = array(
'#type' => 'select',
'#title' => t('Location to use'),
'#options' => $nid_loc_field_options,
'#default_value' => $this->options['nid_loc_field'],
'#description' => t("Select which of the node's locations to use as the origin. Either the node locations or a CCK location field. If the location supports multiple entries the first one will be used."),
'#process' => array(
'ctools_dependent_process',
),
'#dependency' => array(
'edit-options-origin' => array(
'nid_arg',
),
),
);
$form['uid_arg'] = array(
'#type' => 'select',
'#title' => t('User ID argument to use'),
'#options' => $uid_argument_options,
'#default_value' => $this->options['uid_arg'],
'#description' => empty($uid_argument_options) ? t("Select which of the view's arguments to use as the user ID. The latitude / longitude of the first location of that user will be used as the origin. Use the 'Global: Null' argument if you don't want to also restrict results to that user ID. You must have added arguments to the view to use this option.") : t("Select which of the view's arguments to use as the user ID. The latitude / longitude of the first location of that user will be used as the origin. Use the 'Global: Null' argument if you don't want to also restrict results to that user ID."),
'#process' => array(
'ctools_dependent_process',
),
'#dependency' => array(
'edit-options-origin' => array(
'uid_arg',
),
),
);
}
/**
* {@inheritdoc}
*/
public function click_sort($order) {
$location = location_views_proximity_get_reference_location($this->view, $this->options);
if (!empty($location)) {
$this->query
->add_orderby(NULL, earth_distance_sql($location['longitude'], $location['latitude'], $this->table_alias), $order, $this->field_alias);
}
}
/**
* {@inheritdoc}
*/
public function render($values) {
if (empty($values->{$this->field_alias}) || $values->{$this->field_alias} == 'Unknown') {
// Unset location, empty display.
return;
}
$dist = (double) $values->{$this->field_alias};
if ($this->options['units'] == 'km') {
$dist = $dist / 1000.0;
return theme('location_distance', array(
'distance' => $dist,
'units' => 'km',
));
}
else {
$dist = $dist / 1609.347;
return theme('location_distance', array(
'distance' => $dist,
'units' => 'mi',
));
}
}
/**
* {@inheritdoc}
*/
public function query() {
$this
->ensure_my_table();
$coordinates = location_views_proximity_get_reference_location($this->view, $this->options);
if (!empty($coordinates)) {
$this->field_alias = $this->query
->add_field(NULL, earth_distance_sql($coordinates['longitude'], $coordinates['latitude'], $this->table_alias), $this->table_alias . '_' . $this->field);
}
else {
$this->field_alias = $this->query
->add_field(NULL, "'Unknown'", $this->table_alias . '_' . $this->field);
}
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
location_handler_field_location_distance:: |
public | function |
Called to determine what to tell the clicksorter. Overrides views_handler_field:: |
|
location_handler_field_location_distance:: |
public | function |
Provide a form for setting options. Overrides views_handler:: |
|
location_handler_field_location_distance:: |
public | function |
If a handler has 'extra options' it will get a little settings widget and
another form called extra_options. Overrides views_handler:: |
|
location_handler_field_location_distance:: |
public | function |
Information about options for all kinds of purposes will be held here. Overrides views_handler_field:: |
|
location_handler_field_location_distance:: |
public | function |
Called to add the field to a query. Overrides views_handler_field:: |
|
location_handler_field_location_distance:: |
public | function |
Render the field. Overrides views_handler_field:: |
|
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 | Take input from exposed handlers and assign to this handler, if necessary. | 1 |
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 | Determine if a handler can be exposed. | 2 |
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 | Render our chunk of the exposed handler form when selecting. | 1 |
views_handler:: |
public | function | Get information about the exposed form for the form renderer. | 1 |
views_handler:: |
public | function | Submit the exposed handler form. | |
views_handler:: |
public | function | Validate the exposed handler form. | 4 |
views_handler:: |
public | function | Form for exposed handler options. | 2 |
views_handler:: |
public | function | Set new exposed option defaults when exposed setting is flipped on. | 2 |
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 | Validate the options form. | 1 |
views_handler:: |
public | function | Provide defaults for the handler. | |
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 | Returns TRUE if the exposed filter works like a grouped filter. | 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 | Define if the exposed input has to be submitted multiple times. This is TRUE when exposed filters grouped are using checkboxes as widgets. | 1 |
views_handler:: |
public | function | Determine if the argument needs a style plugin. | 1 |
views_handler:: |
public | function | Validate the options form. | 4 |
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 expose/hide button. | 2 |
views_handler:: |
public | function | Shortcut to display the exposed options form. | |
views_handler:: |
public | function | If set to remember exposed input in the session, store it there. | 1 |
views_handler:: |
public | function | Provides the handler some groupby. | 2 |
views_handler:: |
public | function | Validates the handler against the complete View. | 1 |
views_handler_field:: |
public | property | Stores additional fields which get added to the query. The generated aliases are stored in $aliases. | |
views_handler_field:: |
public | property | ||
views_handler_field:: |
public | property | ||
views_handler_field:: |
protected | property | Keeps track of the last render index. | |
views_handler_field:: |
public | property | The field value prior to any rewriting. | |
views_handler_field:: |
public | function | Add 'additional' fields to the query. | |
views_handler_field:: |
public | function | Add any special tokens this field might use for itself. | 4 |
views_handler_field:: |
public | function |
Provide extra data to the administration form Overrides views_handler:: |
|
views_handler_field:: |
public | function | Render a field using advanced settings. | |
views_handler_field:: |
public | function | Determine if this field can allow advanced rendering. | 1 |
views_handler_field:: |
public | function | Determine if this field is click sortable. | 1 |
views_handler_field:: |
public | function |
Construct a new field handler. Overrides views_object:: |
17 |
views_handler_field:: |
public | function | Document any special tokens this field might use for itself. | 4 |
views_handler_field:: |
public | function | Return the class of the field. | |
views_handler_field:: |
public | function | Return the class of the field's label. | |
views_handler_field:: |
public | function | Return an HTML element for the label based upon the field's element type. | |
views_handler_field:: |
public | function | Return an HTML element based upon the field's element type. | 2 |
views_handler_field:: |
public | function | Return the class of the field's wrapper. | |
views_handler_field:: |
public | function | Return an HTML element for the wrapper based upon the field's element type. | |
views_handler_field:: |
public | function | Provide a list of elements valid for field HTML. | |
views_handler_field:: |
public | function | Get the 'render' tokens to use for advanced rendering. | |
views_handler_field:: |
public | function | Recursive function to add replacements for nested query string parameters. | |
views_handler_field:: |
public | function | Get the value that's supposed to be rendered. | 3 |
views_handler_field:: |
public | function |
Init the handler with necessary data. Overrides views_handler:: |
11 |
views_handler_field:: |
public | function | Checks if a field value is empty. | |
views_handler_field:: |
public | function | Get this field's label. | |
views_handler_field:: |
public | function |
Default options form provides the label widget that all fields should have. Overrides views_handler:: |
33 |
views_handler_field:: |
public | function |
Performs some cleanup tasks on the options array before saving it. Overrides views_handler:: |
1 |
views_handler_field:: |
public | function | Run before any fields are rendered. | 8 |
views_handler_field:: |
public | function | Render this field as altered text, from a fieldset set by the user. | |
views_handler_field:: |
public | function | Render this field as a link, with info from a fieldset set by the user. | |
views_handler_field:: |
public | function | Perform an advanced text render for the item. | |
views_handler_field:: |
public | function | Trim the field down to the specified length. | |
views_handler_field:: |
public | function | Call out to the theme() function. | |
views_handler_field:: |
public | function | Build a list of suitable theme functions for this view. | |
views_handler_field:: |
public | function | Replace a value with tokens from the last field. | |
views_handler_field:: |
public | function |
Return a string representing this handler's name in the UI. Overrides views_handler:: |
1 |
views_handler_field:: |
public | function | Determines if this field will be available as an option to group the result by in the style settings. | |
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 | 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 |