Source for file SREG10.php

Documentation is available at SREG10.php

  1. <?php
  2. /**
  3.  * OpenID_Extension_SREG10
  4.  * 
  5.  * PHP Version 5.2.0+
  6.  * 
  7.  * @uses      OpenID_Extension
  8.  * @category  Auth
  9.  * @package   OpenID
  10.  * @author    Bill Shupp <hostmaster@shupp.org>
  11.  * @copyright 2009 Bill Shupp
  12.  * @license   http://www.opensource.org/licenses/bsd-license.php FreeBSD
  13.  * @link      http://pearopenid.googlecode.com
  14.  */
  15.  
  16. /**
  17.  * Required files
  18.  */
  19. require_once 'OpenID/Extension.php';
  20.  
  21. /**
  22.  * Implementation of the Simple Registration Extension version 1.0.  See
  23.  * {@link http://openid.net/specs/openid-simple-registration-extension-1_0.html} for
  24.  * more information on this extension.
  25.  * 
  26.  * Example usage:
  27.  * 
  28.  * <code>
  29.  *  $sreg = new OpenID_Extension_SREG10(OpenID_Extension::REQUEST);
  30.  *  $sreg->set('required', 'email');
  31.  *  $sreg->set('optional', 'nickname,gender,dob');
  32.  *  // Add to an existing instance of OpenID_Auth_Request
  33.  *  $authRequest->addExtension($sreg);
  34.  * </code>
  35.  * 
  36.  * @uses      OpenID_Extension
  37.  * @category  Auth
  38.  * @package   OpenID
  39.  * @author    Bill Shupp <hostmaster@shupp.org>
  40.  * @copyright 2009 Bill Shupp
  41.  * @license   http://www.opensource.org/licenses/bsd-license.php FreeBSD
  42.  * @link      http://pearopenid.googlecode.com
  43.  */
  44. class OpenID_Extension_SREG10 extends OpenID_Extension
  45. {
  46.     /**
  47.      * Disables NS use, since this extension was done before OpenID 2.0
  48.      * 
  49.      * @var bool 
  50.      */
  51.     protected $useNamespaceAlias = false;
  52.  
  53.     /**
  54.      * The alias to use.
  55.      * 
  56.      * @var string 
  57.      */
  58.     protected $alias = 'sreg';
  59.  
  60.     /**
  61.      * Supported keys in a request
  62.      * 
  63.      * @var array 
  64.      */
  65.     protected $requestKeys = array(
  66.         'required',
  67.         'optional',
  68.         'policy_url'
  69.     );
  70.  
  71.     /**
  72.      * Supported keys in a response
  73.      * 
  74.      * @var array 
  75.      */
  76.     protected $responseKeys = array(
  77.         'nickname',
  78.         'email',
  79.         'fullname',
  80.         'dob',
  81.         'gender',
  82.         'postcode',
  83.         'country',
  84.         'language',
  85.         'timezone'
  86.     );
  87. }
  88. ?>

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