Skip to main content
Drupal API
User account menu
  • Log in

Breadcrumb

  1. Drupal Core 11.1.x
  2. File.php

class File

Same name in this branch
  1. 11.1.x vendor/phpunit/php-code-coverage/src/Node/File.php \SebastianBergmann\CodeCoverage\Node\File
  2. 11.1.x vendor/phpunit/php-code-coverage/src/Report/Html/Renderer/File.php \SebastianBergmann\CodeCoverage\Report\Html\File
  3. 11.1.x vendor/phpunit/php-code-coverage/src/Report/Xml/File.php \SebastianBergmann\CodeCoverage\Report\Xml\File
  4. 11.1.x vendor/phpunit/phpunit/src/TextUI/Configuration/Value/File.php \PHPUnit\TextUI\Configuration\File
  5. 11.1.x vendor/nikic/php-parser/lib/PhpParser/Node/Scalar/MagicConst/File.php \PhpParser\Node\Scalar\MagicConst\File
  6. 11.1.x vendor/symfony/mime/Part/File.php \Symfony\Component\Mime\Part\File
  7. 11.1.x vendor/symfony/validator/Constraints/File.php \Symfony\Component\Validator\Constraints\File
  8. 11.1.x vendor/symfony/http-foundation/File/File.php \Symfony\Component\HttpFoundation\File\File
  9. 11.1.x vendor/squizlabs/php_codesniffer/src/Files/File.php \PHP_CodeSniffer\Files\File
  10. 11.1.x core/lib/Drupal/Core/Render/Element/File.php \Drupal\Core\Render\Element\File
  11. 11.1.x core/modules/file/src/Plugin/migrate/source/d7/File.php \Drupal\file\Plugin\migrate\source\d7\File
  12. 11.1.x core/modules/file/src/Plugin/views/field/File.php \Drupal\file\Plugin\views\field\File
  13. 11.1.x core/modules/file/src/Plugin/views/wizard/File.php \Drupal\file\Plugin\views\wizard\File
  14. 11.1.x core/modules/file/src/Entity/File.php \Drupal\file\Entity\File
  15. 11.1.x core/modules/media/src/Plugin/media/Source/File.php \Drupal\media\Plugin\media\Source\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 implements \Drupal\Component\Plugin\PluginInspectionInterface, \Drupal\Component\Plugin\DerivativeInspectionInterface
    • class \Drupal\Core\Plugin\PluginBase extends \Drupal\Component\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait
      • class \Drupal\migrate\Plugin\migrate\source\SourcePluginBase extends \Drupal\Core\Plugin\PluginBase implements \Drupal\migrate\Plugin\MigrateSourceInterface, \Drupal\migrate\Event\RollbackAwareInterface
        • class \Drupal\migrate\Plugin\migrate\source\SqlBase extends \Drupal\migrate\Plugin\migrate\source\SourcePluginBase implements \Drupal\Core\Plugin\ContainerFactoryPluginInterface, \Drupal\migrate\Plugin\RequirementsInterface
          • class \Drupal\migrate_drupal\Plugin\migrate\source\DrupalSqlBase extends \Drupal\migrate\Plugin\migrate\source\SqlBase implements \Drupal\Component\Plugin\DependentPluginInterface uses \Drupal\Core\Entity\DependencyTrait
            • class \Drupal\file\Plugin\migrate\source\d6\File extends \Drupal\migrate_drupal\Plugin\migrate\source\DrupalSqlBase

Expanded class hierarchy of File

See also

\Drupal\migrate\Plugin\migrate\source\SqlBase

\Drupal\migrate\Plugin\migrate\source\SourcePluginBase

d6_file.yml

171 string references to 'File'
AbstractUriElement::__construct in vendor/symfony/dom-crawler/AbstractUriElement.php
ArchiveCommand::execute in vendor/composer/composer/src/Composer/Command/ArchiveCommand.php
Executes the current command.
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.
BaseFieldFileFormatterBase::isApplicable in core/modules/file/src/Plugin/Field/FieldFormatter/BaseFieldFileFormatterBase.php
Returns if the formatter can be used for the provided field.

... See full list

File

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

Namespace

Drupal\file\Plugin\migrate\source\d6
View 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 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.
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 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
MigrateSourceInterface::NOT_COUNTABLE constant Indicates that the source is not countable.
PluginInspectionInterface::getPluginDefinition public function Gets the definition of the plugin implementation. 5
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.
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.
SourcePluginBase::$trackChanges protected property Flags whether to track changes to incoming data.
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. 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 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.
SqlBase::$query protected property The query string. 66
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.
SqlBase::mapJoinable protected function Checks if we can join against the map table.
SqlBase::prepareQuery protected function Adds tags and metadata to the query.
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
SqlBase::__toString public function Prints the query string when the object is used as a string. Overrides MigrateSourceInterface::__toString

API Navigation

  • Drupal Core 11.1.x
  • Topics
  • Classes
  • Functions
  • Constants
  • Globals
  • Files
  • Namespaces
  • Deprecated
  • Services
RSS feed
Powered by Drupal