Source for file Interface.php

Documentation is available at Interface.php

  1. <?php
  2. /**
  3.  * OpenID_Store_Interface
  4.  * 
  5.  * PHP Version 5.2.0+
  6.  * 
  7.  * @category  Auth
  8.  * @package   OpenID
  9.  * @author    Bill Shupp <hostmaster@shupp.org>
  10.  * @author    Rich Schumacher <rich.schu@gmail.com>
  11.  * @copyright 2009 Bill Shupp, Rich Schumacher
  12.  * @license   http://www.opensource.org/licenses/bsd-license.php FreeBSD
  13.  * @link      http://pearopenid.googlecode.com
  14.  */
  15.  
  16. /**
  17.  * Defines the OpenID storage interface.
  18.  * 
  19.  * @category  Auth
  20.  * @package   OpenID
  21.  * @author    Bill Shupp <hostmaster@shupp.org>
  22.  * @author    Rich Schumacher <rich.schu@gmail.com>
  23.  * @copyright 2009 Bill Shupp, Rich Schumacher
  24.  * @license   http://www.opensource.org/licenses/bsd-license.php FreeBSD
  25.  * @link      http://pearopenid.googlecode.com
  26.  */
  27. interface OpenID_Store_Interface
  28. {
  29.     /**
  30.      *  Constants used for setting which type of storage is being used.
  31.      */
  32.     const TYPE_ASSOCIATION = 1;
  33.     const TYPE_DISCOVER    = 2;
  34.     const TYPE_NONCE       = 3;
  35.  
  36.     /**
  37.      * Gets an OpenID_Discover object from storage
  38.      * 
  39.      * @param string $identifier The normalized identifier that discovery was
  40.      *                            performed on
  41.      * 
  42.      * @return OpenID_Discover 
  43.      */
  44.     public function getDiscover($identifier);
  45.  
  46.     /**
  47.      * Stores an instance of OpenID_Discover
  48.      * 
  49.      * @param OpenID_Discover $discover Instance of OpenID_Discover
  50.      * @param int             $expire   How long to cache it for, in seconds
  51.      * 
  52.      * @return void 
  53.      */
  54.     public function setDiscover(OpenID_Discover $discover, $expire = null);
  55.  
  56.     /**
  57.      * Gets an OpenID_Assocation instance from storage
  58.      * 
  59.      * @param string $uri    The OP endpoint URI to get an association for
  60.      * @param string $handle The association handle if available
  61.      * 
  62.      * @return OpenID_Association 
  63.      */
  64.     public function getAssociation($uri, $handle = null);
  65.  
  66.     /**
  67.      * Stores an OpenID_Association instance.  Details (such as endpoint url and
  68.      * exiration) are retrieved from the object itself.
  69.      * 
  70.      * @param OpenID_Association $association Instance of OpenID_Association
  71.      * 
  72.      * @return void 
  73.      */
  74.     public function setAssociation(OpenID_Association $association);
  75.  
  76.     /**
  77.      * Deletes an association from storage
  78.      * 
  79.      * @param string $uri OP Endpoint URI
  80.      * 
  81.      * @return void 
  82.      */
  83.     public function deleteAssociation($uri);
  84.  
  85.     /**
  86.      * Gets a nonce from storage
  87.      * 
  88.      * @param string $nonce The nonce itself
  89.      * @param string $opURL The OP Endpoint URL it was used with
  90.      * 
  91.      * @return string 
  92.      */
  93.     public function getNonce($nonce, $opURL);
  94.  
  95.     /**
  96.      * Stores a nonce for an OP endpoint URL
  97.      * 
  98.      * @param string $nonce The nonce itself
  99.      * @param string $opURL The OP endpoint URL it was associated with
  100.      * 
  101.      * @return void 
  102.      */
  103.     public function setNonce($nonce, $opURL);
  104.  
  105.     /**
  106.      * Deletes a nonce from storage
  107.      * 
  108.      * @param string $nonce The nonce to delete
  109.      * @param string $opURL The OP endpoint URL it is associated with
  110.      * 
  111.      * @return void 
  112.      */
  113.     public function deleteNonce($nonce, $opURL);
  114. }
  115. ?>

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