class File in Drupal 10

Drupal 6 file source from database.

Plugin annotation

@MigrateSource(
  id = "d6_file",
  source_module = "system"
)

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
    • class \Drupal\migrate\Plugin\migrate\source\SourcePluginBase implements RollbackAwareInterface, MigrateSourceInterface
      • class \Drupal\migrate\Plugin\migrate\source\SqlBase implements ContainerFactoryPluginInterface, RequirementsInterface
        • class \Drupal\migrate_drupal\Plugin\migrate\source\DrupalSqlBase implements DependentPluginInterface uses DependencyTrait
          • class \Drupal\file\Plugin\migrate\source\d6\File

19 string references to 'File'

ConfigTest::provideGetMessageText in core/tests/Drupal/Tests/Composer/Plugin/ProjectMessage/ConfigTest.php

DirectoryTest::testFileCheckDirectoryHandling in core/tests/Drupal/KernelTests/Core/File/DirectoryTest.php

Tests directory handling functions.

DirectoryTest::testFileCheckLocalDirectoryHandling in core/tests/Drupal/KernelTests/Core/File/DirectoryTest.php

Tests local directory handling functions.

drupal6.php in core/modules/migrate_drupal/tests/fixtures/drupal6.php

A database agnostic dump for testing purposes.

file.info.yml in core/modules/file/file.info.yml

core/modules/file/file.info.yml

... See full list

File

core/modules/file/src/Plugin/migrate/source/d6/File.php, line 16

Namespace

Drupal\file\Plugin\migrate\source\d6

class File extends DrupalSqlBase {

  /**
   * The file directory path.
   *
   * @var string
   */
  protected $filePath;

  /**
   * The temporary file path.
   *
   * @var string
   */
  protected $tempFilePath;

  /**
   * Flag for private or public file storage.
   *
   * @var bool
   */
  protected $isPublic;

  /**
   * {@inheritdoc}
   */
  public function query() {
    return $this
      ->select('files', 'f')
      ->fields('f')
      ->condition('f.filepath', '/tmp%', 'NOT LIKE')
      ->orderBy('f.timestamp')
      ->orderBy('f.fid');
  }

  /**
   * {@inheritdoc}
   */
  protected function initializeIterator() {
    $site_path = $this->configuration['site_path'] ?? 'sites/default';
    $this->filePath = $this
      ->variableGet('file_directory_path', $site_path . '/files') . '/';
    $this->tempFilePath = $this
      ->variableGet('file_directory_temp', '/tmp') . '/';

    // FILE_DOWNLOADS_PUBLIC == 1 and FILE_DOWNLOADS_PRIVATE == 2.
    $this->isPublic = $this
      ->variableGet('file_downloads', 1) == 1;
    return parent::initializeIterator();
  }

  /**
   * {@inheritdoc}
   */
  public function prepareRow(Row $row) {
    $row
      ->setSourceProperty('file_directory_path', $this->filePath);
    $row
      ->setSourceProperty('temp_directory_path', $this->tempFilePath);
    $row
      ->setSourceProperty('is_public', $this->isPublic);
    return parent::prepareRow($row);
  }

  /**
   * {@inheritdoc}
   */
  public function fields() {
    return [
      'fid' => $this
        ->t('File ID'),
      'uid' => $this
        ->t('The {users}.uid who added the file. If set to 0, this file was added by an anonymous user.'),
      'filename' => $this
        ->t('File name'),
      'filepath' => $this
        ->t('File path'),
      'filemime' => $this
        ->t('File MIME Type'),
      'status' => $this
        ->t('The published status of a file.'),
      'timestamp' => $this
        ->t('The time that the file was added.'),
      'file_directory_path' => $this
        ->t('The Drupal files path.'),
      'is_public' => $this
        ->t('TRUE if the files directory is public otherwise FALSE.'),
    ];
  }

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

}

Members

