You are here

Home » API reference » Geofield 8 » Geofield.php

class Geofield in Geofield 8

Same name in this branch
  1. 8 src/Feeds/Target/Geofield.php \Drupal\geofield\Feeds\Target\Geofield
  2. 8 src/Plugin/migrate/process/GeoField.php \Drupal\geofield\Plugin\migrate\process\GeoField
  3. 8 src/Plugin/migrate/field/Geofield.php \Drupal\geofield\Plugin\migrate\field\Geofield

Defines a geofield field mapper.

Plugin annotation


@FeedsTarget(
  id = "geofield_feeds_target",
  field_types = {"geofield"}
)

Hierarchy

Expanded class hierarchy of Geofield

1 string reference to 'Geofield'
geofield.info.yml in ./geofield.info.yml
geofield.info.yml

File

src/Feeds/Target/Geofield.php, line 21

Namespace

Drupal\geofield\Feeds\Target
View source 
class Geofield extends FieldTargetBase implements ContainerFactoryPluginInterface {

  /**
   * The Settings object or array.
   *
   * @var mixed
   */
  protected $settings;

  /**
   * The messenger.
   *
   * @var \Drupal\Core\Messenger\MessengerInterface
   */
  protected $messenger;

  /**
   * Constructs a Geofield FeedsTarget 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 array $plugin_definition
   *   The plugin implementation definition.
   * @param \Drupal\Core\Messenger\MessengerInterface $messenger
   *   The messenger.
   */
  public function __construct(array $configuration, $plugin_id, array $plugin_definition, MessengerInterface $messenger) {
    $this->targetDefinition = $configuration['target_definition'];
    $this->settings = $this->targetDefinition
      ->getFieldDefinition()
      ->getSettings();
    $this->messenger = $messenger;
    parent::__construct($configuration, $plugin_id, $plugin_definition);
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($configuration, $plugin_id, $plugin_definition, $container
      ->get('messenger'));
  }

  /**
   * {@inheritdoc}
   */
  protected static function prepareTarget(FieldDefinitionInterface $field_definition) {
    return FieldTargetDefinition::createFromFieldDefinition($field_definition)
      ->addProperty('lat')
      ->addProperty('lon')
      ->addProperty('value');
  }

  /**
   * {@inheritdoc}
   */
  protected function prepareValues(array $values) {
    $results = [];
    $coordinates = [];
    foreach ($values as $delta => $columns) {
      try {
        $this
          ->prepareValue($delta, $columns);
        foreach ($columns as $column => $value) {

          // Add Lat/Lon Coordinates.
          if (in_array($column, [
            'lat',
            'lon',
          ])) {
            foreach ($value as $item) {
              $coordinates[$column][] = $item;
            }
          }

          // Raw Geometry value (i.e. WKT or GeoJson).
          if ($column == 'value') {
            $results[]['value'] = $value;
          }
        }
      } catch (EmptyFeedException $e) {
        $this->messenger
          ->addError($e
          ->getMessage());
        return FALSE;
      }
    }

    // Transform Lat/Lon Coordinates couples into WKT Points.
    if (!empty($coordinates)) {
      $count_of_coordinates = count($coordinates['lat']);
      for ($i = 0; $i < $count_of_coordinates; $i++) {
        $results[]['value'] = "POINT (" . $coordinates['lon'][$i] . " " . $coordinates['lat'][$i] . ")";
      }
    }
    return $results;
  }

