Source for file Result.php

Documentation is available at Result.php

  1. <?php
  2. /**
  3.  * OpenID_Assertion_Result
  4.  * 
  5.  * PHP Version 5.2.0+
  6.  * 
  7.  * @category  Auth
  8.  * @package   OpenID
  9.  * @author    Bill Shupp <hostmaster@shupp.org>
  10.  * @copyright 2009 Bill Shupp
  11.  * @license   http://www.opensource.org/licenses/bsd-license.php FreeBSD
  12.  * @link      http://pearopenid.googlecode.com
  13.  */
  14.  
  15. /**
  16.  * Required files
  17.  */
  18. require_once 'OpenID.php';
  19. require_once 'OpenID/Assertion/Exception.php';
  20.  
  21. /**
  22.  * A class that represents the result of verifying an assertion.
  23.  * 
  24.  * @category  Auth
  25.  * @package   OpenID
  26.  * @author    Bill Shupp <hostmaster@shupp.org>
  27.  * @copyright 2009 Bill Shupp
  28.  * @license   http://www.opensource.org/licenses/bsd-license.php FreeBSD
  29.  * @link      http://pearopenid.googlecode.com
  30.  */
  31. class OpenID_Assertion_Result
  32. {
  33.     /**
  34.      * The check_authentication response
  35.      * 
  36.      * @var OpenID_Message 
  37.      */
  38.     protected $checkAuthResponse = null;
  39.  
  40.     /**
  41.      * The value of openid.user_setup_url, which is returned on a 1.1 negative
  42.      * response to a checkid_immediate request
  43.      * 
  44.      * @var string 
  45.      */
  46.     protected $userSetupURL = null;
  47.  
  48.     /**
  49.      * What assertion method was used (association, check_authentication)
  50.      * 
  51.      * @var string 
  52.      */
  53.     protected $assertionMethod = null;
  54.  
  55.     /**
  56.      * Whether the assertion was positive or negative
  57.      * 
  58.      * @var bool 
  59.      */
  60.     protected $assertion = false;
  61.  
  62.     /**
  63.      * Sets the check_authentication response in the form of an OpenID_Message
  64.      * instance
  65.      * 
  66.      * @param OpenID_Message $message The response message
  67.      * 
  68.      * @see getCheckAuthResponse()
  69.      * @return void 
  70.      */
  71.     public function setCheckAuthResponse(OpenID_Message $message)
  72.     {
  73.         $this->checkAuthResponse = $message;
  74.     }
  75.  
  76.     /**
  77.      * Gets the check_authentication response
  78.      * 
  79.      * @see setCheckAuthResponse()
  80.      * @return OpenID_Message 
  81.      */
  82.     public function getCheckAuthResponse()
  83.     {
  84.         return $this->checkAuthResponse;
  85.     }
  86.  
  87.     /**
  88.      * Indicates if the assertion was successful (positive) or not (negative)
  89.      *
  90.      * @return bool true on if a positive assertion was verified, false otherwise
  91.      */
  92.     public function success()
  93.     {
  94.         return $this->assertion;
  95.     }
  96.  
  97.     /**
  98.      * Sets the result of verifying the assertion.
  99.      * 
  100.      * @param bool $value true if successful, false otherwise
  101.      * 
  102.      * @return void 
  103.      */
  104.     public function setAssertionResult($value)
  105.     {
  106.         $this->assertion = (bool)$value;
  107.     }
  108.  
  109.     /**
  110.      * Gets the method used to verify the assertion
  111.      * 
  112.      * @return string 
  113.      */
  114.     public function getAssertionMethod()
  115.     {
  116.         return $this->assertionMethod;
  117.     }
  118.  
  119.     /**
  120.      * Sets the assertion method used to verify the assertion
  121.      * 
  122.      * @param string $method Method used
  123.      * 
  124.      * @throws OpenID_Assertion_Exception on invalid assertion mode
  125.      * @return void 
  126.      */
  127.     public function setAssertionMethod($method)
  128.     {
  129.         switch ($method) {
  130.         case OpenID::MODE_ID_RES:
  131.         case OpenID::MODE_ASSOCIATE:
  132.         case OpenID::MODE_CHECKID_SETUP:
  133.         case OpenID::MODE_CHECKID_IMMEDIATE:
  134.         case OpenID::MODE_CHECK_AUTHENTICATION:
  135.         case OpenID::MODE_CANCEL:
  136.         case OpenID::MODE_SETUP_NEEDED:
  137.             $this->assertionMethod = $method;
  138.             break;
  139.         default:
  140.             throw new OpenID_Assertion_Exception('Invalid assertion method');
  141.         }
  142.     }
  143.  
  144.     /**
  145.      * Sets the openid.user_setup_url from the OP negative response
  146.      * 
  147.      * @param string $url The URL from openid.user_setup_url
  148.      * 
  149.      * @return void 
  150.      */
  151.     public function setUserSetupURL($url)
  152.     {
  153.         $this->userSetupURL = $url;
  154.     }
  155.  
  156.     /**
  157.      * Returns the openid.user_setup_url value from the response
  158.      * 
  159.      * @return string 
  160.      */
  161.     public function getUserSetupURL()
  162.     {
  163.         return $this->userSetupURL;
  164.     }
  165. }
  166. ?>

Documentation generated on Tue, 15 Dec 2009 19:00:59 -0800 by phpDocumentor 1.4.3