Version 1
[yaffs-website] / web / modules / contrib / migrate_plus / src / AuthenticationPluginInterface.php
diff --git a/web/modules/contrib/migrate_plus/src/AuthenticationPluginInterface.php b/web/modules/contrib/migrate_plus/src/AuthenticationPluginInterface.php
new file mode 100644 (file)
index 0000000..5bdc603
--- /dev/null
@@ -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();
+
+}