[Summary view] [Print] [Text view]

   1  <?php
   2  /**
   3   * Authentication provider interface
   4   *
   5   * @package Requests
   6   * @subpackage Authentication
   7   */
   8  
   9  /**
  10   * Authentication provider interface
  11   *
  12   * Implement this interface to act as an authentication provider.
  13   *
  14   * Parameters should be passed via the constructor where possible, as this
  15   * makes it much easier for users to use your provider.
  16   *
  17   * @see Requests_Hooks
  18   * @package Requests
  19   * @subpackage Authentication
  20   */
  21  interface Requests_Auth {
  22      /**
  23       * Register hooks as needed
  24       *
  25       * This method is called in {@see Requests::request} when the user has set
  26       * an instance as the 'auth' option. Use this callback to register all the
  27       * hooks you'll need.
  28       *
  29       * @see Requests_Hooks::register
  30       * @param Requests_Hooks $hooks Hook system
  31       */
  32  	public function register(Requests_Hooks $hooks);
  33  }