1. class
  2. Drupal
  3. \
  4. bankid
  5. \
  6. BankIDClient

BankIDClient

class BankIDClient extends Client

Class handling BankID integration.

You can't extend a final class. See https://github.com/mailjet/mailjet-apiv3-php/commit/2405918440bcc51c6f5441960cae3e4a5ce8dc94 for alternative solution.

Methods

__construct(ConfigFactory $config_factory, KeyRepository $key_repository, FileSystemInterface $file_system)

Constructs a new \Drupal\bankid\BankIDClient object.

BankIDResponse
start(OrderOperation $operation, string $endUserIp = '127.0.0.1', string $requirement = NULL, string $userVisibleData = NULL, string $userNonVisibleData = NULL, string $userVisibleDataFormat = NULL)

Authenticate a user using animated QR code.

BankIDResponse
phoneAuth(string $personalNumber, string $callInitiator, string $requirement = NULL, string $userVisibleData = NULL, string $userNonVisibleData = NULL, string $userVisibleDataFormat = NULL)

Authenticate a user over phone.

BankIDResponse
phoneSign(string $personalNumber, string $callInitiator, string $requirement = NULL, string $userVisibleData = NULL, string $userNonVisibleData = NULL, string $userVisibleDataFormat = NULL)

Request a signing order for a user over the phone.

BankIDResponse
collect(string $orderReference)

Collect an ongoing user request.

BankIDResponse
cancel(string $orderReference)

Cancel an ongoing order per the users request.

Details

at line 35
__construct(ConfigFactory $config_factory, KeyRepository $key_repository, FileSystemInterface $file_system)

Constructs a new \Drupal\bankid\BankIDClient object.

Parameters

ConfigFactory $config_factory

The config factory.
KeyRepository $key_repository

The key repository.
FileSystemInterface $file_system

The file system.

at line 97
BankIDResponse start(OrderOperation $operation, string $endUserIp = '127.0.0.1', string $requirement = NULL, string $userVisibleData = NULL, string $userNonVisibleData = NULL, string $userVisibleDataFormat = NULL)

Authenticate a user using animated QR code.

Parameters

OrderOperation $operation

BankID operation (endpoint).
string $endUserIp

The end user IP.
string $requirement

The requirement.
string $userVisibleData

The user visible data.
string $userNonVisibleData

The user non-visible data.
string $userVisibleDataFormat

The user visible data format.

Return Value

BankIDResponse

The BankID response.

at line 158
BankIDResponse phoneAuth(string $personalNumber, string $callInitiator, string $requirement = NULL, string $userVisibleData = NULL, string $userNonVisibleData = NULL, string $userVisibleDataFormat = NULL)

Authenticate a user over phone.

Parameters

string $personalNumber

The personal number.
string $callInitiator

The call initiator.
string $requirement

The requirement.
string $userVisibleData

The user visible data.
string $userNonVisibleData

The user non visible data.
string $userVisibleDataFormat

The user visible data format.

Return Value

BankIDResponse

The BankID response.

at line 215
BankIDResponse phoneSign(string $personalNumber, string $callInitiator, string $requirement = NULL, string $userVisibleData = NULL, string $userNonVisibleData = NULL, string $userVisibleDataFormat = NULL)

Request a signing order for a user over the phone.

Parameters

string $personalNumber

The personal number.
string $callInitiator

The call initiator.
string $requirement

The requirement.
string $userVisibleData

The user visible data.
string $userNonVisibleData

The user non visible data.
string $userVisibleDataFormat

The user visible data format.

Return Value

BankIDResponse

The BankID response.

at line 262
BankIDResponse collect(string $orderReference)

Collect an ongoing user request.

Parameters

string $orderReference

The order reference.

Return Value

BankIDResponse

The BankID response.

at line 290
BankIDResponse cancel(string $orderReference)

Cancel an ongoing order per the users request.

Parameters

string $orderReference

The order reference.

Return Value

BankIDResponse

The BankID response.