\OCLC\AuthAuthCode

A class that represents the Authorization code object

Summary

Methods

Properties

Constants

__construct()
getLoginUrl()

$authorizationServer

No constants found

No protected methods found

No protected properties found

N/A

No private methods found

$testMode
$clientId
$authenticatingInstitutionId
$contextInstitutionId
$redirectUri
$scope

N/A

File: Auth/AuthCode.php
Package: OCLC/Auth
Class hierarchy: \OCLC\Auth\AuthCode

Properties

$authorizationServer

$authorizationServer : string

The url for the authorization server

Type

string

$testMode

$testMode : boolean

Whether or not to run in test mode

Type

boolean

$clientId

$clientId : string

The key value of the WSKey

Type

string

$authenticatingInstitutionId

$authenticatingInstitutionId : integer

The authenticating institution id

Type

integer

$contextInstitutionId

$contextInstitutionId : integer

The context institution id

Type

integer

$redirectUri

$redirectUri : string

The redirect uri

Type

string

$scope

$scope : array

An array of scope values

Type

array

Methods

__construct()

__construct(string  $client_id, string  $redirectUri, array  $scope, array  $options = null)

Construct an Authorization Code object using

Parameters

string	$client_id
string	$redirectUri
array	$scope
array	$options	integer $authenticatingInstitutionId contextInstitutionId integer (optional) testMode boolean

getLoginUrl()

getLoginUrl() : string

Build the URL for logging user into Authorization Server

Returns

string