Chris@0: <?php
Chris@0: 
Chris@0: /**
Chris@0:  * @file
Chris@0:  * Contains Drupal\migrate_plus\Plugin\migrate\process\EntityGenerate.
Chris@0:  */
Chris@0: 
Chris@0: namespace Drupal\migrate_plus\Plugin\migrate\process;
Chris@0: 
Chris@0: use Drupal\migrate\MigrateExecutableInterface;
Chris@0: use Drupal\migrate\Row;
Chris@0: 
Chris@0: /**
Chris@0:  * This plugin generates entity stubs.
Chris@0:  *
Chris@0:  * @MigrateProcessPlugin(
Chris@0:  *   id = "entity_generate"
Chris@0:  * )
Chris@0:  *
Chris@0:  * @see EntityLookup
Chris@0:  *
Chris@0:  * All the configuration from the lookup plugin applies here. In it's most
Chris@0:  * simple form, this plugin needs no configuration. If there are fields on the
Chris@0:  * stub entity that are required or need some default value, that can be
Chris@0:  * provided via a default_values configuration option.
Chris@0:  *
Chris@0:  * Example usage with default_values configuration:
Chris@0:  * @code
Chris@0:  * destination:
Chris@0:  *   plugin: 'entity:node'
Chris@0:  * process:
Chris@0:  *   type:
Chris@0:  *     plugin: default_value
Chris@0:  *     default_value: page
Chris@0:  *   field_tags:
Chris@0:  *     plugin: entity_generate
Chris@0:  *     source: tags
Chris@0:  *     default_values:
Chris@0:  *       description: Stub description
Chris@0:  *       field_long_description: Stub long description
Chris@0:  * @endcode
Chris@0:  */
Chris@0: class EntityGenerate extends EntityLookup {
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public function transform($value, MigrateExecutableInterface $migrateExecutable, Row $row, $destinationProperty) {
Chris@0:     // Creates a stub entity if one doesn't exist.
Chris@0:     if (!($result = parent::transform($value, $migrateExecutable, $row, $destinationProperty))) {
Chris@0:       $result = $this->generateEntity($value);
Chris@0:     }
Chris@0: 
Chris@0:     return $result;
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * Generates stub entity for a given value.
Chris@0:    *
Chris@0:    * @param string $value
Chris@0:    *   Value to use in creation of stub entity.
Chris@0:    *
Chris@0:    * @return int|string
Chris@0:    *   The entity id of the generated entity.
Chris@0:    */
Chris@0:   protected function generateEntity($value) {
Chris@0:     if(!empty($value)) {
Chris@0:       $entity = $this->entityManager
Chris@0:         ->getStorage($this->lookupEntityType)
Chris@0:         ->create($this->stub($value));
Chris@0:       $entity->save();
Chris@0: 
Chris@0:       return $entity->id();
Chris@0:     }
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * Fabricate a stub entity.
Chris@0:    *
Chris@0:    * This is intended to be extended by implementing classes to provide for more
Chris@0:    * dynamic default values, rather than just static ones.
Chris@0:    *
Chris@0:    * @param $value
Chris@0:    *   Value to use in creation of stub entity.
Chris@0:    *
Chris@0:    * @return array
Chris@0:    *   The stub entity.
Chris@0:    */
Chris@0:   protected function stub($value) {
Chris@0:     $stub = [$this->lookupValueKey => $value];
Chris@0: 
Chris@0:     if ($this->lookupBundleKey) {
Chris@0:       $stub[$this->lookupBundleKey] = $this->lookupBundle;
Chris@0:     }
Chris@0: 
Chris@0:     // Gather any static default values for properties/fields.
Chris@0:     if (isset($this->configuration['default_values']) && is_array($this->configuration['default_values'])) {
Chris@0:       foreach ($this->configuration['default_values'] as $key => $value) {
Chris@0:         $stub[$key] = $value;
Chris@0:       }
Chris@0:     }
Chris@0: 
Chris@0:     return $stub;
Chris@0:   }
Chris@0: 
Chris@0: }