Class SimpleID\Protocols\OAuth\OAuthProtectedResource

`extends`	`Module`

Base class for SimpleID modules providing access to resources protected by OAuth.

This class contains various convenience functions to OAuthManager and its methods.

Prefab
- SimpleID\Module
  - SimpleID\Protocols\OAuth\OAuthProtectedResource
    - SimpleID\Protocols\Connect\ConnectClientRegistrationModule
    - SimpleID\Protocols\Connect\ConnectModule implements ProtocolResult

Located at core/Protocols/OAuth/OAuthProtectedResource.php

Methods


					
	public

__construct()


					
	public

beforeroute(): void

FatFree Framework event handler.

This event handler initialises the user system. It starts the PHP session and loads data for the currently logged-in user, if any.


					
	protected

getAccessToken(): AccessToken

Returns the current access token.

This is a shortcut for SimpleID\Protocols\OAuth\OAuthManager::getAccessToken()

Returns

the access token


					
	protected

getAuthorization(): Authorization|null

Returns the authorisation associated with the current access token.

This is a shortcut for SimpleID\Protocols\OAuth\OAuthManager::getAuthorization()

Returns

the authorisation


					
	protected

getTokenOwner(): Storable|null

Returns the owner of the authorisation associated with the current access token.

This is a shortcut for SimpleID\Protocols\OAuth\Authorization::getOwner()

Returns

the owner


					
	protected

getTokenClient(): Storable|null

Returns the client of the authorisation associated with the current access token.

This is a shortcut for SimpleID\Protocols\OAuth\Authorization::getClient()

Returns

the client


					
	protected

isTokenAuthorized(array<string>|string $scope, string &$error = null): bool

Returns whether the current access token is authorised under the specified scope.

This is a shortcut for SimpleID\Protocols\OAuth\OAuthManager::isTokenAuthorized()

Parameters

`$scope`	the scope
`$error`	the error code returned if the access token is not authorised

Returns

true if the access token is authorised


					
	protected

unauthorizedError(
	string $error,
	string $error_description = null,
	array<string, string> $additional = [],
	string $format = 'html',
	int $status = 401,
): void

Sends an OAuth unauthorised response with a WWW-Authenticate header.

Parameters

`$error`	the error code
`$error_description`	human readable error information
`$additional`	any additional data to be sent with the error message
`$format`	the format of the error message
`$status`	the HTTP status to send

Methods inherited from SimpleID\Module
`init(), isHttps(), checkHttps(), getCanonicalURL(), getCanonicalHost(), getOrigin(), fatalError(), secureCompare()`

Properties
`protected`	`OAuthManager`	`$oauth` the OAuth manager the OAuth manager	#
`protected`	`bool`	`$oauth_include_request_body = false` whether to detect access tokens from the request body whether to detect access tokens from the request body	#

Properties inherited from SimpleID\Module
`$f3, $logger`

Namespaces

Classes

Interfaces

Class SimpleID\Protocols\OAuth\OAuthProtectedResource

Returns

Returns

Returns

Returns

Parameters

Returns

Parameters