[Summary view] [Print] [Text view]

   1  <?php
   2  
   3  /**
   4   * An interface for OpenID extensions.
   5   *
   6   * @package OpenID
   7   */
   8  
   9  // Do not allow direct access
  10  defined( '_JEXEC' ) or die( 'Restricted access' );
  11  
  12  /**
  13   * Require the Message implementation.
  14   */
  15  require_once 'Auth/OpenID/Message.php';
  16  
  17  /**
  18   * A base class for accessing extension request and response data for
  19   * the OpenID 2 protocol.
  20   *
  21   * @package OpenID
  22   */
  23  class Auth_OpenID_Extension {
  24      /**
  25       * ns_uri: The namespace to which to add the arguments for this
  26       * extension
  27       */
  28      var $ns_uri = null;
  29      var $ns_alias = null;
  30  
  31      /**
  32       * Get the string arguments that should be added to an OpenID
  33       * message for this extension.
  34       */
  35      function getExtensionArgs()
  36      {
  37          return null;
  38      }
  39  
  40      /**
  41       * Add the arguments from this extension to the provided message.
  42       *
  43       * Returns the message with the extension arguments added.
  44       */
  45      function toMessage(&$message)
  46      {
  47          $implicit = $message->isOpenID1();
  48          $added = $message->namespaces->addAlias($this->ns_uri,
  49                                                  $this->ns_alias,
  50                                                  $implicit);
  51  
  52          if ($added === null) {
  53              if ($message->namespaces->getAlias($this->ns_uri) !=
  54                  $this->ns_alias) {
  55                  return null;
  56              }
  57          }
  58  
  59          $message->updateArgs($this->ns_uri,
  60                               $this->getExtensionArgs());
  61          return $message;
  62      }
  63  }
  64  
  65  ?>