class ContextProximityFilter in Geofield 8
Defines 'Geofield Context Filter' plugin.
@package Drupal\geofield\Plugin
Plugin annotation
@GeofieldProximitySource(
id = "geofield_context_filter",
label = @Translation("Context Filter (By context filter)"),
description = @Translation("Allow the contextual input of Distance and Origin (as couple of Latitude and Longitude in decimal degrees.)"),
exposedDescription = @Translation("Contextual input of Distance and Origin (as couple of Latitude and Longitude in decimal degrees.)"),
context = {
"sort",
"field",
},
)
Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\geofield\Plugin\GeofieldProximitySourceBase implements GeofieldProximitySourceInterface uses StringTranslationTrait
- class \Drupal\geofield\Plugin\GeofieldProximitySource\ContextProximityFilter implements ContainerFactoryPluginInterface
- class \Drupal\geofield\Plugin\GeofieldProximitySourceBase implements GeofieldProximitySourceInterface uses StringTranslationTrait
Expanded class hierarchy of ContextProximityFilter
File
- src/
Plugin/ GeofieldProximitySource/ ContextProximityFilter.php, line 27
Namespace
Drupal\geofield\Plugin\GeofieldProximitySourceView source
class ContextProximityFilter extends GeofieldProximitySourceBase implements ContainerFactoryPluginInterface {
/**
* The geofield proximity manager.
*
* @var \Drupal\geofield\Plugin\GeofieldProximitySourceManager
*/
protected $proximitySourceManager;
/**
* {@inheritdoc}
*/
public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
return new static($configuration, $plugin_id, $plugin_definition, $container
->get('plugin.manager.geofield_proximity_source'));
}
/**
* Constructs a GeocodeOrigin object.
*
* @param array $configuration
* A configuration array containing information about the plugin instance.
* @param string $plugin_id
* The plugin_id for the plugin instance.
* @param mixed $plugin_definition
* The plugin implementation definition.
* @param \Drupal\geofield\Plugin\GeofieldProximitySourceManager $proximitySourceManager
* The Geofield Proximity Source manager service.
*/
public function __construct(array $configuration, $plugin_id, $plugin_definition, GeofieldProximitySourceManager $proximitySourceManager) {
parent::__construct($configuration, $plugin_id, $plugin_definition);
$this->proximitySourceManager = $proximitySourceManager;
}
/**
* {@inheritdoc}
*/
public function getOrigin() {
$origin = [];
if (isset($this->viewHandler)) {
/** @var \Drupal\geofield\Plugin\views\argument\GeofieldProximityArgument $geofield_proximity_argument */
$geofield_proximity_argument = $this->viewHandler->view->argument;
foreach ($this->viewHandler->view->argument as $k => $argument) {
if ($argument instanceof GeofieldProximityArgument) {
$geofield_proximity_argument = $argument;
}
}
if (isset($geofield_proximity_argument)) {
$argument_values = $geofield_proximity_argument
->getParsedReferenceLocation();
$origin = [
'lat' => $argument_values['lat'],
'lon' => $argument_values['lon'],
];
}
}
return $origin;
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
ContextProximityFilter:: |
protected | property | The geofield proximity manager. | |
ContextProximityFilter:: |
public static | function |
Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface:: |
|
ContextProximityFilter:: |
public | function |
Gets the proximity distance origin. Overrides GeofieldProximitySourceBase:: |
|
ContextProximityFilter:: |
public | function |
Constructs a GeocodeOrigin object. Overrides PluginBase:: |
|
GeofieldProximitySourceBase:: |
protected | property | The origin point to measure proximity from. | |
GeofieldProximitySourceBase:: |
protected | property | The name of the constant defining the measurement unit. | |
GeofieldProximitySourceBase:: |
protected | property | The view handler which uses this proximity plugin. | |
GeofieldProximitySourceBase:: |
public | function |
Builds the specific form elements for the geofield proximity plugin. Overrides GeofieldProximitySourceInterface:: |
2 |
GeofieldProximitySourceBase:: |
public | function |
Gets the haversine options. Overrides GeofieldProximitySourceInterface:: |
|
GeofieldProximitySourceBase:: |
public | function |
Get the calculated proximity. Overrides GeofieldProximitySourceInterface:: |
|
GeofieldProximitySourceBase:: |
public | function |
Get the current units. Overrides GeofieldProximitySourceInterface:: |
|
GeofieldProximitySourceBase:: |
public | function | Get the list of valid options for units. | |
GeofieldProximitySourceBase:: |
public | function |
Check if Location is empty. Overrides GeofieldProximitySourceInterface:: |
|
GeofieldProximitySourceBase:: |
public | function |
Check for a valid couple of latitude and longitude. Overrides GeofieldProximitySourceInterface:: |
|
GeofieldProximitySourceBase:: |
public | function |
Sets the proximity distance origin. Overrides GeofieldProximitySourceInterface:: |
|
GeofieldProximitySourceBase:: |
public | function |
Set the units to perform the calculation in. Overrides GeofieldProximitySourceInterface:: |
|
GeofieldProximitySourceBase:: |
public | function |
Sets view handler which uses this proximity plugin. Overrides GeofieldProximitySourceInterface:: |
|
GeofieldProximitySourceBase:: |
public | function |
Validates the options form for the geofield proximity plugin. Overrides GeofieldProximitySourceInterface:: |
1 |
PluginBase:: |
protected | property | Configuration information passed into the plugin. | 1 |
PluginBase:: |
protected | property | The plugin implementation definition. | 1 |
PluginBase:: |
protected | property | The plugin_id. | |
PluginBase:: |
constant | A string which is used to separate base plugin IDs from the derivative ID. | ||
PluginBase:: |
public | function |
Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the definition of the plugin implementation. Overrides PluginInspectionInterface:: |
3 |
PluginBase:: |
public | function |
Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface:: |
|
PluginBase:: |
public | function | Determines if the plugin is configurable. | |
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. |