class FileEntityFieldFormatter in Media Migration 8

Drupal 7 media field formatter settings source based on source database.

Plugin annotation

@MigrateSource(
  id = "d7_file_entity_field_formatter",
  source_module = "file_entity"
)

Hierarchy

• class \Drupal\media_migration\Plugin\migrate\source\d7\ConfigSourceBase extends \Drupal\media_migration\Plugin\migrate\source\d7\DrupalSqlBaseWithCountCompatibility uses MediaMigrationDatabaseTrait
  • class \Drupal\media_migration\Plugin\migrate\source\d7\FileEntityConfigSourceBase
    • class \Drupal\media_migration\Plugin\migrate\source\d7\FileEntityFieldFormatter

File

src/Plugin/migrate/source/d7/FileEntityFieldFormatter.php, line 15

Namespace

Drupal\media_migration\Plugin\migrate\source\d7

class FileEntityFieldFormatter extends FileEntityConfigSourceBase {

  /**
   * {@inheritdoc}
   */
  protected function initializeIterator() {

    // Media Migration wants to hide "created", "name", "thumbnail" and "uid"
    // base fields for the default view mode.
    // @see \Drupal\media\Entity\Media
    $iterator = parent::initializeIterator();
    $rows = [];
    foreach ($iterator
      ->getArrayCopy() as $item) {
      [
        'source_field_name' => $source_field_name,
      ] = $item;
      $field_names = [
        $source_field_name => FALSE,
        'created' => TRUE,
        'name' => TRUE,
        'thumbnail' => TRUE,
        'uid' => TRUE,
      ];
      foreach ($field_names as $field_name => $hidden) {
        $rows[] = [
          'field_name' => $field_name,
          'hidden' => $hidden,
        ] + $item;
      }
    }
    return new \ArrayIterator($rows);
  }

  /**
   * {@inheritdoc}
   */
  public function prepareRow(Row $row) {
    [
      'types' => $types,
      'schemes' => $schemes,
      'source_field_name' => $source_field_name,
      'field_name' => $field_name,
    ] = $row
      ->getSource();
    if ($field_name === $source_field_name) {
      $type = explode(static::MULTIPLE_SEPARATOR, $types)[0];
      $scheme = explode(static::MULTIPLE_SEPARATOR, $schemes)[0];
      if (!($dealer_plugin = $this->fileEntityDealerManager
        ->createInstanceFromTypeAndScheme($type, $scheme))) {
        return FALSE;
      }
      $dealer_plugin
        ->prepareMediaSourceFieldFormatterRow($row, $this
        ->getDatabase());
    }
    return parent::prepareRow($row);
  }

  /**
   * {@inheritdoc}
   */
  public function fields() {
    return [
      'field_name' => $this
        ->t('Name of the field.'),
      'options' => $this
        ->t('Configuration options of the source field widget.'),
      'hidden' => $this
        ->t('Whether the field is hidden or not.'),
    ] + parent::fields();
  }

  /**
   * {@inheritdoc}
   */
  public function getIds() {
    return [
      'field_name' => [
        'type' => 'string',
      ],
    ] + parent::getIds();
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ConfigSourceBase::MULTIPLE_SEPARATOR		constant
FileEntityConfigSourceBase::$fileEntityDealerManager	protected	property	The file entity dealer plugin manager.
FileEntityConfigSourceBase::create	public static	function
FileEntityConfigSourceBase::prepareQuery	protected	function
FileEntityConfigSourceBase::query	public	function		1
FileEntityConfigSourceBase::__construct	public	function	Constructs a plugin instance.
FileEntityFieldFormatter::fields	public	function	Overrides FileEntityConfigSourceBase::fields
FileEntityFieldFormatter::getIds	public	function	Overrides FileEntityConfigSourceBase::getIds
FileEntityFieldFormatter::initializeIterator	protected	function	Overrides FileEntityConfigSourceBase::initializeIterator
FileEntityFieldFormatter::prepareRow	public	function
MediaMigrationDatabaseTrait::getExtensionExpression	protected	function	Returns the file extension expression for the current DB.
MediaMigrationDatabaseTrait::getFileEntityBaseQuery	protected	function	Returns a base query for file entity types.
MediaMigrationDatabaseTrait::getFilePlainBaseQuery	protected	function	Returns a base query for plain files.
MediaMigrationDatabaseTrait::getMainMimeTypeExpression	protected	function	Returns the main MIME type's expression for the current DB.
MediaMigrationDatabaseTrait::getSchemeExpression	protected	function	Returns the expression for the DB for getting the URI scheme.
MediaMigrationDatabaseTrait::getUserPictureOnlyFidsQuery	protected	function	Returns the subquery for the user picture-only file IDs.
MediaMigrationDatabaseTrait::getWebformOrUserPictureOnlyFidsQuery	protected	function	Subquery for FIDs used only in webform submissions and/or by user entities.