class PhotosImage in Album Photos 8.5

Photos image migration destination.

Plugin annotation

@MigrateDestination(
  id = "d7_photos_image",
  destination_module = "photos"
)

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
    • class \Drupal\migrate\Plugin\migrate\destination\DestinationBase implements MigrateDestinationInterface, RequirementsInterface
      • class \Drupal\photos\Plugin\migrate\destination\PhotosImage implements ContainerFactoryPluginInterface

File

src/Plugin/migrate/destination/PhotosImage.php, line 27

Namespace

Drupal\photos\Plugin\migrate\destination

class PhotosImage extends DestinationBase implements ContainerFactoryPluginInterface {

  /**
   * The database connection.
   *
   * @var \Drupal\Core\Database\Connection
   */
  protected $connection;

  /**
   * The entity manager.
   *
   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
   */
  protected $entityTypeManager;

  /**
   * The image factory service.
   *
   * @var \Drupal\Core\Image\ImageFactory
   */
  protected $imageFactory;

  /**
   * The photos upload handler.
   *
   * @var \Drupal\photos\PhotosUploadInterface
   */
  protected $photosUpload;

  /**
   * The time service.
   *
   * @var \Drupal\Component\Datetime\TimeInterface
   */
  protected $time;

  /**
   * Constructs a PhotosImage object.
   *
   * @param array $configuration
   *   Plugin configuration.
   * @param string $plugin_id
   *   The plugin ID.
   * @param mixed $plugin_definition
   *   The plugin definition.
   * @param \Drupal\migrate\Plugin\MigrationInterface $migration
   *   The current migration.
   * @param \Drupal\Core\Database\Connection $connection
   *   The database connection.
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_manager
   *   The entity manager service.
   * @param \Drupal\Core\Image\ImageFactory $image_factory
   *   The image factory service.
   * @param \Drupal\photos\PhotosUploadInterface $photos_upload
   *   The photos upload service.
   * @param \Drupal\Component\Datetime\TimeInterface $time
   *   The time service.
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, MigrationInterface $migration, Connection $connection, EntityTypeManagerInterface $entity_manager, ImageFactory $image_factory, PhotosUploadInterface $photos_upload, TimeInterface $time) {
    parent::__construct($configuration, $plugin_id, $plugin_definition, $migration);
    $this->connection = $connection;
    $this->entityTypeManager = $entity_manager;
    $this->imageFactory = $image_factory;
    $this->photosUpload = $photos_upload;
    $this->time = $time;
  }

  /**
   * {@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, $container
      ->get('database'), $container
      ->get('entity_type.manager'), $container
      ->get('image.factory'), $container
      ->get('photos.upload'), $container
      ->get('datetime.time'));
  }

  /**
   * {@inheritdoc}
   */
  public function import(Row $row, array $old_destination_id_values = []) {
    $title = $row
      ->getDestinationProperty('title');
    $fid = $row
      ->getDestinationProperty('fid');
    try {

      /* @var \Drupal\file\Entity\File $file */
      $file = $this->entityTypeManager
        ->getStorage('file')
        ->load($fid);
      $image = $this->imageFactory
        ->get($file
        ->getFileUri());
      if ($image) {
        if (empty($title)) {

          // @note known issue: title can not be null.
          $title = $this->photosUpload
            ->cleanTitle($file
            ->getFilename());
        }
        try {

          // Create new photos_image entity.
          $photosImage = $this->entityTypeManager
            ->getStorage('photos_image')
            ->create([
            'album_id' => $row
              ->getDestinationProperty('pid'),
            'title' => $title,
            'weight' => $row
              ->getDestinationProperty('wid'),
            'description' => $row
              ->getDestinationProperty('des'),
            'field_image' => [
              'target_id' => $fid,
              'alt' => $title,
              'title' => $title,
              'width' => $image
                ->getWidth(),
              'height' => $image
                ->getHeight(),
            ],
          ]);
          try {
            $photosImage
              ->save();
            if ($photosImage) {
              try {

                // Move image views to the {photos_count} table.
                $this->connection
                  ->insert('photos_count')
                  ->fields([
                  'cid' => $photosImage
                    ->id(),
                  'changed' => $this->time
                    ->getRequestTime(),
                  'type' => 'image_views',
                  'value' => $row
                    ->getDestinationProperty('count'),
                ])
                  ->execute();
              } catch (\Exception $e) {
                watchdog_exception('photos', $e);
              }

              // Successfully created new photos_image entity.
              return [
                $photosImage
                  ->id(),
              ];
            }
          } catch (EntityStorageException $e) {
            watchdog_exception('photos', $e);
          }
        } catch (InvalidPluginDefinitionException $e) {
          watchdog_exception('photos', $e);
        } catch (PluginNotFoundException $e) {
          watchdog_exception('photos', $e);
        }
      }
    } catch (InvalidPluginDefinitionException $e) {
      watchdog_exception('photos', $e);
    } catch (PluginNotFoundException $e) {
      watchdog_exception('photos', $e);
    }

    // Something was missing.
    return [];
  }

  /**
   * {@inheritdoc}
   */
  public function getIds() {
    $ids['id']['type'] = 'integer';
    return $ids;
  }

  /**
   * {@inheritdoc}
   */
  public function fields(MigrationInterface $migration = NULL) {
    return [
      'target_id' => $this
        ->t('Image file ID'),
      'album_id' => $this
        ->t('Photos Album node ID'),
      'title' => $this
        ->t('Image title'),
      'description' => $this
        ->t('Image description'),
      'weight' => $this
        ->t('Weight'),
      'value' => $this
        ->t('Image views count'),
    ];
  }

}

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
DestinationBase::$migration	protected	property	The migration.
DestinationBase::$rollbackAction	protected	property	The rollback action to be saved for the last imported item.
DestinationBase::$supportsRollback	protected	property	Indicates whether the destination can be rolled back.
DestinationBase::checkRequirements	public	function	Checks if requirements for this plugin are OK. Overrides RequirementsInterface::checkRequirements
DestinationBase::getDestinationModule	public	function	Gets the destination module handling the destination data. Overrides MigrateDestinationInterface::getDestinationModule	1
DestinationBase::rollback	public	function	Delete the specified destination object from the target Drupal. Overrides MigrateDestinationInterface::rollback	2
DestinationBase::rollbackAction	public	function	The rollback action for the last imported item. Overrides MigrateDestinationInterface::rollbackAction
DestinationBase::setRollbackAction	protected	function	For a destination item being updated, set the appropriate rollback action.
DestinationBase::supportsRollback	public	function	Whether the destination can be rolled back or not. Overrides MigrateDestinationInterface::supportsRollback
MessengerTrait::$messenger	protected	property	The messenger.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
MessengerTrait::setMessenger	public	function	Sets the messenger.
PhotosImage::$connection	protected	property	The database connection.
PhotosImage::$entityTypeManager	protected	property	The entity manager.
PhotosImage::$imageFactory	protected	property	The image factory service.
PhotosImage::$photosUpload	protected	property	The photos upload handler.
PhotosImage::$time	protected	property	The time service.
PhotosImage::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
PhotosImage::fields	public	function	Returns an array of destination fields. Overrides MigrateDestinationInterface::fields
PhotosImage::getIds	public	function	Gets the destination IDs. Overrides MigrateDestinationInterface::getIds
PhotosImage::import	public	function	Import the row. Overrides MigrateDestinationInterface::import
PhotosImage::__construct	public	function	Constructs a PhotosImage object. Overrides DestinationBase::__construct
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.
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.