class GatherContentFile in GatherContent 8.5

Perform custom value transformation.

@\Drupal\migrate\Annotation\MigrateProcessPlugin( id = "gather_content_file" )

file:
  plugin: gather_content_file
  source: file
  uri_scheme: string
  file_dir: string
  language: string

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\gathercontent\Plugin\migrate\process\GatherContentFile implements ContainerFactoryPluginInterface

File

src/Plugin/migrate/process/GatherContentFile.php, line 31

Namespace

Drupal\gathercontent\Plugin\migrate\process

class GatherContentFile extends ProcessPluginBase implements ContainerFactoryPluginInterface {

  /**
   * GatherContent client.
   *
   * @var \Drupal\gathercontent\DrupalGatherContentClient
   */
  protected $client;

  /**
   * File system service.
   *
   * @var \Drupal\Core\File\FileSystem
   */
  protected $fileSystem;

  /**
   * {@inheritdoc}
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, GatherContentClientInterface $client, FileSystem $fileSystem) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->client = $client;
    $this->fileSystem = $fileSystem;
  }

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

  /**
   * {@inheritdoc}
   */
  public function transform($value, MigrateExecutableInterface $migrate_executable, Row $row, $destination_property) {
    if (empty($value)) {
      return NULL;
    }
    $language = $this->configuration['language'];
    $fileDir = PlainTextOutput::renderFromHtml(\Drupal::token()
      ->replace($this->configuration['file_dir'], []));
    $createDir = $this->fileSystem
      ->realpath($this->configuration['uri_scheme']) . '/' . $fileDir;
    $this->fileSystem
      ->prepareDirectory($createDir, FileSystemInterface::CREATE_DIRECTORY);
    if (is_array($value)) {
      return $this->client
        ->downloadFiles($value, $this->configuration['uri_scheme'] . $fileDir, $language);
    }
    $fileId = $this->client
      ->downloadFiles([
      $value,
    ], $this->configuration['uri_scheme'] . $fileDir, $language);
    if (empty($fileId[0])) {
      return NULL;
    }
    $result['target_id'] = $fileId[0];
    if ($value->altText) {
      $result['alt'] = $value->altText;
    }
    return $result;
  }

}

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
GatherContentFile::$client	protected	property	GatherContent client.
GatherContentFile::$fileSystem	protected	property	File system service.
GatherContentFile::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
GatherContentFile::transform	public	function	Performs the associated process. Overrides ProcessPluginBase::transform
GatherContentFile::__construct	public	function	Constructs a \Drupal\Component\Plugin\PluginBase 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.