Source for file Interface.php

Documentation is available at Interface.php

  1. <?php
  2. /**
  3.  * OpenID_Discover_Interface
  4.  * 
  5.  * PHP Version 5.2.0+
  6.  * 
  7.  * @category  Auth
  8.  * @package   OpenID
  9.  * @author    Rich Schumacher <rich.schu@gmail.com>
  10.  * @copyright 2009 Rich Schumacher
  11.  * @license   http://www.opensource.org/licenses/bsd-license.php FreeBSD
  12.  * @link      http://pearopenid.googlecode.com
  13.  */
  14.  
  15. /**
  16.  * Describes the discovery driver interface
  17.  * 
  18.  * @category  Auth
  19.  * @package   OpenID
  20.  * @author    Rich Schumacher <rich.schu@gmail.com>
  21.  * @copyright 2009 Rich Schumacher
  22.  * @license   http://www.opensource.org/licenses/bsd-license.php FreeBSD
  23.  * @link      http://pearopenid.googlecode.com
  24.  */
  25. interface OpenID_Discover_Interface
  26. {
  27.     /**
  28.      * Constructor.  Sets the user supplied identifier.
  29.      * 
  30.      * @param string $identifier User supplied identifier
  31.      * 
  32.      * @return void 
  33.      */
  34.     public function __construct($identifier);
  35.  
  36.     /**
  37.      * Performs discovery on the user supplied identifier
  38.      * 
  39.      * @return bool true on success, false on failure
  40.      */
  41.     public function discover();
  42. }
  43.  
  44. ?>

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