PHP Class OneLogin_Saml2_AuthnRequest

Show file Open project: onelogin/php-saml Class Usage Examples

Protected Properties

Property	Type	Description
$_settings	OneLogin_Saml2_Settings	Object that represents the setting info

Public Methods

Method	Description
__construct ( OneLogin_Saml2_Settings $settings, boolean $forceAuthn = false, boolean $isPassive = false, boolean $setNameIdPolicy = true )	Constructs the AuthnRequest object.
getId ( ) : string	Returns the AuthNRequest ID.
getRequest ( boolean \| null $deflate = null )	Returns deflated, base64 encoded, unsigned AuthnRequest.

Method Details

__construct() public method

Constructs the AuthnRequest object.

public __construct ( OneLogin_Saml2_Settings $settings, boolean $forceAuthn = false, boolean $isPassive = false, boolean $setNameIdPolicy = true )
$settings	OneLogin_Saml2_Settings	Settings
$forceAuthn	boolean	When true the AuthNReuqest will set the ForceAuthn='true'
$isPassive	boolean	When true the AuthNReuqest will set the Ispassive='true'
$setNameIdPolicy	boolean	When true the AuthNReuqest will set a nameIdPolicy

getId() public method

Returns the AuthNRequest ID.

public getId ( ) : string
return	string

getRequest() public method

Returns deflated, base64 encoded, unsigned AuthnRequest.

public getRequest ( boolean \| null $deflate = null )
$deflate	boolean \| null	Whether or not we should 'gzdeflate' the request body before we return it.

Property Details

$_settings protected property

Object that represents the setting info

protected OneLogin_Saml2_Settings $_settings
return	OneLogin_Saml2_Settings