EntityExists.php

Same filename in other branches
  1. 9 core/modules/migrate/src/Plugin/migrate/process/EntityExists.php
  2. 10 core/modules/migrate/src/Plugin/migrate/process/EntityExists.php
  3. 11.x core/modules/migrate/src/Plugin/migrate/process/EntityExists.php

Namespace

Drupal\migrate\Plugin\migrate\process

File

core/modules/migrate/src/Plugin/migrate/process/EntityExists.php

View source
<?php

namespace Drupal\migrate\Plugin\migrate\process;

use Drupal\Core\Entity\EntityInterface;
use Drupal\Core\Entity\EntityStorageInterface;
use Drupal\Core\Plugin\ContainerFactoryPluginInterface;
use Drupal\migrate\Plugin\MigrationInterface;
use Drupal\migrate\MigrateExecutableInterface;
use Drupal\migrate\ProcessPluginBase;
use Drupal\migrate\Row;
use Symfony\Component\DependencyInjection\ContainerInterface;

/**
 * This plugin checks if a given entity exists.
 *
 * Example usage with configuration:
 * @code
 *   field_tags:
 *     plugin: entity_exists
 *     source: tid
 *     entity_type: taxonomy_term
 * @endcode
 *
 * @MigrateProcessPlugin(
 *  id = "entity_exists"
 * )
 */
class EntityExists extends ProcessPluginBase implements ContainerFactoryPluginInterface {
    
    /**
     * The entity storage.
     *
     * @var \Drupal\Core\Entity\EntityStorageInterface
     */
    protected $storage;
    
    /**
     * EntityExists constructor.
     *
     * @param array $configuration
     *   A configuration array containing information about the plugin instance.
     * @param string $plugin_id
     *   The plugin ID.
     * @param mixed $plugin_definition
     *   The plugin implementation definition.
     * @param $storage
     *   The entity storage.
     */
    public function __construct(array $configuration, $plugin_id, $plugin_definition, EntityStorageInterface $storage) {
        parent::__construct($configuration, $plugin_id, $plugin_definition);
        $this->storage = $storage;
    }
    
    /**
     * {@inheritdoc}
     */
    public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition, MigrationInterface $migration = NULL) {
        return new static($configuration, $plugin_id, $plugin_definition, $container->get('entity_type.manager')
            ->getStorage($configuration['entity_type']));
    }
    
    /**
     * {@inheritdoc}
     */
    public function transform($value, MigrateExecutableInterface $migrate_executable, Row $row, $destination_property) {
        if (is_array($value)) {
            $value = reset($value);
        }
        $entity = $this->storage
            ->load($value);
        if ($entity instanceof EntityInterface) {
            return $entity->id();
        }
        return FALSE;
    }

}

Classes

Title Deprecated Summary
EntityExists This plugin checks if a given entity exists.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.