interface GeocoderFieldPluginInterface in Geocoder 8.2

Provides an interface for field plugins.

Hierarchy

• interface \Drupal\geocoder_field\GeocoderFieldPluginInterface

1 file declares its use of GeocoderFieldPluginInterface

DefaultField.php in modules/geocoder_field/src/Plugin/Geocoder/Field/DefaultField.php

File

modules/geocoder_field/src/GeocoderFieldPluginInterface.php, line 11

Namespace

Drupal\geocoder_field

interface GeocoderFieldPluginInterface {

  /**
   * Provides the third party field settings subform.
   *
   * The returned form API element will be added in behalf of 'geocoder_field'
   * module as third party settings to the field that is storing the geocoding
   * result.
   *
   * @param \Drupal\Core\Field\FieldConfigInterface $field
   *   The field config.
   * @param array $form
   *   The form API form array.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The form state object.
   *
   * @return array
   *   A form API form.
   */
  public function getSettingsForm(FieldConfigInterface $field, array $form, FormStateInterface &$form_state);

  /**
   * Validates the field settings form.
   *
   * @param array $form
   *   The form API form array.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The form state object.
   */
  public function validateSettingsForm(array $form, FormStateInterface &$form_state);

}

Members

Name	Modifiers	Type	Description	Overrides
GeocoderFieldPluginInterface::getSettingsForm	public	function	Provides the third party field settings subform.	1
GeocoderFieldPluginInterface::validateSettingsForm	public	function	Validates the field settings form.	1