[Summary view] [Print] [Text view]

   1  <?php
   2  /**
   3  *
   4  * This file is part of the phpBB Forum Software package.
   5  *
   6  * @copyright (c) phpBB Limited <https://www.phpbb.com>
   7  * @license GNU General Public License, version 2 (GPL-2.0)
   8  *
   9  * For full copyright and license information, please see
  10  * the docs/CREDITS.txt file.
  11  *
  12  */
  13  
  14  namespace phpbb\auth\provider\oauth\service;
  15  
  16  /**
  17  * OAuth service interface
  18  */
  19  interface service_interface
  20  {
  21      /**
  22      * Returns an array of the scopes necessary for auth
  23      *
  24      * @return    array    An array of the required scopes
  25      */
  26  	public function get_auth_scope();
  27  
  28      /**
  29      * Returns the external library service provider once it has been set
  30      *
  31      * @param    \OAuth\Common\Service\ServiceInterface|null
  32      */
  33  	public function get_external_service_provider();
  34  
  35      /**
  36      * Returns an array containing the service credentials belonging to requested
  37      * service.
  38      *
  39      * @return    array    An array containing the 'key' and the 'secret' of the
  40      *                    service in the form:
  41      *                        array(
  42      *                            'key'        => string
  43      *                            'secret'    => string
  44      *                        )
  45      */
  46  	public function get_service_credentials();
  47  
  48      /**
  49      * Returns the results of the authentication in json format
  50      *
  51      * @throws    \phpbb\auth\provider\oauth\service\exception
  52      * @return    string    The unique identifier returned by the service provider
  53      *                    that is used to authenticate the user with phpBB.
  54      */
  55  	public function perform_auth_login();
  56  
  57      /**
  58      * Returns the results of the authentication in json format
  59      * Use this function when the user already has an access token
  60      *
  61      * @throws    \phpbb\auth\provider\oauth\service\exception
  62      * @return    string    The unique identifier returned by the service provider
  63      *                    that is used to authenticate the user with phpBB.
  64      */
  65  	public function perform_token_auth();
  66  
  67      /**
  68      * Sets the external library service provider
  69      *
  70      * @param    \OAuth\Common\Service\ServiceInterface    $service_provider
  71      */
  72  	public function set_external_service_provider(\OAuth\Common\Service\ServiceInterface $service_provider);
  73  }