You are here

Home » API reference » Webform Content Creator 3.x » AddressFieldMapping.php

class AddressFieldMapping in Webform Content Creator 3.x

Provides an address field mapping.

Plugin annotation


@WebformContentCreatorFieldMapping(
  id = "address_mapping",
  label = @Translation("Address"),
  weight = 0,
  field_types = {
    "address",
  },
)

Hierarchy

Expanded class hierarchy of AddressFieldMapping

File

src/Plugin/WebformContentCreator/FieldMapping/AddressFieldMapping.php, line 21

Namespace

Drupal\webform_content_creator\Plugin\WebformContentCreator\FieldMapping
View source 
class AddressFieldMapping extends FieldMappingBase {
  public function supportsCustomFields() {
    return FALSE;
  }
  public function getSupportedWebformFields($webform_id) {
    $supported_types = [
      "address",
      "webform_address",
    ];
    return $this
      ->filterWebformFields($webform_id, $supported_types);
  }
  public function mapEntityField(ContentEntityInterface &$content, array $webform_element, array $data = [], FieldDefinitionInterface $field_definition) {
    $field_id = $field_definition
      ->getName();
    $field_value = $field_definition
      ->getDefaultValue($content)[0];
    if ($webform_element[$field_id]['#type'] == "webform_address") {
      if (!empty($data[$field_id]['address'])) {
        $field_value['address_line1'] = $data[$field_id]['address'];
      }
      if (!empty($data[$field_id]['address_2'])) {
        $field_value['address_line2'] = $data[$field_id]['address_2'];
      }
      if (!empty($data[$field_id]['city'])) {
        $field_value['locality'] = $data[$field_id]['city'];
      }
      if (!empty($data[$field_id]['state_province'])) {
        $field_value['administrative_area'] = $data[$field_id]['state_province'];
      }
      if (!empty($data[$field_id]['postal_code'])) {
        $field_value['postal_code'] = $data[$field_id]['postal_code'];
      }
      if (!empty($data[$field_id]['country'])) {
        $field_value['country_code'] = $data[$field_id]['country'];
      }
    }
    else {
      $field_value = array_merge($field_value, $data[$field_id]);
    }
    $content
      ->set($field_id, $field_value);
  }

}

Members

Namesort descending Modifiers Type Description Overrides
AddressFieldMapping::getSupportedWebformFields public function Overrides FieldMappingBase::getSupportedWebformFields
AddressFieldMapping::mapEntityField public function Use a single mapping to set an entity field value. Overrides FieldMappingBase::mapEntityField
AddressFieldMapping::supportsCustomFields public function Returns whether the mapper supports custom field text Overrides FieldMappingBase::supportsCustomFields
FieldMappingBase::filterWebformFields protected function
FieldMappingBase::getEntityComponentFields public function Returns the entity component fields. Overrides FieldMappingInterface::getEntityComponentFields 1
FieldMappingBase::getFieldTypes public function Get the field types this plugin is available for.
FieldMappingBase::getId public function Get the plugin ID.
FieldMappingBase::getLabel public function Get the plugin label.
FieldMappingBase::getPlugin public function Return the plugin.
FieldMappingBase::getWeight public function Get the plugin weight.
FieldMappingBase::isGeneric public function Is this a generic (non-element specific) plugin.
FieldMappingInterface::WEBFORM_ENTIY_REFERENCE_ELEMENTS constant
FieldMappingInterface::WEBFORM_OPTIONS_ELEMENTS constant
FieldMappingInterface::WEBFORM_TEXT_ELEMENTS constant
PluginBase::$configuration protected property Configuration information passed into the plugin. 1
PluginBase::$pluginDefinition protected property The plugin implementation definition. 1
PluginBase::$pluginId protected property The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR constant A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId public function Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId public function Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition public function Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition 2
PluginBase::getPluginId public function Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable public function Determines if the plugin is configurable.
PluginBase::__construct public function Constructs a \Drupal\Component\Plugin\PluginBase object. 98