You are here

interface PreprocessorInterface in Geocoder 8.3

Same name and namespace in other branches
  1. 8.2 modules/geocoder_field/src/PreprocessorInterface.php \Drupal\geocoder_field\PreprocessorInterface

Provides an interface for geocoder preprocessor plugins.

Preprocessors are plugins that knows to format source data before it's sent to geocoding.

Hierarchy

Expanded class hierarchy of PreprocessorInterface

All classes that implement PreprocessorInterface

File

modules/geocoder_field/src/PreprocessorInterface.php, line 13

Namespace

Drupal\geocoder_field
View source
interface PreprocessorInterface {

  /**
   * Sets the field that needs to be preprocessed.
   *
   * @param \Drupal\Core\Field\FieldItemListInterface $field
   *   The field that needs to be preprocessed.
   *
   * @return $this
   */
  public function setField(FieldItemListInterface $field);

  /**
   * Processes the values of the field before geocoding.
   *
   * @return $this
   */
  public function preprocess();

  /**
   * Get prepared reverse geocode values.
   *
   * @todo [cc]: When fixing reverse operation, clarify the interface for this
   *   method, including the method name.
   */
  public function getPreparedReverseGeocodeValues(array $values = []);

}

Members

Namesort descending Modifiers Type Description Overrides
PreprocessorInterface::getPreparedReverseGeocodeValues public function Get prepared reverse geocode values. 1
PreprocessorInterface::preprocess public function Processes the values of the field before geocoding. 1
PreprocessorInterface::setField public function Sets the field that needs to be preprocessed. 1