class File
Same name in this branch
- 11.x core/modules/media/src/Plugin/media/Source/File.php \Drupal\media\Plugin\media\Source\File
- 11.x core/modules/file/src/Entity/File.php \Drupal\file\Entity\File
- 11.x core/modules/file/src/Plugin/views/field/File.php \Drupal\file\Plugin\views\field\File
- 11.x core/modules/file/src/Plugin/views/wizard/File.php \Drupal\file\Plugin\views\wizard\File
- 11.x core/modules/file/src/Plugin/migrate/source/d7/File.php \Drupal\file\Plugin\migrate\source\d7\File
- 11.x core/lib/Drupal/Core/Render/Element/File.php \Drupal\Core\Render\Element\File
Same name and namespace in other branches
- 9 core/modules/media/src/Plugin/media/Source/File.php \Drupal\media\Plugin\media\Source\File
- 9 core/modules/file/src/Entity/File.php \Drupal\file\Entity\File
- 9 core/modules/file/src/Plugin/views/field/File.php \Drupal\file\Plugin\views\field\File
- 9 core/modules/file/src/Plugin/views/wizard/File.php \Drupal\file\Plugin\views\wizard\File
- 9 core/modules/file/src/Plugin/migrate/source/d6/File.php \Drupal\file\Plugin\migrate\source\d6\File
- 9 core/modules/file/src/Plugin/migrate/source/d7/File.php \Drupal\file\Plugin\migrate\source\d7\File
- 9 core/lib/Drupal/Core/Render/Element/File.php \Drupal\Core\Render\Element\File
- 8.9.x core/modules/media/src/Plugin/media/Source/File.php \Drupal\media\Plugin\media\Source\File
- 8.9.x core/modules/file/src/Entity/File.php \Drupal\file\Entity\File
- 8.9.x core/modules/file/src/Plugin/views/field/File.php \Drupal\file\Plugin\views\field\File
- 8.9.x core/modules/file/src/Plugin/views/wizard/File.php \Drupal\file\Plugin\views\wizard\File
- 8.9.x core/modules/file/src/Plugin/migrate/source/d6/File.php \Drupal\file\Plugin\migrate\source\d6\File
- 8.9.x core/modules/file/src/Plugin/migrate/source/d7/File.php \Drupal\file\Plugin\migrate\source\d7\File
- 8.9.x core/lib/Drupal/Core/Render/Element/File.php \Drupal\Core\Render\Element\File
- 10 core/modules/media/src/Plugin/media/Source/File.php \Drupal\media\Plugin\media\Source\File
- 10 core/modules/file/src/Entity/File.php \Drupal\file\Entity\File
- 10 core/modules/file/src/Plugin/views/field/File.php \Drupal\file\Plugin\views\field\File
- 10 core/modules/file/src/Plugin/views/wizard/File.php \Drupal\file\Plugin\views\wizard\File
- 10 core/modules/file/src/Plugin/migrate/source/d6/File.php \Drupal\file\Plugin\migrate\source\d6\File
- 10 core/modules/file/src/Plugin/migrate/source/d7/File.php \Drupal\file\Plugin\migrate\source\d7\File
- 10 core/lib/Drupal/Core/Render/Element/File.php \Drupal\Core\Render\Element\File
Drupal 6 file source from database.
Available configuration keys:
- site_path: (optional) The path to the site directory relative to Drupal root. Defaults to 'sites/default'. This value is ignored if the 'file_directory_path' variable is set in the source Drupal database.
Example:
source:
plugin: d6_file
site_path: sites/example
In this example, public file values are retrieved from the source database. The site path is specified because it's not the default one (sites/default). The final path to the public files will be "sites/example/files/", assuming the 'file_directory_path' variable is not set in the source database.
For complete example, refer to the d6_file.yml migration.
For additional configuration keys, refer to the parent classes.
Plugin annotation
@MigrateSource(
id = "d6_file",
source_module = "system"
)
Hierarchy
- class \Drupal\Component\Plugin\PluginBase extends \Drupal\Component\Plugin\PluginInspectionInterface, \Drupal\Component\Plugin\DerivativeInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait implements \Drupal\Component\Plugin\PluginBase
- class \Drupal\migrate\Plugin\migrate\source\SourcePluginBase extends \Drupal\migrate\Plugin\MigrateSourceInterface, \Drupal\migrate\Event\RollbackAwareInterface implements \Drupal\Core\Plugin\PluginBase
- class \Drupal\migrate\Plugin\migrate\source\SqlBase extends \Drupal\Core\Plugin\ContainerFactoryPluginInterface, \Drupal\migrate\Plugin\RequirementsInterface implements \Drupal\migrate\Plugin\migrate\source\SourcePluginBase
- class \Drupal\migrate_drupal\Plugin\migrate\source\DrupalSqlBase extends \Drupal\Component\Plugin\DependentPluginInterface uses \Drupal\Core\Entity\DependencyTrait implements \Drupal\migrate\Plugin\migrate\source\SqlBase
- class \Drupal\file\Plugin\migrate\source\d6\File implements \Drupal\migrate_drupal\Plugin\migrate\source\DrupalSqlBase
- class \Drupal\migrate_drupal\Plugin\migrate\source\DrupalSqlBase extends \Drupal\Component\Plugin\DependentPluginInterface uses \Drupal\Core\Entity\DependencyTrait implements \Drupal\migrate\Plugin\migrate\source\SqlBase
- class \Drupal\migrate\Plugin\migrate\source\SqlBase extends \Drupal\Core\Plugin\ContainerFactoryPluginInterface, \Drupal\migrate\Plugin\RequirementsInterface implements \Drupal\migrate\Plugin\migrate\source\SourcePluginBase
- class \Drupal\migrate\Plugin\migrate\source\SourcePluginBase extends \Drupal\migrate\Plugin\MigrateSourceInterface, \Drupal\migrate\Event\RollbackAwareInterface implements \Drupal\Core\Plugin\PluginBase
- class \Drupal\Core\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait implements \Drupal\Component\Plugin\PluginBase
Expanded class hierarchy of File
See also
\Drupal\migrate\Plugin\migrate\source\SqlBase
\Drupal\migrate\Plugin\migrate\source\SourcePluginBase
350 string references to 'File'
- 23a7f61f-1db3-407d-a6dd-eb4731995c9f.yml in core/
tests/ fixtures/ default_content/ file/ 23a7f61f-1db3-407d-a6dd-eb4731995c9f.yml - core/tests/fixtures/default_content/file/23a7f61f-1db3-407d-a6dd-eb4731995c9f.yml
- 2b8e0616-3ef0-4a91-8cfb-b31d9128f9f8.yml in core/
tests/ fixtures/ default_content/ file/ 2b8e0616-3ef0-4a91-8cfb-b31d9128f9f8.yml - core/tests/fixtures/default_content/file/2b8e0616-3ef0-4a91-8cfb-b31d9128f9f8.yml
- 344b943c-b231-4d73-9669-0b0a2be12aa5.yml in core/
tests/ fixtures/ default_content/ media/ 344b943c-b231-4d73-9669-0b0a2be12aa5.yml - core/tests/fixtures/default_content/media/344b943c-b231-4d73-9669-0b0a2be12aa5.yml
- 7fb09f9f-ba5f-4db4-82ed-aa5ccf7d425d.yml in core/
tests/ fixtures/ default_content/ file/ 7fb09f9f-ba5f-4db4-82ed-aa5ccf7d425d.yml - core/tests/fixtures/default_content/file/7fb09f9f-ba5f-4db4-82ed-aa5ccf7d425d.yml
- a6b79928-838f-44bd-a8f0-44c2fff9e4cc.yml in core/
tests/ fixtures/ default_content/ a6b79928-838f-44bd-a8f0-44c2fff9e4cc.yml - core/tests/fixtures/default_content/a6b79928-838f-44bd-a8f0-44c2fff9e4cc.yml
File
-
core/
modules/ file/ src/ Plugin/ migrate/ source/ d6/ File.php, line 42
Namespace
Drupal\file\Plugin\migrate\source\d6View source
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
Title Sort descending | Deprecated | Modifiers | Object type | Summary | Overriden Title | 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::__wakeup | public | function | 3 | |||
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::getSourceModule | public | function | Gets the source module providing the source data. | Overrides SourcePluginBase::getSourceModule | ||
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 | 6 | |
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 | Prepares query object to retrieve data from the source database. | Overrides SqlBase::query | ||
MessengerTrait::$messenger | protected | property | The messenger. | 25 | ||
MessengerTrait::messenger | public | function | Gets the messenger. | 25 | ||
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. | 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 | 2 | |
PluginBase::getPluginId | public | function | Gets the plugin ID of the plugin instance. | Overrides PluginInspectionInterface::getPluginId | ||
PluginBase::isConfigurable | Deprecated | 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 | Gets the source count. | 3 | ||
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::key | public | function | Gets the iterator key. | |||
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::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 | Checks whether the iterator is currently valid. | |||
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. | 85 | ||
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. | 1 | ||
SqlBase::rewind | public | function | Rewinds the iterator. | Overrides SourcePluginBase::rewind | ||
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. | 2 | ||
StringTranslationTrait::t | protected | function | Translates a string to the current language or to a given language. | 1 |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.