CurlAuthPlugin
in package
implements
EventSubscriberInterface
Adds specified curl auth to all requests sent from a client. Defaults to CURLAUTH_BASIC if none supplied.
Use $client->getConfig()->setPath('request.options/auth', array('user', 'pass', 'Basic|Digest');
Table of Contents
Interfaces
- EventSubscriberInterface
- An EventSubscriber knows himself what events he is interested in.
Properties
Methods
- __construct() : mixed
- getSubscribedEvents() : array<string|int, mixed>
- Returns an array of event names this subscriber wants to listen to.
- onRequestCreate() : mixed
- Add basic auth
Properties
$password
private
mixed
$password
$scheme
private
mixed
$scheme
$username
private
mixed
$username
Methods
__construct()
public
__construct(string $username, string $password[, int $scheme = CURLAUTH_BASIC ]) : mixed
Parameters
- $username : string
-
HTTP basic auth username
- $password : string
-
Password
- $scheme : int = CURLAUTH_BASIC
-
Curl auth scheme
getSubscribedEvents()
Returns an array of event names this subscriber wants to listen to.
public
static getSubscribedEvents() : array<string|int, mixed>
The array keys are event names and the value can be:
- The method name to call (priority defaults to 0)
- An array composed of the method name to call and the priority
- An array of arrays composed of the method names to call and respective priorities, or 0 if unset
For instance:
- array('eventName' => 'methodName')
- array('eventName' => array('methodName', $priority))
- array('eventName' => array(array('methodName1', $priority), array('methodName2')))
Return values
array<string|int, mixed> —The event names to listen to
onRequestCreate()
Add basic auth
public
onRequestCreate(Event $event) : mixed
Parameters
- $event : Event