BaseGrant::getResponseType()   A
last analyzed

Complexity

Conditions 1
Paths 1

Size

Total Lines 3
Code Lines 1

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
cc 1
eloc 1
nc 1
nop 0
dl 0
loc 3
rs 10
c 0
b 0
f 0
1
<?php
2
3
/**
4
 * Platine OAuth2
5
 *
6
 * Platine OAuth2 is a library that implements the OAuth2 specification
7
 *
8
 * This content is released under the MIT License (MIT)
9
 *
10
 * Copyright (c) 2020 Platine OAuth2
11
 *
12
 * Permission is hereby granted, free of charge, to any person obtaining a copy
13
 * of this software and associated documentation files (the "Software"), to deal
14
 * in the Software without restriction, including without limitation the rights
15
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
16
 * copies of the Software, and to permit persons to whom the Software is
17
 * furnished to do so, subject to the following conditions:
18
 *
19
 * The above copyright notice and this permission notice shall be included in all
20
 * copies or substantial portions of the Software.
21
 *
22
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
23
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
24
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
25
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
26
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
27
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
28
 * SOFTWARE.
29
 */
30
31
declare(strict_types=1);
32
33
namespace Platine\OAuth2\Grant;
34
35
use Platine\Http\ResponseInterface;
36
use Platine\OAuth2\Entity\AccessToken;
37
use Platine\OAuth2\Entity\RefreshToken;
38
use Platine\OAuth2\Response\OAuthJsonResponse;
39
40
/**
41
 * @class BaseGrant
42
 * @package Platine\OAuth2\Grant
43
 */
44
abstract class BaseGrant implements GrantInterface
45
{
46
    /**
47
     * {@inheritdoc}
48
     */
49
    public function getType(): string
50
    {
51
        return static::GRANT_TYPE;
52
    }
53
54
    /**
55
     * {@inheritdoc}
56
     */
57
    public function getResponseType(): string
58
    {
59
        return static::GRANT_RESPONSE_TYPE;
60
    }
61
62
    /**
63
     * Generate the token response
64
     * @param AccessToken $accessToken
65
     * @param RefreshToken|null $refreshToken
66
     * @param bool $useRefreshTokenScopes
67
     * @return ResponseInterface
68
     */
69
    protected function generateTokenResponse(
70
        AccessToken $accessToken,
71
        ?RefreshToken $refreshToken = null,
72
        bool $useRefreshTokenScopes = false
73
    ): ResponseInterface {
74
        $owner = $accessToken->getOwner();
75
        if ($useRefreshTokenScopes && $refreshToken !== null) {
76
            $scopes = $refreshToken->getScopes();
77
        } else {
78
            $scopes = $accessToken->getScopes();
79
        }
80
81
        $body = [
82
            'access_token' => $accessToken->getToken(),
83
            'token_type' => 'Bearer',
84
            'expires_in' => $accessToken->getExpiresIn(),
85
            'scope' => implode(' ', $scopes),
86
            'owner_id' => $owner !== null ? $owner->getOwnerId() : null,
87
        ];
88
        if ($refreshToken !== null) {
89
            $body['refresh_token'] = $refreshToken->getToken();
90
        }
91
92
        return new OAuthJsonResponse(array_filter($body));
93
    }
94
}
95