ConstantsService
in package
Some constants we use in the code.
Table of Contents
- $apiConfig : ImmutableConfig
- The modules API config.
- $apiSettings : array<string|int, mixed>
- The modules API settings like the Client ID.
- $configFactory : ConfigFactoryInterface
- The config factory interface.
- $request : Request
- The request object.
- $authorizePath : string
- The authorize endpoint path.
- $authorizeRoot : string
- The authorize endpoint root.
- $redirectUrl : string
- The url where Microsoft will redirect us too.
- $tokenPath : string
- The token endpoint path.
- $tokenRoot : string
- The token endpoint root.
- $userTempStoreDataName : string
- The name of the data saved in the temp store.
- $userTempStoreName : string
- The name of the temp store.
- __construct() : mixed
- Constructs a new ConstantsService object.
- getAuthorizeUrl() : string
- Get the authorize url.
- getRedirectUrl() : string
- Get the redirect URL.
- getTokenUrl() : string
- Get the token url.
- getUserTempStoreDataName() : string
- Get the user temp store data name.
- getUserTempStoreName() : string
- Get the user temp store name.
- getTenant() : array<string|int, mixed>|mixed|string|null
- Get the tenant ID.
Properties
$apiConfig
The modules API config.
protected
ImmutableConfig
$apiConfig
$apiSettings
The modules API settings like the Client ID.
protected
array<string|int, mixed>
$apiSettings
$configFactory
The config factory interface.
protected
ConfigFactoryInterface
$configFactory
$request
The request object.
protected
Request
$request
$authorizePath
The authorize endpoint path.
private
string
$authorizePath
= '/oauth2/v2.0/authorize'
$authorizeRoot
The authorize endpoint root.
private
string
$authorizeRoot
= 'https://login.microsoftonline.com/'
$redirectUrl
The url where Microsoft will redirect us too.
private
string
$redirectUrl
= '/o365/callback'
$tokenPath
The token endpoint path.
private
string
$tokenPath
= '/oauth2/v2.0/token'
$tokenRoot
The token endpoint root.
private
string
$tokenRoot
= 'https://login.microsoftonline.com/'
$userTempStoreDataName
The name of the data saved in the temp store.
private
string
$userTempStoreDataName
= 'o365AuthData'
$userTempStoreName
The name of the temp store.
private
string
$userTempStoreName
= 'o365.tempstore'
Methods
__construct()
Constructs a new ConstantsService object.
public
__construct(ConfigFactoryInterface $configFactory, RequestStack $requestStack, HelperService $helperService) : mixed
Parameters
- $configFactory : ConfigFactoryInterface
-
The config factory interface.
- $requestStack : RequestStack
-
The request stack object.
- $helperService : HelperService
-
The helper service used to get the api settings.
Return values
mixed —getAuthorizeUrl()
Get the authorize url.
public
getAuthorizeUrl() : string
Return values
string —The authorize url.
getRedirectUrl()
Get the redirect URL.
public
getRedirectUrl() : string
Return values
string —The redirect url.
getTokenUrl()
Get the token url.
public
getTokenUrl() : string
Return values
string —The token url.
getUserTempStoreDataName()
Get the user temp store data name.
public
getUserTempStoreDataName() : string
Return values
string —The user temp store data name.
getUserTempStoreName()
Get the user temp store name.
public
getUserTempStoreName() : string
Return values
string —The user temp store name.
getTenant()
Get the tenant ID.
private
getTenant() : array<string|int, mixed>|mixed|string|null
Return values
array<string|int, mixed>|mixed|string|null —The tenant ID.