class File

Same name in this branch
  1. 8.9.x core/modules/media/src/Plugin/media/Source/File.php \Drupal\media\Plugin\media\Source\File
  2. 8.9.x core/modules/file/src/Entity/File.php \Drupal\file\Entity\File
  3. 8.9.x core/modules/file/src/Plugin/views/field/File.php \Drupal\file\Plugin\views\field\File
  4. 8.9.x core/modules/file/src/Plugin/views/wizard/File.php \Drupal\file\Plugin\views\wizard\File
  5. 8.9.x core/modules/file/src/Plugin/migrate/source/d6/File.php \Drupal\file\Plugin\migrate\source\d6\File
  6. 8.9.x core/lib/Drupal/Core/Render/Element/File.php \Drupal\Core\Render\Element\File
Same name and namespace in other branches
  1. 9 core/modules/media/src/Plugin/media/Source/File.php \Drupal\media\Plugin\media\Source\File
  2. 9 core/modules/file/src/Entity/File.php \Drupal\file\Entity\File
  3. 9 core/modules/file/src/Plugin/views/field/File.php \Drupal\file\Plugin\views\field\File
  4. 9 core/modules/file/src/Plugin/views/wizard/File.php \Drupal\file\Plugin\views\wizard\File
  5. 9 core/modules/file/src/Plugin/migrate/source/d6/File.php \Drupal\file\Plugin\migrate\source\d6\File
  6. 9 core/modules/file/src/Plugin/migrate/source/d7/File.php \Drupal\file\Plugin\migrate\source\d7\File
  7. 9 core/lib/Drupal/Core/Render/Element/File.php \Drupal\Core\Render\Element\File
  8. 10 core/modules/media/src/Plugin/media/Source/File.php \Drupal\media\Plugin\media\Source\File
  9. 10 core/modules/file/src/Entity/File.php \Drupal\file\Entity\File
  10. 10 core/modules/file/src/Plugin/views/field/File.php \Drupal\file\Plugin\views\field\File
  11. 10 core/modules/file/src/Plugin/views/wizard/File.php \Drupal\file\Plugin\views\wizard\File
  12. 10 core/modules/file/src/Plugin/migrate/source/d6/File.php \Drupal\file\Plugin\migrate\source\d6\File
  13. 10 core/modules/file/src/Plugin/migrate/source/d7/File.php \Drupal\file\Plugin\migrate\source\d7\File
  14. 10 core/lib/Drupal/Core/Render/Element/File.php \Drupal\Core\Render\Element\File
  15. 11.x core/modules/media/src/Plugin/media/Source/File.php \Drupal\media\Plugin\media\Source\File
  16. 11.x core/modules/file/src/Entity/File.php \Drupal\file\Entity\File
  17. 11.x core/modules/file/src/Plugin/views/field/File.php \Drupal\file\Plugin\views\field\File
  18. 11.x core/modules/file/src/Plugin/views/wizard/File.php \Drupal\file\Plugin\views\wizard\File
  19. 11.x core/modules/file/src/Plugin/migrate/source/d6/File.php \Drupal\file\Plugin\migrate\source\d6\File
  20. 11.x core/modules/file/src/Plugin/migrate/source/d7/File.php \Drupal\file\Plugin\migrate\source\d7\File
  21. 11.x core/lib/Drupal/Core/Render/Element/File.php \Drupal\Core\Render\Element\File

Drupal 7 file source from database.

Plugin annotation


@MigrateSource(
  id = "d7_file",
  source_module = "file"
)

Hierarchy

Expanded class hierarchy of File

323 string references to 'File'
AccessTest::setUp in core/modules/file/tests/src/Kernel/AccessTest.php
AjaxFileManagedMultipleTest::testMultipleFilesUpload in core/modules/file/tests/src/FunctionalJavascript/AjaxFileManagedMultipleTest.php
Test if managed file form element works well with multiple files upload.
AnnotatedClassDiscoveryTest::provideBadAnnotations in core/tests/Drupal/Tests/Component/Plugin/Discovery/AnnotatedClassDiscoveryTest.php
All the Drupal documentation standards tags.
AssetResolver::getCssAssets in core/lib/Drupal/Core/Asset/AssetResolver.php
Returns the CSS assets for the current response's libraries.
AssetResolver::getJsAssets in core/lib/Drupal/Core/Asset/AssetResolver.php
Returns the JavaScript assets for the current response's libraries.

