You are here

class File in Zircon Profile 8

Same name in this branch
  1. 8 vendor/symfony/validator/Constraints/File.php \Symfony\Component\Validator\Constraints\File
  2. 8 vendor/symfony/http-foundation/File/File.php \Symfony\Component\HttpFoundation\File\File
  3. 8 core/modules/file/src/Entity/File.php \Drupal\file\Entity\File
  4. 8 core/lib/Drupal/Core/Render/Element/File.php \Drupal\Core\Render\Element\File
  5. 8 core/modules/file/src/Plugin/views/wizard/File.php \Drupal\file\Plugin\views\wizard\File
  6. 8 core/modules/file/src/Plugin/views/field/File.php \Drupal\file\Plugin\views\field\File
  7. 8 core/modules/file/src/Plugin/migrate/source/d6/File.php \Drupal\file\Plugin\migrate\source\d6\File
  8. 8 core/modules/file/src/Plugin/migrate/source/d7/File.php \Drupal\file\Plugin\migrate\source\d7\File
Same name and namespace in other branches
  1. 8.0 core/modules/file/src/Plugin/migrate/source/d7/File.php \Drupal\file\Plugin\migrate\source\d7\File

Drupal 7 file source from database.

Plugin annotation


@MigrateSource(
  id = "d7_file"
)

Hierarchy

Expanded class hierarchy of File

1 file declares its use of File
FileTest.php in core/modules/file/tests/src/Unit/Plugin/migrate/source/d7/FileTest.php
Contains \Drupal\Tests\file\Unit\Plugin\migrate\source\d7\FileTest.
23 string references to 'File'
DirectoryTest::testFileCheckDirectoryHandling in core/modules/system/src/Tests/File/DirectoryTest.php
Test directory handling functions.
DirectoryTest::testFileCheckLocalDirectoryHandling in core/modules/system/src/Tests/File/DirectoryTest.php
Test local directory handling functions.
DirectoryTest::testFileCreateNewFilepath in core/modules/system/src/Tests/File/DirectoryTest.php
This will take a directory and path, and find a valid filepath that is not taken by another file.
DirectoryTest::testFileDestination in core/modules/system/src/Tests/File/DirectoryTest.php
This will test the filepath for a destination based on passed flags and whether or not the file exists.
file.destination.schema.yml in core/modules/file/config/schema/file.destination.schema.yml
core/modules/file/config/schema/file.destination.schema.yml

... See full list

File

core/modules/file/src/Plugin/migrate/source/d7/File.php, line 21
Contains \Drupal\file\Plugin\migrate\source\d7\File.

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')
      ->orderBy('timestamp');

    // Filter by scheme(s), if configured.
    if (isset($this->configuration['scheme'])) {
      $schemes = array();

      // Accept either a single scheme, or a list.
      foreach ((array) $this->configuration['scheme'] as $scheme) {
        $schemes[] = rtrim($scheme) . '://';
      }
      $schemes = array_map([
        $this
          ->getDatabase(),
        'escapeLike',
      ], $schemes);

      // 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.
    // @todo Don't depend on destination configuration.
    // @see https://www.drupal.org/node/2577871
    $path = str_replace($this->migration
      ->get('destination')['source_base_path'], NULL, $path);
    $row
      ->setSourceProperty('filepath', $path);
    return parent::prepareRow($row);
  }

  /**
   * {@inheritdoc}
   */
  public function fields() {
    return array(
      '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

Namesort descending Modifiers Type Description Overrides
DependencySerializationTrait::$_serviceIds protected property An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep public function 1
DependencySerializationTrait::__wakeup public function 2
DependencyTrait::$dependencies protected property The object's dependencies. 1
DependencyTrait::addDependencies protected function Adds multiple dependencies.
DependencyTrait::addDependency protected function Adds a dependency.
DrupalSqlBase::$entityManager protected property The entity 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 RequirementsInterface::checkRequirements
DrupalSqlBase::create public static function Creates an instance of the plugin. Overrides SqlBase::create
DrupalSqlBase::getModuleSchemaVersion protected function Get a module schema_version value in the source installation.
DrupalSqlBase::getSystemData public function Retrieves all system data information from origin system.
DrupalSqlBase::moduleExists protected function Check to see if a given module is enabled in the source installation.
DrupalSqlBase::variableGet protected function Read a variable from a Drupal database.
DrupalSqlBase::__construct public function Constructs a Drupal\Component\Plugin\PluginBase object. Overrides SqlBase::__construct 1
File::$privatePath protected property The private file directory path, if any. 1
File::$publicPath protected property The public file directory path. 1
File::$temporaryPath protected property The temporary file directory path. 1
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. None of these fields should contain a NULL value - if necessary, use prepareRow() or hook_migrate_prepare_row() to rewrite NULL values to appropriate empty values (such as '' or 0). Overrides MigrateSourceInterface::getIds
File::initializeIterator protected function Implementation of MigrateSource::performRewind(). Overrides SqlBase::initializeIterator
File::prepareRow public function Add additional data to the row. Overrides SourcePluginBase::prepareRow
File::query public function Overrides SqlBase::query
PluginBase::$configuration protected property Configuration information passed into the plugin. 2
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 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
PluginBase::getPluginId public function Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
SourcePluginBase::$cache protected property
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 The name and type of the highwater property in the source.
SourcePluginBase::$idMap protected property
SourcePluginBase::$iterator protected property
SourcePluginBase::$mapRowAdded protected property By default, next() will directly read the map row and add it to the data row. A source plugin implementation may do this itself (in particular, the SQL source can incorporate the map table into the query) - if so, it should set this TRUE so we…
SourcePluginBase::$migration protected property
SourcePluginBase::$moduleHandler protected property
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 If TRUE, we will maintain hashed source rows to determine whether incoming data has changed.
SourcePluginBase::aboveHighwater protected function Check if the incoming data is newer than what we've previously imported.
SourcePluginBase::current public function
SourcePluginBase::getCache protected function Get the cache object.
SourcePluginBase::getCurrentIds public function Getter for currentSourceIds data member.
SourcePluginBase::getIterator protected function Returns the iterator that will yield the row arrays to be processed.
SourcePluginBase::getModuleHandler protected function Get the module handler.
SourcePluginBase::key public function Get 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::rewind public function Rewind the iterator.
SourcePluginBase::rowChanged protected function Check if the incoming row has changed since our last import.
SourcePluginBase::valid public function Whether the iterator is currently valid.
SqlBase::$database protected property 1
SqlBase::$query protected property 59
SqlBase::$state protected property State service for retrieving database info.
SqlBase::count public function Get the source count. Overrides SourcePluginBase::count 4
SqlBase::getDatabase public function Get the database connection object. 1
SqlBase::mapJoinable protected function Check if we can join against the map table. 1
SqlBase::prepareQuery protected function A helper for adding tags and metadata to the query.
SqlBase::select protected function Wrapper for database select.
SqlBase::setUpDatabase protected function Get a connection to the referenced database, adding the connection if necessary.
SqlBase::__toString public function Print the query string when the object is used a string. Overrides MigrateSourceInterface::__toString
StringTranslationTrait::$stringTranslation protected property The string translation service.
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.