Main class of OneLogin's PHP Toolkit
__construct(array $oldSettings = null)
array
Setting data
getSettings() : array
array
The settings data.
setStrict(boolean $value) : array
boolean
Strict parameter
array
The settings data.
processResponse(string $requestId = null)
string
The ID of the AuthNRequest sent by this SP to the IdP
processSLO(boolean $keepLocalSession = false, string $requestId = null)
boolean
When false will destroy the local session, otherwise will destroy it
string
The ID of the LogoutRequest sent by this SP to the IdP
redirectTo(string $url = '', array $parameters = array())
string
The target URL to redirect the user.
array
Extra parameters to be passed as part of the url
isAuthenticated() : boolean
boolean
True if the user is authenticated
getAttributes() : array
array
Attributes of the user.
getNameId() : string
string
The nameID of the assertion
getSessionIndex() : string
string
The SessionIndex of the assertion
getErrors() : array
array
Errors
getLastErrorReason() : string
String
Error
getAttribute(string $name) : NULL || Array
string
The requested attribute of the user.
NULL
|| array Requested SAML attribute ($name).
login(string $returnTo = null, $parameters = array(), $forceAuthn = false, $isPassive = false)
string
The target URL the user should be returned to after login.
array
Extra parameters to be added to the GET.
bool
When true the AuthNReuqest will set the ForceAuthn='true'.
bool
When true the AuthNReuqest will set the Ispassive='true'.
logout(string $returnTo = null, array $parameters = array(), string $nameId = null, string $sessionIndex = null)
string
The target URL the user should be returned to after logout.
array
Extra parameters to be added to the GET.
string
The NameID that will be set in the LogoutRequest.
string
The SessionIndex (taken from the SAML Response in the SSO process).
getSSOurl() : string
string
The url of the Single Sign On Service
getSLOurl() : string
string
The url of the Single Logout Service
buildRequestSignature(string $samlRequest, string $relayState) : string
string
The SAML Request
string
The RelayState
string
A base64 encoded signature
buildResponseSignature(string $samlResponse, string $relayState) : string
string
The SAML Response
string
The RelayState
string
A base64 encoded signature
_settings : array
var | |
---|---|
array
_attributes : array
var | |
---|---|
array
_nameid : string
var | |
---|---|
string
_authenticated : boolean
var | |
---|---|
boolean
_sessionIndex : string
var | |
---|---|
boolean
_errors : array
var | |
---|---|
array