\OCLCUser

A class that represents an OCLC User.

The User has principalID, principalIDNS, and institution

Summary

Methods
Properties
Constants
__construct()
getPrincipalID()
getPrincipalIDNS()
getAuthenticatingInstitutionID()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
$principalID
$principalIDNS
$authenticatingInstitutionID
N/A

Properties

$principalID

$principalID : string

principal ID

Type

string

$principalIDNS

$principalIDNS : string

principal identity namespace

Type

string

$authenticatingInstitutionID

$authenticatingInstitutionID : integer

Authenticating institution id

Type

integer

Methods

__construct()

__construct(integer  $authenticatingInstitutionID, string  $principalID = null, string  $principalIDNS = null) 

Construct a new user object to pass to the WSKey object when building an HMAC signature of using client credentials grant

Parameters

integer $authenticatingInstitutionID
string $principalID
string $principalIDNS

Throws

\BadMethodCallException

getPrincipalID()

getPrincipalID() : string

Getter for the principalID

Returns

string

getPrincipalIDNS()

getPrincipalIDNS() : string

Getter for the principalID

Returns

string

getAuthenticatingInstitutionID()

getAuthenticatingInstitutionID() : integer

Getter for the authenticatingInstitutionID

Returns

integer