[Summary view] [Print] [Text view]

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