Code Coverage
 
Lines
Functions and Methods
Classes and Traits
Total
n/a
0 / 0
n/a
0 / 0
CRAP
n/a
0 / 0
1<?php
2
3/**
4 * Interface for classes using OauthServiceTrait.
5 *
6 * PHP version 8
7 *
8 * Copyright (C) Villanova University 2023.
9 *
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License version 2,
12 * as published by the Free Software Foundation.
13 *
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17 * GNU General Public License for more details.
18 *
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software
21 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
22 *
23 * @category VuFind
24 * @package  Connection
25 * @author   Maccabee Levine <msl321@lehigh.edu>
26 * @license  http://opensource.org/licenses/gpl-2.0.php GNU General Public License
27 * @link     https://vufind.org
28 */
29
30namespace VuFind\Connection;
31
32/**
33 * Interface for classes using OauthServiceTrait.
34 *
35 * Classes which use this interface should also implement LoggerAwareInterface.
36 *
37 * @category VuFind
38 * @package  Connection
39 * @author   Maccabee Levine <msl321@lehigh.edu>
40 * @license  http://opensource.org/licenses/gpl-2.0.php GNU General Public License
41 * @link     https://vufind.org
42 */
43interface OauthServiceInterface
44{
45    /**
46     * Authenticate via the OAuth Client Credentials grant type.
47     *
48     * @param string $oauthUrl     URL of thee OAuth service
49     * @param string $clientId     client_id for a client_credentials grant
50     * @param string $clientSecret client_secret for a client_credentials grant
51     *
52     * @return string token for the session or false
53     *     if the token request failed
54     *
55     * @link https://www.oauth.com/oauth2-servers/access-tokens/client-credentials/
56     */
57    public function authenticateWithClientCredentials(
58        $oauthUrl,
59        $clientId,
60        $clientSecret
61    );
62}