o-authentication/ProviderInterface.php at master · radphp/o-authentication · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
<?php

namespace Rad\OAuthentication;

/**
 * Provider Interface
 *
 * @package Rad\OAuthentication
 */
interface ProviderInterface
{
    /**
     * Set client id
     *
     * @param string $clientId Client id
     *
     * @return self
     */
    public function setClientId($clientId);

    /**
     * Get client id
     *
     * @return string
     */
    public function getClientId();

    /**
     * Get client secret
     *
     * @param string $clientSecret Client secret
     *
     * @return self
     */
    public function setClientSecret($clientSecret);

    /**
     * Get client secret
     *
     * @return string
     */
    public function getClientSecret();

    /**
     * Set scopes
     *
     * @param array $scopes Scopes
     *
     * @return self
     */
    public function setScopes(array $scopes);

    /**
     * Get scopes
     *
     * @return array
     */
    public function getScopes();

    /**
     * Get redirect uri
     *
     * @param string $redirectUri Redirect uri
     *
     * @return self
     */
    public function setRedirectUri($redirectUri);

    /**
     * Get redirect uri
     *
     * @return string
     */
    public function getRedirectUri();

    /**
     * Get state
     *
     * @param string $state State
     *
     * @return self
     */
    public function setState($state);

    /**
     * Get state
     *
     * @return string
     */
    public function getState();


    /**
     * Get authorize uri
     *
     * @return string
     */
    public function getAuthorizeUri();

    /**
     * Get access token
     *
     * @param string $authorizeCode Authorize code
     *
     * @return array
     */
    public function getAccessToken($authorizeCode);

    /**
     * Get user detail
     *
     * @param string $token Access token
     *
     * @return User
     * @throws Exception
     */
    public function getUser($token);
}