OpenID
[ class tree: OpenID ] [ index: OpenID ] [ all elements ]

Class: OpenID_Assertion_Result

Source Location: /OpenID-0.4.0/OpenID/Assertion/Result.php

Class Overview


A class that represents the result of verifying an assertion.


Author(s):

Copyright:

  • 2009 Bill Shupp

Variables

Methods


Inherited Variables

Inherited Methods


Class Details

[line 31]
A class that represents the result of verifying an assertion.


[ Top ]


Class Variables

$assertion =  false

[line 60]

Whether the assertion was positive or negative
  • Access: protected

Type:   bool


[ Top ]

$assertionMethod =  null

[line 53]

What assertion method was used (association, check_authentication)
  • Access: protected

Type:   string


[ Top ]

$checkAuthResponse =  null

[line 38]

The check_authentication response
  • Access: protected

Type:   OpenID_Message


[ Top ]

$discover =  null

[line 69]

Discovered information as an instance of OpenID_Discover

Type:   OpenID_Discover|null


[ Top ]

$userSetupURL =  null

[line 46]

The value of openid.user_setup_url, which is returned on a 1.1 negative response to a checkid_immediate request
  • Access: protected

Type:   string


[ Top ]



Method Detail

getAssertionMethod   [line 123]

string getAssertionMethod( )

Gets the method used to verify the assertion
  • Access: public

[ Top ]

getCheckAuthResponse   [line 91]

OpenID_Message getCheckAuthResponse( )

Gets the check_authentication response

[ Top ]

getDiscover   [line 199]

OpenID_Discover|null getDiscover( )

Returns the discovered information about the identifer

[ Top ]

getUserSetupURL   [line 173]

string getUserSetupURL( )

Returns the openid.user_setup_url value from the response
  • Access: public

[ Top ]

setAssertionMethod   [line 136]

void setAssertionMethod( string $method)

Sets the assertion method used to verify the assertion
  • Throws: OpenID_Assertion_Exception on invalid assertion mode
  • Access: public

Parameters:

string   $method   —  Method used

[ Top ]

setAssertionResult   [line 113]

void setAssertionResult( bool $value)

Sets the result of verifying the assertion.
  • Access: public

Parameters:

bool   $value   —  true if successful, false otherwise

[ Top ]

setCheckAuthResponse   [line 80]

void setCheckAuthResponse( OpenID_Message $message)

Sets the check_authentication response in the form of an OpenID_Message instance

Parameters:

OpenID_Message   $message   —  The response message

[ Top ]

setDiscover   [line 187]

void setDiscover( OpenID_Discover $discover)

Sets the discovered information about the identifier

Parameters:

OpenID_Discover   $discover   —  An instance of OpenID_Discover

[ Top ]

setUserSetupURL   [line 163]

void setUserSetupURL( string $url)

Sets the openid.user_setup_url from the OP negative response
  • Access: public

Parameters:

string   $url   —  The URL from openid.user_setup_url

[ Top ]

success   [line 101]

bool success( )

Indicates if the assertion was successful (positive) or not (negative)
  • Return: true on if a positive assertion was verified, false otherwise
  • Access: public

[ Top ]


Documentation generated on Mon, 11 Mar 2019 15:57:49 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.