Documentation

CurlAuthPlugin
in package
implements EventSubscriberInterface

Adds specified curl auth to all requests sent from a client. Defaults to CURLAUTH_BASIC if none supplied.

Tags
deprecated

Use $client->getConfig()->setPath('request.options/auth', array('user', 'pass', 'Basic|Digest');

Interfaces, Classes and Traits

EventSubscriberInterface
An EventSubscriber knows itself what events it is interested in.

Table of Contents

$password  : mixed
$scheme  : mixed
$username  : mixed
__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

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

Return values
mixed —

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:

  • ['eventName' => 'methodName']
  • ['eventName' => ['methodName', $priority]]
  • ['eventName' => [['methodName1', $priority], ['methodName2']]]

The code must not depend on runtime state as it will only be called at compile time. All logic depending on runtime state must be put into the individual methods handling the events.

Return values
array<string|int, mixed> —

The event names to listen to

onRequestCreate()

Add basic auth

public onRequestCreate(Event $event) : mixed
Parameters
$event : Event
Return values
mixed —

Search results