Version 1
[yaffs-website] / web / modules / contrib / migrate_plus / src / DataFetcherPluginInterface.php
diff --git a/web/modules/contrib/migrate_plus/src/DataFetcherPluginInterface.php b/web/modules/contrib/migrate_plus/src/DataFetcherPluginInterface.php
new file mode 100644 (file)
index 0000000..a64b479
--- /dev/null
@@ -0,0 +1,49 @@
+<?php
+
+namespace Drupal\migrate_plus;
+
+/**
+ * Defines an interface for data fetchers.
+ *
+ * @see \Drupal\migrate_plus\Annotation\DataFetcher
+ * @see \Drupal\migrate_plus\DataFetchPluginBase
+ * @see \Drupal\migrate_plus\DataFetcherPluginManager
+ * @see plugin_api
+ */
+interface DataFetcherPluginInterface {
+
+  /**
+   * Set the client headers.
+   *
+   * @param $headers
+   *   An array of the headers to set on the HTTP request.
+   */
+  public function setRequestHeaders(array $headers);
+
+  /**
+   * Get the currently set request headers.
+   */
+  public function getRequestHeaders();
+
+  /**
+   * Return content.
+   *
+   * @param $url
+   *   URL to retrieve from.
+   *
+   * @return string
+   *   Content at the given url.
+   */
+  public function getResponseContent($url);
+
+  /**
+   * Return Http Response object for a given url.
+   *
+   * @param $url
+   *   URL to retrieve from.
+   *
+   * @return \Psr\Http\Message\ResponseInterface
+   */
+  public function getResponse($url);
+
+}