class LocationToGeolocation in Geolocation Field 8.3

Process plugin that converts D7 location field values to D8|D9 geolocation.

Plugin annotation

@MigrateProcessPlugin(
  id = "location_to_geolocation"
)

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
    • class \Drupal\migrate\ProcessPluginBase implements MigrateProcessInterface
      • class \Drupal\geolocation\Plugin\migrate\process\LocationToGeolocation implements ContainerFactoryPluginInterface

File

src/Plugin/migrate/process/LocationToGeolocation.php, line 21

Namespace

Drupal\geolocation\Plugin\migrate\process

class LocationToGeolocation extends ProcessPluginBase implements ContainerFactoryPluginInterface {

  /**
   * The migration entity.
   *
   * @var \Drupal\migrate\Plugin\MigrationInterface
   */
  protected $migration;

  /**
   * Constructs a new selection 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 mixed $plugin_definition
   *   The plugin implementation definition.
   * @param \Drupal\migrate\Plugin\MigrationInterface $migration
   *   The migration entity.
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, MigrationInterface $migration) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->migration = $migration;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition, MigrationInterface $migration = NULL) {
    return new static($configuration, $plugin_id, $plugin_definition, $migration);
  }

  /**
   * {@inheritdoc}
   */
  public function transform($value, MigrateExecutableInterface $migrate_executable, Row $row, $destination_property) {
    if (!is_array($value) || empty($value['lid'])) {

      // Empty field value.
      return NULL;
    }
    $source_plugin = $this->migration
      ->getSourcePlugin();
    assert($source_plugin instanceof DrupalSqlBase);
    $source_database = $source_plugin
      ->getDatabase();
    try {
      $location_result = $source_database
        ->select('location', 'l')
        ->fields('l')
        ->condition('l.lid', $value['lid'])
        ->execute()
        ->fetchAllAssoc('lid', \PDO::FETCH_ASSOC);
      if (count($location_result) === 1) {
        $location_raw = reset($location_result);
        [
          'latitude' => $lat,
          'longitude' => $lng,
        ] = $location_raw;

        // The "0.000000" values are the default values in Drupal 7, but that's
        // also a valid coordinate. Anyway, let's assume that it means the field
        // is empty.
        return (string) $lat !== '0.000000' && (string) $lng !== '0.000000' ? [
          'lat' => $lat,
          'lng' => $lng,
        ] : NULL;
      }
    } catch (DatabaseExceptionWrapper $e) {
    }
    return NULL;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
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
LocationToGeolocation::$migration	protected	property	The migration entity.
LocationToGeolocation::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
LocationToGeolocation::transform	public	function	Performs the associated process. Overrides ProcessPluginBase::transform
LocationToGeolocation::__construct	public	function	Constructs a new selection object. Overrides PluginBase::__construct
MessengerTrait::$messenger	protected	property	The messenger.	29
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::$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	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.
ProcessPluginBase::multiple	public	function	Indicates whether the returned value requires multiple handling. Overrides MigrateProcessInterface::multiple	3
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.