class GeolocationCore in Geolocation Field 8
Class GeolocationCore.
@package Drupal\geolocation
Hierarchy
- class \Drupal\geolocation\GeolocationCore implements ContainerInjectionInterface uses StringTranslationTrait
Expanded class hierarchy of GeolocationCore
7 files declare their use of GeolocationCore
- BoundaryFilter.php in src/
Plugin/ views/ filter/ BoundaryFilter.php - GeolocationGooglegeocoderWidget.php in src/
Plugin/ Field/ FieldWidget/ GeolocationGooglegeocoderWidget.php - GeolocationLatlngWidget.php in src/
Plugin/ Field/ FieldWidget/ GeolocationLatlngWidget.php - GeolocationSexagesimalFormatter.php in src/
Plugin/ Field/ FieldFormatter/ GeolocationSexagesimalFormatter.php - ProximityArgument.php in src/
Plugin/ views/ argument/ ProximityArgument.php
1 string reference to 'GeolocationCore'
1 service uses GeolocationCore
File
- src/
GeolocationCore.php, line 18
Namespace
Drupal\geolocationView source
class GeolocationCore implements ContainerInjectionInterface {
use StringTranslationTrait;
const EARTH_RADIUS_KM = 6371;
const EARTH_RADIUS_MILE = 3959;
/**
* Drupal\Core\Extension\ModuleHandler definition.
*
* @var \Drupal\Core\Extension\ModuleHandler
*/
protected $moduleHandler;
/**
* Drupal\Core\Entity\EntityManager definition.
*
* @var \Drupal\Core\Entity\EntityManager
*/
protected $entityManager;
/**
* The required configuration object.
*
* @var \Drupal\Core\Config\Config
*/
protected $config;
/**
* The GeocoderManager object.
*
* @var \Drupal\geolocation\GeocoderManager
*/
protected $geocoderManager;
/**
* Constructor.
*
* @param \Drupal\Core\Extension\ModuleHandlerInterface $module_handler
* A module handler.
* @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_manager
* An EntityTypeManager instance.
* @param \Drupal\Core\Config\ConfigFactory $config
* The factory for configuration objects.
* @param \Drupal\geolocation\GeocoderManager $geocoder_manager
* The GeocoderManager object.
*/
public function __construct(ModuleHandlerInterface $module_handler, EntityTypeManagerInterface $entity_manager, ConfigFactory $config, GeocoderManager $geocoder_manager) {
$this->moduleHandler = $module_handler;
$this->entityManager = $entity_manager;
$this->config = $config
->get('geolocation.settings');
$this->geocoderManager = $geocoder_manager;
}
/**
* {@inheritdoc}
*/
public static function create(ContainerInterface $container) {
return new static($container
->get('module_handler'), $container
->get('entity_type.manager'), $container
->get('config.factory'), $container
->get('plugin.manager.geolocation.geocoder'));
}
/**
* Return current geocoder manager.
*
* @return \Drupal\geolocation\GeocoderManager
* Geocoder manager.
*/
public function getGeocoderManager() {
return $this->geocoderManager;
}
/**
* Get views data for fields and filters.
*
* @param \Drupal\field\FieldStorageConfigInterface $field_storage
* Storage of the current field.
*
* @return array
* The data to return to Views.
*/
public function getViewsFieldData(FieldStorageConfigInterface $field_storage) {
// Make sure views.views.inc is loaded.
module_load_include('inc', 'views', 'views.views');
// Get the default data from the views module.
$data = views_field_default_views_data($field_storage);
$args = [
'@field_name' => $field_storage
->getName(),
];
// Loop through all of the results and set our overrides.
foreach ($data as $table_name => $table_data) {
foreach ($table_data as $field_name => $field_data) {
// Only modify fields.
if ($field_name != 'delta') {
if (isset($field_data['field'])) {
// Use our own field handler.
$data[$table_name][$field_name]['field']['id'] = 'geolocation_field';
$data[$table_name][$field_name]['field']['click sortable'] = FALSE;
}
if (isset($field_data['filter'])) {
if (substr($field_name, -4, 4) == '_lat') {
$data[$table_name][$field_name]['title'] = $this
->t('Latitude (@field_name)', $args);
continue;
}
if (substr($field_name, -4, 4) == '_lng') {
$data[$table_name][$field_name]['title'] = $this
->t('Longitude (@field_name)', $args);
continue;
}
// The default filters are mostly not useful except lat/lng.
unset($data[$table_name][$field_name]['filter']);
}
if (isset($field_data['argument'])) {
// The default arguments aren't useful at all so remove them.
unset($data[$table_name][$field_name]['argument']);
}
if (isset($field_data['sort'])) {
// The default arguments aren't useful at all so remove them.
unset($data[$table_name][$field_name]['sort']);
}
}
}
$field_coordinates_table_data = [];
$entity_type_id = $field_storage
->getTargetEntityTypeId();
$target_entity_type = $this->entityManager
->getDefinition($field_storage
->getTargetEntityTypeId());
if (array_key_exists($target_entity_type
->getBaseTable() . '__' . $field_storage
->getName(), $data)) {
$field_coordinates_table_data = $data[$target_entity_type
->getBaseTable() . '__' . $field_storage
->getName()][$field_storage
->getName()];
}
elseif (array_key_exists($entity_type_id . '__' . $field_storage
->getName(), $data)) {
// Fall back to using the key format as defined in,
// views_field_default_views_data().
$field_coordinates_table_data = $data[$entity_type_id . '__' . $field_storage
->getName()][$field_storage
->getName()];
}
// Add proximity handlers.
$data[$table_name][$args['@field_name'] . '_proximity'] = [
'group' => $target_entity_type
->getLabel(),
'title' => $this
->t('Proximity (@field_name)', $args),
'title short' => isset($field_coordinates_table_data['title short']) ? $field_coordinates_table_data['title short'] . $this
->t(":proximity") : '',
'help' => isset($field_coordinates_table_data['help']) ? $field_coordinates_table_data['help'] : '',
'argument' => [
'id' => 'geolocation_argument_proximity',
'table' => $table_name,
'entity_type' => $entity_type_id,
'field_name' => $args['@field_name'] . '_proximity',
'real field' => $args['@field_name'],
'label' => $this
->t('Distance to !field_name', $args),
'empty field name' => '- No value -',
'additional fields' => [
$args['@field_name'] . '_lat',
$args['@field_name'] . '_lng',
$args['@field_name'] . '_lat_sin',
$args['@field_name'] . '_lat_cos',
$args['@field_name'] . '_lng_rad',
],
],
'filter' => [
'id' => 'geolocation_filter_proximity',
'table' => $table_name,
'entity_type' => $entity_type_id,
'field_name' => $args['@field_name'] . '_proximity',
'real field' => $args['@field_name'],
'label' => $this
->t('Distance to !field_name', $args),
'allow empty' => TRUE,
'additional fields' => [
$args['@field_name'] . '_lat',
$args['@field_name'] . '_lng',
$args['@field_name'] . '_lat_sin',
$args['@field_name'] . '_lat_cos',
$args['@field_name'] . '_lng_rad',
],
],
'field' => [
'table' => $table_name,
'id' => 'geolocation_field_proximity',
'field_name' => $args['@field_name'] . '_proximity',
'entity_type' => $entity_type_id,
'real field' => $args['@field_name'],
'float' => TRUE,
'additional fields' => [
$args['@field_name'] . '_lat',
$args['@field_name'] . '_lng',
$args['@field_name'] . '_lat_sin',
$args['@field_name'] . '_lat_cos',
$args['@field_name'] . '_lng_rad',
],
'element type' => 'div',
'is revision' => isset($table_data[$args['@field_name']]['field']['is revision']) && $table_data[$args['@field_name']]['field']['is revision'],
'click sortable' => TRUE,
],
'sort' => [
'table' => $table_name,
'id' => 'geolocation_sort_proximity',
'field_name' => $args['@field_name'] . '_proximity',
'entity_type' => $entity_type_id,
'real field' => $args['@field_name'],
],
];
// Add boundary handlers.
$data[$table_name][$args['@field_name'] . '_boundary'] = [
'group' => $target_entity_type
->getLabel(),
'title' => $this
->t('Boundary (@field_name)', $args),
'title short' => isset($field_coordinates_table_data['title short']) ? $field_coordinates_table_data['title short'] . $this
->t(":boundary") : '',
'help' => isset($field_coordinates_table_data['help']) ? $field_coordinates_table_data['help'] : '',
'filter' => [
'id' => 'geolocation_filter_boundary',
'table' => $table_name,
'entity_type' => $entity_type_id,
'field_name' => $args['@field_name'] . '_boundary',
'real field' => $args['@field_name'],
'label' => $this
->t('Boundaries around !field_name', $args),
'allow empty' => TRUE,
'additional fields' => [
$args['@field_name'] . '_lat',
$args['@field_name'] . '_lng',
],
],
];
}
return $data;
}
/**
* Gets the query fragment for adding a proximity field to a query.
*
* @param string $table_name
* The proximity table name.
* @param string $field_id
* The proximity field ID.
* @param string $filter_lat
* The latitude to filter for.
* @param string $filter_lng
* The longitude to filter for.
* @param int $earth_radius
* Filter radius.
*
* @return string
* The fragment to enter to actual query.
*/
public function getProximityQueryFragment($table_name, $field_id, $filter_lat, $filter_lng, $earth_radius = self::EARTH_RADIUS_KM) {
// Define the field names.
$field_latsin = "{$table_name}.{$field_id}_lat_sin";
$field_latcos = "{$table_name}.{$field_id}_lat_cos";
$field_lng = "{$table_name}.{$field_id}_lng_rad";
// deg2rad() is sensitive to empty strings. Replace with integer zero.
$filter_lat = empty($filter_lat) ? 0 : $filter_lat;
$filter_lng = empty($filter_lng) ? 0 : $filter_lng;
// Pre-calculate filter values.
$filter_latcos = cos(deg2rad($filter_lat));
$filter_latsin = sin(deg2rad($filter_lat));
$filter_lng = deg2rad($filter_lng);
return "(\n ACOS(LEAST(1,\n {$filter_latcos}\n * {$field_latcos}\n * COS( {$filter_lng} - {$field_lng} )\n +\n {$filter_latsin}\n * {$field_latsin}\n )) * {$earth_radius}\n )";
}
/**
* Gets the query fragment for adding a boundary field to a query.
*
* @param string $table_name
* The proximity table name.
* @param string $field_id
* The proximity field ID.
* @param string $filter_lat_north_east
* The latitude to filter for.
* @param string $filter_lng_north_east
* The longitude to filter for.
* @param string $filter_lat_south_west
* The latitude to filter for.
* @param string $filter_lng_south_west
* The longitude to filter for.
*
* @return string
* The fragment to enter to actual query.
*/
public function getBoundaryQueryFragment($table_name, $field_id, $filter_lat_north_east, $filter_lng_north_east, $filter_lat_south_west, $filter_lng_south_west) {
// Define the field name.
$field_lat = "{$table_name}.{$field_id}_lat";
$field_lng = "{$table_name}.{$field_id}_lng";
/*
* Google Maps shows a map, not a globe. Therefore it will never flip over
* the poles, but it will move across -180°/+180° longitude.
* So latitude will always have north larger than south, but east not
* necessarily larger than west.
*/
return "({$field_lat} BETWEEN {$filter_lat_south_west} AND {$filter_lat_north_east})\n AND\n (\n ({$filter_lng_south_west} < {$filter_lng_north_east} AND {$field_lng} BETWEEN {$filter_lng_south_west} AND {$filter_lng_north_east})\n OR\n (\n {$filter_lng_south_west} > {$filter_lng_north_east} AND (\n {$field_lng} BETWEEN {$filter_lng_south_west} AND 180 OR {$field_lng} BETWEEN -180 AND {$filter_lng_north_east}\n )\n )\n )\n ";
}
/**
* Transform sexagesimal notation to float.
*
* Sexagesimal means a string like - X° Y' Z"
*
* @param string $sexagesimal
* String in DMS notation.
*
* @return float|false
* The regular float notation or FALSE if not sexagesimal.
*/
public static function sexagesimalToDecimal($sexagesimal = '') {
$pattern = "/(?<degree>-?\\d{1,3})°[ ]?((?<minutes>\\d{1,2})')?[ ]?((?<seconds>(\\d{1,2}|\\d{1,2}\\.\\d+))\")?/";
preg_match($pattern, $sexagesimal, $gps_matches);
if (!empty($gps_matches)) {
$value = $gps_matches['degree'];
if (!empty($gps_matches['minutes'])) {
$value += $gps_matches['minutes'] / 60;
}
if (!empty($gps_matches['seconds'])) {
$value += $gps_matches['seconds'] / 3600;
}
}
else {
return FALSE;
}
return $value;
}
/**
* Transform decimal notation to sexagesimal.
*
* Sexagesimal means a string like - X° Y' Z"
*
* @param float|string $decimal
* Either float or float-castable location.
*
* @return string|false
* The sexagesimal notation or FALSE on error.
*/
public static function decimalToSexagesimal($decimal = '') {
$decimal = (double) $decimal;
$degrees = floor($decimal);
$rest = $decimal - $degrees;
$minutes = floor($rest * 60);
$rest = $rest * 60 - $minutes;
$seconds = round($rest * 60, 4);
$value = $degrees . '°';
if (!empty($minutes)) {
$value .= ' ' . $minutes . '\'';
}
if (!empty($seconds)) {
$value .= ' ' . $seconds . '"';
}
return $value;
}
}Members
Name |
Modifiers | Type | Description | Overrides |
|---|---|---|---|---|
|
GeolocationCore:: |
protected | property | The required configuration object. | |
|
GeolocationCore:: |
protected | property | Drupal\Core\Entity\EntityManager definition. | |
|
GeolocationCore:: |
protected | property | The GeocoderManager object. | |
|
GeolocationCore:: |
protected | property | Drupal\Core\Extension\ModuleHandler definition. | |
|
GeolocationCore:: |
public static | function |
Instantiates a new instance of this class. Overrides ContainerInjectionInterface:: |
|
|
GeolocationCore:: |
public static | function | Transform decimal notation to sexagesimal. | |
|
GeolocationCore:: |
constant | |||
|
GeolocationCore:: |
constant | |||
|
GeolocationCore:: |
public | function | Gets the query fragment for adding a boundary field to a query. | |
|
GeolocationCore:: |
public | function | Return current geocoder manager. | |
|
GeolocationCore:: |
public | function | Gets the query fragment for adding a proximity field to a query. | |
|
GeolocationCore:: |
public | function | Get views data for fields and filters. | |
|
GeolocationCore:: |
public static | function | Transform sexagesimal notation to float. | |
|
GeolocationCore:: |
public | function | Constructor. | |
|
StringTranslationTrait:: |
protected | property | The string translation service. | 1 |
|
StringTranslationTrait:: |
protected | function | Formats a string containing a count of items. | |
|
StringTranslationTrait:: |
protected | function | Returns the number of plurals supported by a given language. | |
|
StringTranslationTrait:: |
protected | function | Gets the string translation service. | |
|
StringTranslationTrait:: |
public | function | Sets the string translation service to use. | 2 |
|
StringTranslationTrait:: |
protected | function | Translates a string to the current language or to a given language. |