annotate modules/contrib/migrate_plus/src/AuthenticationPluginInterface.php @ 5:12f9dff5fda9 tip

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