interface DataFetcherPluginInterface in Migrate Plus 8

Defines an interface for data fetchers.

Hierarchy

• interface \Drupal\migrate_plus\DataFetcherPluginInterface

See also

\Drupal\migrate_plus\Annotation\DataFetcher

\Drupal\migrate_plus\DataFetchPluginBase

\Drupal\migrate_plus\DataFetcherPluginManager

Plugin API

File

src/DataFetcherPluginInterface.php, line 18

Contains \Drupal\migrate_plus\DataFetcherPluginInterface.

Namespace

Drupal\migrate_plus

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);

}

Members

Name	Modifiers	Type	Description	Overrides
DataFetcherPluginInterface::getRequestHeaders	public	function	Get the currently set request headers.	1
DataFetcherPluginInterface::getResponse	public	function	Return Http Response object for a given url.	1
DataFetcherPluginInterface::getResponseContent	public	function	Return content.	1
DataFetcherPluginInterface::setRequestHeaders	public	function	Set the client headers.	1