diff modules/contrib/migrate_plus/src/AuthenticationPluginInterface.php @ 4:a9cd425dd02b

Update, including to Drupal core 8.6.10
author Chris Cannam
date Thu, 28 Feb 2019 13:11:55 +0000
parents
children
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/modules/contrib/migrate_plus/src/AuthenticationPluginInterface.php	Thu Feb 28 13:11:55 2019 +0000
@@ -0,0 +1,25 @@
+<?php
+
+namespace Drupal\migrate_plus;
+
+/**
+ * Defines an interface for authenticaion handlers.
+ *
+ * @see \Drupal\migrate_plus\Annotation\Authentication
+ * @see \Drupal\migrate_plus\AuthenticationPluginBase
+ * @see \Drupal\migrate_plus\AuthenticationPluginManager
+ * @see plugin_api
+ */
+interface AuthenticationPluginInterface {
+
+  /**
+   * Performs authentication, returning any options to be added to the request.
+   *
+   * @return array
+   *   Options (such as Authentication headers) to be added to the request.
+   *
+   * @link http://docs.guzzlephp.org/en/latest/request-options.html
+   */
+  public function getAuthenticationOptions();
+
+}