Source for file AX.php

Documentation is available at AX.php

  1. <?php
  2. /**
  3.  * OpenID_Extension_AX
  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. require_once 'Validate.php';
  21.  
  22. /**
  23.  * Support for the AX extension
  24.  * 
  25.  * @uses      OpenID_Extension
  26.  * @category  Auth
  27.  * @package   OpenID
  28.  * @author    Bill Shupp <hostmaster@shupp.org>
  29.  * @copyright 2009 Bill Shupp
  30.  * @license   http://www.opensource.org/licenses/bsd-license.php FreeBSD
  31.  * @link      http://pearopenid.googlecode.com
  32.  */
  33. class OpenID_Extension_AX extends OpenID_Extension
  34. {
  35.     /**
  36.      * URL for the openid.ns.ax parameter
  37.      * 
  38.      * @var string 
  39.      */
  40.     protected $namespace ='http://openid.net/srv/ax/1.0';
  41.  
  42.     /**
  43.      * Alias string to use
  44.      * 
  45.      * @var string 
  46.      */
  47.     protected $alias = 'ax';
  48.  
  49.     /**
  50.      * Valid modes for AX requests/responses
  51.      * 
  52.      * @var array 
  53.      */
  54.     protected $validModes = array(
  55.         'fetch_request',
  56.         'fetch_response',
  57.         'store_request',
  58.         'store_response_success',
  59.         'store_response_failure',
  60.     );
  61.  
  62.     /**
  63.      * Adds some validation checking when setting a key, then calls the parent set()
  64.      * 
  65.      * @param string $key   Message key
  66.      * @param mixed  $value Key's value
  67.      * 
  68.      * @return void 
  69.      */
  70.     public function set($key, $value)
  71.     {
  72.         if (strpos($key, 'mode') === 0
  73.             && !in_array($value, $this->validModes)) {
  74.  
  75.             throw new OpenID_Extension_Exception('Invalid AX mode: ' . $key);
  76.         }
  77.  
  78.         if (preg_match('/^type[.]/', $key)
  79.             && !Validate::uri($value)) {
  80.  
  81.             throw new OpenID_Extension_Exception($key . ' is not a valid URI');
  82.         }
  83.         parent::set($key, $value);
  84.     }
  85. }
  86. ?>

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