class File in Migrate Plus 8.4

Retrieve data from a local path or general URL for migration.

Plugin annotation

@DataFetcher(
  id = "file",
  title = @Translation("File")
)

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
    • class \Drupal\migrate_plus\DataFetcherPluginBase implements DataFetcherPluginInterface
      • class \Drupal\migrate_plus\Plugin\migrate_plus\data_fetcher\File

1 file declares its use of File

FileTest.php in tests/src/Unit/data_fetcher/FileTest.php

PHPUnit tests for the Migrate Plus File 'data fetcher' plugin.

File

src/Plugin/migrate_plus/data_fetcher/File.php, line 16

Namespace

Drupal\migrate_plus\Plugin\migrate_plus\data_fetcher

class File extends DataFetcherPluginBase {

  /**
   * {@inheritdoc}
   */
  public function setRequestHeaders(array $headers) {

    // Does nothing.
  }

  /**
   * {@inheritdoc}
   */
  public function getRequestHeaders() {

    // Does nothing.
    return [];
  }

  /**
   * {@inheritdoc}
   */
  public function getResponse($url) {
    $response = @file_get_contents($url);
    if ($response === FALSE) {
      throw new MigrateException('file parser plugin: could not retrieve data from ' . $url);
    }
    return $response;
  }

  /**
   * {@inheritdoc}
   */
  public function getResponseContent($url) {
    $response = $this
      ->getResponse($url);
    return $response;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
DataFetcherPluginBase::create	public static	function
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::__sleep	public	function		1
DependencySerializationTrait::__wakeup	public	function		2
File::getRequestHeaders	public	function	Get the currently set request headers. Overrides DataFetcherPluginInterface::getRequestHeaders
File::getResponse	public	function	Return Http Response object for a given url. Overrides DataFetcherPluginInterface::getResponse
File::getResponseContent	public	function	Return content. Overrides DataFetcherPluginInterface::getResponseContent
File::setRequestHeaders	public	function	Set the client headers. Overrides DataFetcherPluginInterface::setRequestHeaders
MessengerTrait::$messenger	protected	property	The messenger.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
MessengerTrait::setMessenger	public	function	Sets the messenger.
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	3
PluginBase::getPluginId	public	function	Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable	public	function	Determines if the plugin is configurable.
PluginBase::__construct	public	function	Constructs a \Drupal\Component\Plugin\PluginBase object.	92
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	1
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.