Source for file UI.php

Documentation is available at UI.php

  1. <?php
  2. /**
  3.  * OpenID_Extension_UI
  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.  * Provides support for the UI extension
  23.  * 
  24.  * @uses      OpenID_Extension
  25.  * @category  Auth
  26.  * @package   OpenID
  27.  * @author    Bill Shupp <hostmaster@shupp.org>
  28.  * @copyright 2009 Bill Shupp
  29.  * @license   http://www.opensource.org/licenses/bsd-license.php FreeBSD
  30.  * @link      http://pearopenid.googlecode.com
  31.  */
  32. class OpenID_Extension_UI extends OpenID_Extension
  33. {
  34.     /**
  35.      * URI of the UI namespace
  36.      * 
  37.      * @var string 
  38.      */
  39.     protected $namespace ='http://specs.openid.net/extensions/ui/1.0';
  40.  
  41.     /**
  42.      * Alias to use
  43.      * 
  44.      * @var string 
  45.      */
  46.     protected $alias = 'ui';
  47.  
  48.     /**
  49.      * Valid modes (only 'popup' so far)
  50.      * 
  51.      * @var array 
  52.      */
  53.     protected $validModes = array('popup');
  54.  
  55.     /**
  56.      * Adds mode checking to set()
  57.      * 
  58.      * @param mixed $key   Key
  59.      * @param mixed $value Value
  60.      * 
  61.      * @return void 
  62.      */
  63.     public function set($key, $value)
  64.     {
  65.         if (strpos($key, 'mode') === 0
  66.             && !in_array($value, $this->validModes)) {
  67.  
  68.             throw new OpenID_Extension_Exception('Invalid UI mode: ' . $key);
  69.         }
  70.  
  71.         parent::set($key, $value);
  72.     }
  73. }
  74. ?>

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