You are here

D7FlagForList.php in Flag Lists 8

Same filename and directory in other branches
  1. 4.0.x src/Plugin/migrate/source/D7FlagForList.php

File

src/Plugin/migrate/source/D7FlagForList.php
View source
<?php

namespace Drupal\flag_lists\Plugin\migrate\source;

use Drupal\migrate\Plugin\migrate\source\SqlBase;
use Drupal\migrate\Row;
use Drupal\user\Entity\User;

/**
 * Minimalistic example for a SqlBase source plugin.
 *
 * @MigrateSource(
 *   id = "d7_flag_for_list",
 *   source_module = "flag_lists",
 * )
 */
class D7FlagForList extends SqlBase {

  /**
   * {@inheritdoc}
   */
  public function query() {

    // Source data is queried from 'flag_lists_flags' table.
    $query = $this
      ->select('flag_lists_flags', 'c');
    $query
      ->join('flag', 'f', 'c.pfid = f.fid');
    $query
      ->fields('c', [
      'fid',
      'pfid',
      'uid',
      'entity_type',
      'options',
    ])
      ->fields('f', [
      'name',
      'title',
    ]);
    return $query;
  }

  /**
   * {@inheritdoc}
   */
  public function fields() {
    $fields = [
      'fid' => $this
        ->t('Flag List #'),
      'pfid' => $this
        ->t('Parent flag id #'),
      'uid' => $this
        ->t('Owner'),
      'entity_type' => $this
        ->t('Entity type'),
      'name' => $this
        ->t('Machine name of this flag list'),
      'label' => $this
        ->t('Label fof flag'),
      'title' => $this
        ->t('Name of flag template'),
      'option' => $this
        ->t('Serielized info'),
    ];
    return $fields;
  }

  /**
   * {@inheritdoc}
   */
  public function getIds() {
    return [
      'fid' => [
        'type' => 'integer',
        'alias' => 'c',
      ],
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function prepareRow(Row $row) {

    // Check and get the user name.
    $uid = $row
      ->getSourceProperty('uid');
    $user = User::load($uid);
    if (!empty($user)) {
      $owner = $user
        ->get('name')->value;
    }
    else {
      $user = User::load('1');
      $owner = $user
        ->get('name')->value;
    }
    $row
      ->setSourceProperty('uid', $owner);

    // Check if the template flag exist.
    $found = FALSE;
    $flagService = \Drupal::service('flag');
    $templateFlags = $flagService
      ->getAllFlags($row
      ->getSourceProperty('entity_type'));
    foreach ($templateFlags as $flag) {
      if ($found = $flag
        ->get('id') == $row
        ->getSourceProperty('name')) {
        break;
      }
    }
    if (!$found) {
      $message = $this
        ->t('The template flag "@flag" wasn\'t found.', [
        '@flag' => $row
          ->getSourceProperty('title'),
      ]);
      $messenger = \Drupal::messenger();
      $logger = \Drupal::logger('flag_lists');
      $messenger
        ->addWarning($message);
      $logger
        ->warning($message);
    }
    return parent::prepareRow($row);
  }

}

Classes

Namesort descending Description
D7FlagForList Minimalistic example for a SqlBase source plugin.