... See full list

File

core/modules/file/src/Plugin/migrate/source/d7/File.php, line 17

Namespace

Drupal\file\Plugin\migrate\source\d7
View source
class File extends DrupalSqlBase {
    
    /**
     * The public file directory path.
     *
     * @var string
     */
    protected $publicPath;
    
    /**
     * The private file directory path, if any.
     *
     * @var string
     */
    protected $privatePath;
    
    /**
     * The temporary file directory path.
     *
     * @var string
     */
    protected $temporaryPath;
    
    /**
     * {@inheritdoc}
     */
    public function query() {
        $query = $this->select('file_managed', 'f')
            ->fields('f')
            ->condition('uri', 'temporary://%', 'NOT LIKE')
            ->orderBy('f.timestamp');
        // Filter by scheme(s), if configured.
        if (isset($this->configuration['scheme'])) {
            $schemes = [];
            // Remove 'temporary' scheme.
            $valid_schemes = array_diff((array) $this->configuration['scheme'], [
                'temporary',
            ]);
            // Accept either a single scheme, or a list.
            foreach ((array) $valid_schemes as $scheme) {
                $schemes[] = rtrim($scheme) . '://';
            }
            $schemes = array_map([
                $this->getDatabase(),
                'escapeLike',
            ], $schemes);
            // Add conditions, uri LIKE 'public://%' OR uri LIKE 'private://%'.
            $conditions = new Condition('OR');
            foreach ($schemes as $scheme) {
                $conditions->condition('uri', $scheme . '%', 'LIKE');
            }
            $query->condition($conditions);
        }
        return $query;
    }
    
    /**
     * {@inheritdoc}
     */
    protected function initializeIterator() {
        $this->publicPath = $this->variableGet('file_public_path', 'sites/default/files');
        $this->privatePath = $this->variableGet('file_private_path', NULL);
        $this->temporaryPath = $this->variableGet('file_temporary_path', '/tmp');
        return parent::initializeIterator();
    }
    
    /**
     * {@inheritdoc}
     */
    public function prepareRow(Row $row) {
        // Compute the filepath property, which is a physical representation of
        // the URI relative to the Drupal root.
        $path = str_replace([
            'public:/',
            'private:/',
            'temporary:/',
        ], [
            $this->publicPath,
            $this->privatePath,
            $this->temporaryPath,
        ], $row->getSourceProperty('uri'));
        // At this point, $path could be an absolute path or a relative path,
        // depending on how the scheme's variable was set. So we need to shear out
        // the source_base_path in order to make them all relative.
        $path = str_replace($this->configuration['constants']['source_base_path'], NULL, $path);
        $row->setSourceProperty('filepath', $path);
        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.'),
        ];
    }
    
    /**
     * {@inheritdoc}
     */
    public function getIds() {
        $ids['fid']['type'] = 'integer';
        return $ids;
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
DependencyTrait::$dependencies protected property The object's dependencies.
DependencyTrait::addDependencies protected function Adds multiple dependencies.
DependencyTrait::addDependency protected function Adds a dependency.
DeprecatedServicePropertyTrait::__get public function Allows to access deprecated/removed properties.
DrupalSqlBase::$deprecatedProperties protected property 1
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 1
DrupalSqlBase::checkRequirements public function Checks if requirements for this plugin are OK. Overrides SqlBase::checkRequirements 2
DrupalSqlBase::create public static function Creates an instance of the plugin. Overrides SqlBase::create 3
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 Overrides SqlBase::__construct 6
File::$privatePath protected property The private file directory path, if any.
File::$publicPath protected property The public file directory path.
File::$temporaryPath protected property The temporary file directory 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
PluginInspectionInterface::getPluginDefinition public function Gets the definition of the plugin implementation. 6
PluginInspectionInterface::getPluginId public function Gets the plugin_id of the plugin instance. 2
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::current public function
SourcePluginBase::doCount protected function Gets the source count checking if the source is countable or using the
iterator_count function.
1
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. 1
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 Gets the iterator key.
SourcePluginBase::next public function The migration iterates over rows returned by the source plugin. This
method determines the next row which will be processed and imported into
the system.
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 Rewinds the iterator.
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. 82
SqlBase::$state protected property State service for retrieving database info.
SqlBase::count public function Gets the source count. Overrides SourcePluginBase::count 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::__toString public function Prints the query string when the object is used as a string. Overrides MigrateSourceInterface::__toString

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.