Docs For Class OpenID_Assertion

Description

A class that represents the result of verifying an assertion.

author: Bill Shupp <hostmaster@shupp.org>
copyright: 2009 Bill Shupp
link: http://pearopenid.googlecode.com
license: FreeBSD

Located in /OpenID/Assertion/Result.php (line 31)

Variable Summary

bool $assertion

string $assertionMethod

OpenID_Message $checkAuthResponse

string $userSetupURL

Method Summary

string getAssertionMethod ()

OpenID_Message getCheckAuthResponse ()

string getUserSetupURL ()

void setAssertionMethod (string $method)

void setAssertionResult (bool $value)

void setCheckAuthResponse (OpenID_Message $message)

void setUserSetupURL (string $url)

bool success ()

Variables

bool $assertion = false (line 60)

Whether the assertion was positive or negative

access: protected

string $assertionMethod = null (line 53)

What assertion method was used (association, check_authentication)

access: protected

OpenID_Message $checkAuthResponse = null (line 38)

The check_authentication response

access: protected

string $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

Methods

getAssertionMethod (line 114)

Gets the method used to verify the assertion

access: public

string getAssertionMethod ()

getCheckAuthResponse (line 82)

Gets the check_authentication response

see: OpenID_Assertion_Result::setCheckAuthResponse()
access: public

OpenID_Message getCheckAuthResponse ()

getUserSetupURL (line 161)

Returns the openid.user_setup_url value from the response

access: public

string getUserSetupURL ()

setAssertionMethod (line 127)

Sets the assertion method used to verify the assertion

throws: OpenID_Assertion_Exception on invalid assertion mode
access: public

void setAssertionMethod (string $method)

string $method: Method used

setAssertionResult (line 104)

Sets the result of verifying the assertion.

access: public

void setAssertionResult (bool $value)

bool $value: true if successful, false otherwise

setCheckAuthResponse (line 71)

Sets the check_authentication response in the form of an OpenID_Message instance

see: OpenID_Assertion_Result::getCheckAuthResponse()
access: public

void setCheckAuthResponse (OpenID_Message $message)

OpenID_Message $message: The response message

setUserSetupURL (line 151)

Sets the openid.user_setup_url from the OP negative response

access: public

void setUserSetupURL (string $url)

string $url: The URL from openid.user_setup_url

success (line 92)

Indicates if the assertion was successful (positive) or not (negative)

return: true on if a positive assertion was verified, false otherwise
access: public

bool success ()

Class OpenID_Assertion_Result