Name	Modifiers	Type	Description	Overrides
DependencySerializationTrait::$_entityStorages	protected	property
DependencySerializationTrait::$_serviceIds	protected	property
DependencySerializationTrait::__wakeup	public	function		2
DependencyTrait::$dependencies	protected	property	The object's dependencies.
DependencyTrait::addDependencies	protected	function	Adds multiple dependencies.
DependencyTrait::addDependency	protected	function	Adds a dependency.
DrupalSqlBase::$entityTypeManager	protected	property	The entity type manager.
DrupalSqlBase::$requirements	protected	property	If the source provider is missing.
DrupalSqlBase::$systemData	protected	property	The contents of the system table.
DrupalSqlBase::calculateDependencies	public	function	Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies
DrupalSqlBase::checkRequirements	public	function	Checks if requirements for this plugin are OK. Overrides SqlBase::checkRequirements	4
DrupalSqlBase::create	public static	function	Creates an instance of the plugin. Overrides SqlBase::create	2
DrupalSqlBase::getModuleSchemaVersion	protected	function	Retrieves a module schema_version from the source Drupal database.
DrupalSqlBase::getSystemData	public	function	Retrieves all system data information from the source Drupal database.
DrupalSqlBase::moduleExists	protected	function	Checks if a given module is enabled in the source Drupal database.
DrupalSqlBase::variableGet	protected	function	Reads a variable from a source Drupal database.
DrupalSqlBase::__construct	public	function	Constructs a \Drupal\Component\Plugin\PluginBase object. Overrides SqlBase::__construct	5
File::$filePath	protected	property	The file directory path.
File::$isPublic	protected	property	Flag for private or public file storage.
File::$tempFilePath	protected	property	The temporary file path.
File::fields	public	function	Returns available fields on the source. Overrides MigrateSourceInterface::fields
File::getIds	public	function	Defines the source fields uniquely identifying a source row. Overrides MigrateSourceInterface::getIds
File::initializeIterator	protected	function	Initializes the iterator with the source data. Overrides SqlBase::initializeIterator
File::prepareRow	public	function	Adds additional data to the row. Overrides SourcePluginBase::prepareRow
File::query	public	function	Overrides SqlBase::query
MessengerTrait::$messenger	protected	property	The messenger.	18
MessengerTrait::messenger	public	function	Gets the messenger.	18
MessengerTrait::setMessenger	public	function	Sets the messenger.
MigrateSourceInterface::NOT_COUNTABLE		constant	Indicates that the source is not countable.
PluginBase::$configuration	protected	property	Configuration information passed into the plugin.	1
PluginBase::$pluginDefinition	protected	property	The plugin implementation definition.
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
PluginBase::getDerivativeId	public	function
PluginBase::getPluginDefinition	public	function		2
PluginBase::getPluginId	public	function
PluginBase::isConfigurable	public	function	Determines if the plugin is configurable.
SourcePluginBase::$cache	protected	property	The backend cache.
SourcePluginBase::$cacheCounts	protected	property	Whether this instance should cache the source count.	1
SourcePluginBase::$cacheKey	protected	property	Key to use for caching counts.
SourcePluginBase::$currentRow	protected	property	The current row from the query.
SourcePluginBase::$currentSourceIds	protected	property	The primary key of the current row.
SourcePluginBase::$highWaterProperty	protected	property	Information on the property used as the high-water mark.
SourcePluginBase::$highWaterStorage	protected	property	The key-value storage for the high-water value.
SourcePluginBase::$idMap	protected	property	The migration ID map.
SourcePluginBase::$iterator	protected	property	The iterator to iterate over the source rows.
SourcePluginBase::$mapRowAdded	protected	property	Flags whether source plugin will read the map row and add to data row.
SourcePluginBase::$migration	protected	property	The entity migration object.
SourcePluginBase::$moduleHandler	protected	property	The module handler service.	2
SourcePluginBase::$originalHighWater	protected	property	The high water mark at the beginning of the import operation.
SourcePluginBase::$skipCount	protected	property	Whether this instance should not attempt to count the source.	1
SourcePluginBase::$trackChanges	protected	property	Flags whether to track changes to incoming data.	1
SourcePluginBase::aboveHighWater	protected	function	Check if the incoming data is newer than what we've previously imported.
SourcePluginBase::count	public	function		2
SourcePluginBase::current	public	function
SourcePluginBase::getCache	protected	function	Gets the cache object.
SourcePluginBase::getCurrentIds	public	function	Gets the currentSourceIds data member.
SourcePluginBase::getHighWater	protected	function	The current value of the high water mark.
SourcePluginBase::getHighWaterField	protected	function	Get the name of the field used as the high watermark.
SourcePluginBase::getHighWaterProperty	protected	function	Get information on the property used as the high watermark.
SourcePluginBase::getHighWaterStorage	protected	function	Get the high water storage object.
SourcePluginBase::getIterator	protected	function	Returns the iterator that will yield the row arrays to be processed.
SourcePluginBase::getModuleHandler	protected	function	Gets the module handler.
SourcePluginBase::getSourceModule	public	function	Gets the source module providing the source data. Overrides MigrateSourceInterface::getSourceModule
SourcePluginBase::key	public	function
SourcePluginBase::next	public	function
SourcePluginBase::postRollback	public	function	Performs post-rollback tasks. Overrides RollbackAwareInterface::postRollback
SourcePluginBase::preRollback	public	function	Performs pre-rollback tasks. Overrides RollbackAwareInterface::preRollback
SourcePluginBase::rewind	public	function
SourcePluginBase::rowChanged	protected	function	Checks if the incoming row has changed since our last import.
SourcePluginBase::saveHighWater	protected	function	Save the new high water mark.
SourcePluginBase::valid	public	function
SqlBase::$batch	protected	property	The count of the number of batches run.
SqlBase::$batchSize	protected	property	Number of records to fetch from the database during each batch.
SqlBase::$database	protected	property	The database object.	1
SqlBase::$query	protected	property	The query string.	82
SqlBase::$state	protected	property	State service for retrieving database info.
SqlBase::doCount	protected	function	Gets the source count using countQuery(). Overrides SourcePluginBase::doCount	6
SqlBase::fetchNextBatch	protected	function	Prepares query for the next set of data from the source database.
SqlBase::fetchNextRow	protected	function	Position the iterator to the following row. Overrides SourcePluginBase::fetchNextRow
SqlBase::getDatabase	public	function	Gets the database connection object.	2
SqlBase::mapJoinable	protected	function	Checks if we can join against the map table.	1
SqlBase::prepareQuery	protected	function	Adds tags and metadata to the query.
SqlBase::select	protected	function	Wrapper for database select.
SqlBase::setUpDatabase	protected	function	Gets a connection to the referenced database.
SqlBase::__sleep	public	function	Overrides DependencySerializationTrait::__sleep
SqlBase::__toString	public	function	Prints the query string when the object is used as a string. Overrides MigrateSourceInterface::__toString
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	3
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.	1
StringTranslationTrait::t	protected	function	Translates a string to the current language or to a given language.