Class Porta\Psr14Event\Auth\Auth

`abstract`
`implements`	`AuthInterface`

Abstract sase class for event call authentification

Porta\Psr14Event\Auth\Auth implements AuthInterface
- Porta\Psr14Event\Auth\AuthBasic
- Porta\Psr14Event\Auth\AuthCustom

Located at Porta/psr14Event/Auth/Auth.php

Methods


					
	public

withAuthHeader(string $header): self

Set class to use custom auth header

PortaBilling support use of custom header instead of 'Aithorization:'. If you use custom header, use this method. You may chain it as (new AuthBasic($user,$pass))->withAuthHeader('Verify');

Parameters

$header

alternate auth header

Returns

for chaining


					
	public

authentificate(Event $event): Event

Perform authentification

The method takes Event, retrieves auth data and perform authentification.

In a case of success it returns the Event itself.
In a case of failure it will throw EventException with code 401

Returns

For chaining the methid with other methods

Throws

Porta\Psr14Event\EventException

with code 401 in a case of failure

Implements

Porta\Psr14Event\Auth\AuthInterface::authentificate()


					abstract
	protected

check(): void

Abstract method to perform auth check

Override this to implement exact auth method

Throws

Porta\Psr14Event\EventException

with code 401 in a case of authfailure


					
	protected

parseData(): void


					
	protected

extractHeader(string $headerName): string

Constants
`public`	`DATE_HEADER = 'Date'`	#

Properties
`protected`		`$authHeader = 'Authorization'`	#
`protected`	`RequestInterface`	`$request`	#
`protected`	`string`	`$authType`	#
`protected`	`string`	`$authValue`	#
`protected`	`string`	`$dateHeader`	#

Namespaces

Classes

Interfaces

Class Porta\Psr14Event\Auth\Auth

Parameters

Returns

Returns

Throws

Implements

Throws