File src/Guzzle/Plugin/CurlAuth/CurlAuthPlugin.php | Omnipay Fat Zebra / Paystream Gateway Module API Documentation

Namespaces

Guzzle
- Batch
  - Exception
- Cache
- Common
  - Exception
- Http
  - Curl
  - Exception
  - Message
    - Header
  - QueryAggregator
- Inflection
- Iterator
- Log
- Parser
  - Cookie
  - Message
  - UriTemplate
  - Url
- Plugin
  - Async
  - Backoff
  - Cache
  - Cookie
    - CookieJar
    - Exception
  - CurlAuth
  - ErrorResponse
    - Exception
  - History
  - Log
  - Md5
  - Mock
  - Oauth
- Service
  - Builder
  - Command
    - Factory
    - LocationVisitor
      - Request
      - Response
  - Description
  - Exception
  - Resource
- Stream
- Tests
  - Batch
  - Cache
  - Common
    - Cache
    - Exception
  - Http
    - Curl
    - Exception
    - Message
      - Header
  - Inflection
  - Iterator
  - Log
  - Message
  - Mock
  - Parser
    - Cookie
    - Message
  - Parsers
    - UriTemplate
  - Plugin
    - Async
    - Backoff
    - Cache
    - Cookie
      - CookieJar
    - CurlAuth
    - ErrorResponse
    - History
    - Log
    - Md5
    - Mock
    - Oauth
    - Redirect
  - Service
    - Builder
    - Command
      - LocationVisitor
        
        Request
        
        Response
    - Description
    - Exception
    - Mock
      - Command
        
        Sub
      - Model
    - Resource
  - Stream
None
Omnipay
- Common
  - Exception
  - Message
- Dummy
  - Message
- Fatzebra
  - Message
PHP

Classes

Interfaces

Exceptions

 1:  2:  3:  4:  5:  6:  7:  8:  9: 10: 11: 12: 13: 14: 15: 16: 17: 18: 19: 20: 21: 22: 23: 24: 25: 26: 27: 28: 29: 30: 31: 32: 33: 34: 35: 36: 37: 38: 39: 40: 41: 42: 43: 44: 45: 46: 47:

<?php

namespace Guzzle\Plugin\CurlAuth;

use Guzzle\Common\Event;
use Guzzle\Common\Version;
use Symfony\Component\EventDispatcher\EventSubscriberInterface;

/**
 * Adds specified curl auth to all requests sent from a client. Defaults to CURLAUTH_BASIC if none supplied.
 * @deprecated Use $client->getConfig()->setPath('request.options/auth', array('user', 'pass', 'Basic|Digest');
 */
class CurlAuthPlugin implements EventSubscriberInterface
{
    private $username;
    private $password;
    private $scheme;

    /**
     * @param string $username HTTP basic auth username
     * @param string $password Password
     * @param int    $scheme   Curl auth scheme
     */
    public function __construct($username, $password, $scheme=CURLAUTH_BASIC)
    {
        Version::warn(__CLASS__ . " is deprecated. Use \$client->getConfig()->setPath('request.options/auth', array('user', 'pass', 'Basic|Digest');");
        $this->username = $username;
        $this->password = $password;
        $this->scheme = $scheme;
    }

    public static function getSubscribedEvents()
    {
        return array('client.create_request' => array('onRequestCreate', 255));
    }

    /**
     * Add basic auth
     *
     * @param Event $event
     */
    public function onRequestCreate(Event $event)
    {
        $event['request']->setAuth($this->username, $this->password, $this->scheme);
    }
}