interface DataProviderInterface in Geolocation Field 8.2

Defines an interface for geolocation DataProvider plugins.

Hierarchy

• interface \Drupal\Component\Plugin\PluginInspectionInterface
  • interface \Drupal\geolocation\DataProviderInterface

4 files declare their use of DataProviderInterface

AddressFieldProvider.php in modules/geolocation_address/src/Plugin/geolocation/DataProvider/AddressFieldProvider.php

Geofield.php in modules/geolocation_geofield/src/Plugin/geolocation/DataProvider/Geofield.php

GeolocationFieldProvider.php in src/Plugin/geolocation/DataProvider/GeolocationFieldProvider.php

SearchAPI.php in modules/geolocation_search_api/src/Plugin/geolocation/DataProvider/SearchAPI.php

File

src/DataProviderInterface.php, line 14

Namespace

Drupal\geolocation

interface DataProviderInterface extends PluginInspectionInterface {

  /**
   * Determine valid views option.
   *
   * @param \Drupal\views\Plugin\views\field\FieldPluginBase $views_field
   *   Views field definition.
   *
   * @return bool
   *   Yes or no.
   */
  public function isViewsGeoOption(FieldPluginBase $views_field);

  /**
   * Determine valid field geo option.
   *
   * @param \Drupal\Core\Field\FieldDefinitionInterface $fieldDefinition
   *   Field definition.
   *
   * @return bool
   *   Yes or no.
   */
  public function isFieldGeoOption(FieldDefinitionInterface $fieldDefinition);

  /**
   * Get positions from views row.
   *
   * @param \Drupal\views\ResultRow $row
   *   Row.
   * @param \Drupal\views\Plugin\views\field\FieldPluginBase $views_field
   *   Views field definition.
   *
   * @return array
   *   Retrieved locations.
   */
  public function getPositionsFromViewsRow(ResultRow $row, FieldPluginBase $views_field = NULL);

  /**
   * Get positions from field item list.
   *
   * @param \Drupal\Core\Field\FieldItemInterface $fieldItem
   *   Views field definition.
   *
   * @return array
   *   Retrieved locations.
   */
  public function getPositionsFromItem(FieldItemInterface $fieldItem);

  /**
   * Replace field item tokens.
   *
   * @param string $text
   *   Text.
   * @param \Drupal\Core\Field\FieldItemInterface $fieldItem
   *   Field item.
   *
   * @return array
   *   Retrieved locations.
   */
  public function replaceFieldItemTokens($text, FieldItemInterface $fieldItem);

  /**
   * Return field item tokens.
   *
   * @param \Drupal\Core\Field\FieldDefinitionInterface $fieldDefinitionInterface
   *   Field definition interface.
   *
   * @return array
   *   Token help element.
   */
  public function getTokenHelp(FieldDefinitionInterface $fieldDefinitionInterface = NULL);

  /**
   * Provide data provider settings form array.
   *
   * @param array $settings
   *   The current data provider settings.
   * @param array $parents
   *   Form parents.
   *
   * @return array
   *   A form array to be integrated in whatever.
   */
  public function getSettingsForm(array $settings, array $parents = []);

  /**
   * Set views field.
   *
   * @param \Drupal\views\Plugin\views\field\FieldPluginBase $viewsField
   *   Views field.
   */
  public function setViewsField(FieldPluginBase $viewsField);

  /**
   * Set field definition.
   *
   * @param \Drupal\Core\Field\FieldDefinitionInterface $fieldDefinition
   *   Field definition.
   */
  public function setFieldDefinition(FieldDefinitionInterface $fieldDefinition);

}

Members

Name	Modifiers	Type	Description	Overrides
DataProviderInterface::getPositionsFromItem	public	function	Get positions from field item list.	1
DataProviderInterface::getPositionsFromViewsRow	public	function	Get positions from views row.	1
DataProviderInterface::getSettingsForm	public	function	Provide data provider settings form array.	1
DataProviderInterface::getTokenHelp	public	function	Return field item tokens.	1
DataProviderInterface::isFieldGeoOption	public	function	Determine valid field geo option.	4
DataProviderInterface::isViewsGeoOption	public	function	Determine valid views option.	1
DataProviderInterface::replaceFieldItemTokens	public	function	Replace field item tokens.	1
DataProviderInterface::setFieldDefinition	public	function	Set field definition.	1
DataProviderInterface::setViewsField	public	function	Set views field.	1
PluginInspectionInterface::getPluginDefinition	public	function	Gets the definition of the plugin implementation.	4
PluginInspectionInterface::getPluginId	public	function	Gets the plugin_id of the plugin instance.	2