Abstract Class Yiisoft\Yii\AuthClient\OAuth

                public function __construct(
    ClientInterface $httpClient,
    RequestFactoryInterface $requestFactory,
    StateStorageInterface $stateStorage,
    protected YiisoftFactory $factory,
) {
    parent::__construct($httpClient, $requestFactory, $stateStorage);
}

            

                public function api($apiSubUrl, $method = 'GET', $data = [], $headers = []): array
{
    $request = $this->createApiRequest($method, $apiSubUrl);
    $request = RequestUtil::addHeaders($request, $headers);
    if (!empty($data)) {
        if (is_array($data)) {
            $request = RequestUtil::addParams($request, $data);
        } else {
            $request->getBody()->write($data);
        }
    }
    $request = $this->beforeApiRequestSend($request);
    $response = $this->sendRequest($request);
    if ($response->getStatusCode() !== 200) {
        throw new InvalidResponseException(
            $response,
            'Request failed with code: ' . $response->getStatusCode() . ', message: ' . $response->getBody(),
        );
    }
    return (array) Json::decode($response->getBody()->getContents());
}

            

                abstract public function applyAccessTokenToRequest(
    RequestInterface $request,
    OAuthToken $accessToken,
): RequestInterface;

            

                public function beforeApiRequestSend(RequestInterface $request): RequestInterface
{
    $accessToken = $this->getAccessToken();
    if (!is_object($accessToken) || !$accessToken->getIsValid()) {
        throw new Exception('Invalid access token.');
    }
    return $this->applyAccessTokenToRequest($request, $accessToken);
}

            

                public function createApiRequest(string $method, string $uri): RequestInterface
{
    return $this->createRequest($method, $this->endpoint . $uri);
}

            

                protected function createToken(array $tokenConfig): OAuthToken
{
    if (!array_key_exists('class', $tokenConfig)) {
        $tokenConfig['class'] = OAuthToken::class;
    }
    /** @var OAuthToken $token */
    $token = $this->factory->create($tokenConfig['class']);
    if (isset($tokenConfig['params']) && is_array($tokenConfig['params'])) {
        $token->setParams($tokenConfig['params']);
    }
    if (isset($tokenConfig['tokenParamKey']) && is_string($tokenConfig['tokenParamKey'])) {
        $token->setTokenParamKey($tokenConfig['tokenParamKey']);
    }
    return $token;
}

            

                protected function defaultReturnUrl(ServerRequestInterface $request): string
{
    return (string) $request->getUri();
}

            

                public function getAccessToken(): ?OAuthToken
{
    if (!is_object($this->accessToken)) {
        $this->accessToken = $this->restoreAccessToken();
    }
    return $this->accessToken;
}

            

                protected function getDefaultScope(): string
{
    return '';
}

            

                public function getReturnUrl(ServerRequestInterface $request): string
{
    if ($this->returnUrl === '') {
        $this->returnUrl = $this->defaultReturnUrl($request);
    }
    return $this->returnUrl;
}

            

                public function getScope(): string
{
    if ($this->scope === null) {
        return $this->getDefaultScope();
    }
    return $this->scope;
}

            

                public function getYiisoftFactory(): YiisoftFactory
{
    return $this->factory;
}

            

                abstract public function refreshAccessToken(OAuthToken $token): OAuthToken;

            

                protected function restoreAccessToken(): ?OAuthToken
{
    if (($token = $this->getState('token')) instanceof OAuthToken) {
        if ($token->getIsExpired() && $this->autoRefreshAccessToken) {
            return $this->refreshAccessToken($token);
        }
        return $token;
    }
    return null;
}

            

                protected function saveAccessToken(?OAuthToken $token = null): self
{
    return $this->setState('token', $token);
}

            

                public function setAccessToken(array|OAuthToken $token): void
{
    if (is_array($token) && !empty($token)) {
        $newToken = $this->createToken($token);
        $this->accessToken = $newToken;
        $this->saveAccessToken($newToken);
    }
    if ($token instanceof OAuthToken) {
        $this->accessToken = $token;
        $this->saveAccessToken($token);
    }
}

            

                public function setAuthUrl(string $authUrl): void
{
    $this->authUrl = $authUrl;
}

            

                public function setReturnUrl(string $returnUrl): void
{
    $this->returnUrl = $returnUrl;
}

            

                public function setScope(string $scope): void
{
    $this->scope = $scope;
}

            

                public function setYiisoftFactory(YiisoftFactory $factory): void
{
    $this->factory = $factory;
}