www.aleph1.co.uk Git - yaffs-website/blob - web/modules/contrib/migrate_plus/src/AuthenticationPluginInterface.php

   1 <?php
   2
   3 namespace Drupal\migrate_plus;
   4
   5 /**
   6  * Defines an interface for authenticaion handlers.
   7  *
   8  * @see \Drupal\migrate_plus\Annotation\Authentication
   9  * @see \Drupal\migrate_plus\AuthenticationPluginBase
  10  * @see \Drupal\migrate_plus\AuthenticationPluginManager
  11  * @see plugin_api
  12  */
  13 interface AuthenticationPluginInterface {
  14
  15   /**
  16    * Performs authentication, returning any options to be added to the request.
  17    *
  18    * @return array
  19    *   Options (such as Authentication headers) to be added to the request.
  20    *
  21    * @link http://docs.guzzlephp.org/en/latest/request-options.html
  22    */
  23   public function getAuthenticationOptions();
  24
  25 }