  /**
   * {@inheritdoc}
   */
  protected function prepareValue($delta, array &$values) {

    // Here is been preparing values for Lat/Lon coordinates.
    foreach ($values as $column => $value) {
      if (in_array($column, [
        'lat',
        'lon',
      ])) {
        $separated_coordinates = explode(" ", $value);
        $values[$column] = [];
        foreach ($separated_coordinates as $coordinate) {
          $values[$column][] = (double) $coordinate;
        }
      }
    }

    // Latitude and Longitude should be a pair, if not throw EmptyFeedException.
    if (count($values['lat']) != count($values['lon'])) {
      throw new EmptyFeedException('Latitude and Longitude should be a pair. Change your file and import again.');
    }
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ConfigurablePluginBase::validateConfigurationForm public function Form validation handler. Overrides PluginFormInterface::validateConfigurationForm
DependencySerializationTrait::$_entityStorages protected property An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds protected property An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep public function 1
DependencySerializationTrait::__wakeup public function 2
DependencyTrait::$dependencies protected property The object's dependencies.
DependencyTrait::addDependencies protected function Adds multiple dependencies.
DependencyTrait::addDependency protected function Adds a dependency.
FieldTargetBase::$fieldSettings protected property The field settings.
FieldTargetBase::$languageManager protected property The language manager.
FieldTargetBase::addMessage protected function Adds a message.
FieldTargetBase::buildConfigurationForm public function Form constructor. Overrides TargetBase::buildConfigurationForm 6
FieldTargetBase::calculateDependencies public function Calculates dependencies for the configured plugin. Overrides PluginBase::calculateDependencies
FieldTargetBase::defaultConfiguration public function Gets default configuration for this plugin. Overrides TargetBase::defaultConfiguration 6
FieldTargetBase::getEntityTarget public function Get entity, or entity translation to set the map.
FieldTargetBase::getLangcode public function Gets the configured language. Overrides TranslatableTargetInterface::getLangcode
FieldTargetBase::getLanguageManager protected function Gets the language manager.
FieldTargetBase::getMessenger protected function Returns the messenger to use.
FieldTargetBase::getSummary public function Returns the summary for a target. Overrides ConfigurableTargetInterface::getSummary 6
FieldTargetBase::getUniqueQuery protected function Constructs a base query which is used to find an existing entity.
FieldTargetBase::getUniqueValue public function Looks for an existing entity and returns an entity ID if found.
FieldTargetBase::isEmpty public function Returns if the value for the target is empty. Overrides TargetInterface::isEmpty
FieldTargetBase::isMutable public function Returns if the target is mutable. Overrides TargetInterface::isMutable 1
FieldTargetBase::isTargetFieldTranslatable protected function Checks if the targeted field is translatable.
FieldTargetBase::isTargetTranslatable public function Checks if the target is translatable. Overrides TranslatableTargetInterface::isTargetTranslatable
FieldTargetBase::languageExists public function Checks if the language selected on the target exists. Overrides TranslatableTargetInterface::languageExists
FieldTargetBase::onDependencyRemoval public function Allows a plugin to define whether it should be removed. Overrides TargetBase::onDependencyRemoval
FieldTargetBase::setLanguageManager public function Sets the language manager.
FieldTargetBase::setTarget public function Sets the values on an object. Overrides TargetInterface::setTarget 4
FieldTargetBase::targets public static function Returns the targets defined by this plugin. Overrides TargetInterface::targets 1
Geofield::$messenger protected property The messenger. Overrides MessengerTrait::$messenger
Geofield::$settings protected property The Settings object or array.
Geofield::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
Geofield::prepareTarget protected static function Prepares a target definition. Overrides FieldTargetBase::prepareTarget
Geofield::prepareValue protected function Prepares a single value. Overrides FieldTargetBase::prepareValue
Geofield::prepareValues protected function Prepares the the values that will be mapped to an entity. Overrides FieldTargetBase::prepareValues
Geofield::__construct public function Constructs a Geofield FeedsTarget object. Overrides FieldTargetBase::__construct
MessengerTrait::messenger public function Gets the messenger. 29
MessengerTrait::setMessenger public function Sets the messenger.
PluginBase::$configuration protected property Configuration information passed into the plugin. 1
PluginBase::$feedType protected property The importer this plugin is working for.
PluginBase::$linkGenerator protected property The link generator.
PluginBase::$pluginDefinition protected property The plugin implementation definition. 1
PluginBase::$pluginId protected property The plugin_id.
PluginBase::$urlGenerator protected property The url generator.
PluginBase::container private function Returns the service container.
PluginBase::defaultFeedConfiguration public function Returns default feed configuration. Overrides FeedsPluginInterface::defaultFeedConfiguration 3
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::getConfiguration public function Gets this plugin's configuration. Overrides ConfigurableInterface::getConfiguration
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 3
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::l protected function Renders a link to a route given a route name and its parameters.
PluginBase::linkGenerator protected function Returns the link generator service.
PluginBase::onFeedDeleteMultiple public function A feed is being deleted. 3
PluginBase::onFeedSave public function A feed is being saved.
PluginBase::onFeedTypeDelete public function The feed type is being deleted. 1
PluginBase::onFeedTypeSave public function The feed type is being saved. 1
PluginBase::pluginType public function Returns the type of plugin. Overrides FeedsPluginInterface::pluginType
PluginBase::setConfiguration public function Sets the configuration for this plugin instance. Overrides ConfigurableInterface::setConfiguration 1
PluginBase::url protected function Generates a URL or path for a specific route based on the given parameters.
PluginBase::urlGenerator protected function Returns the URL generator service.
StringTranslationTrait::$stringTranslation protected property The string translation service. 1
StringTranslationTrait::formatPlural protected function Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals protected function Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation protected function Gets the string translation service.
StringTranslationTrait::setStringTranslation public function Sets the string translation service to use. 2
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.
TargetBase::$targetDefinition protected property The target definition.
TargetBase::getTargetDefinition public function Returns the target's definition. Overrides TargetInterface::getTargetDefinition
TargetBase::submitConfigurationForm public function Form submission handler. Overrides ConfigurablePluginBase::submitConfigurationForm