AfsUserAuthentication Class Reference

AFS user authentication. More...

Inheritance diagram for AfsUserAuthentication:

Public Member Functions
	__construct ($user, $password, $authority=null)
	Constructs new AFS user authentication instance.
	format_as_url_param ($version=null)
	Formats authentication parameters.
	format_as_header_param ($version=null)
	Formats authentication parameters.

Detailed Description

AFS user authentication.

Instances of this class should be used t interact with Antidot Back Office APIs.

Constructor & Destructor Documentation

__construct	(		$user,
			$password,
			$authority = null
	)

Constructs new AFS user authentication instance.

Parameters

$user	[in] Login user name.
$password	[in] Login password.
$authority	[in] Authentication authority to use (see Authentication authorities). This parameter is useful and mandatory for AFS search engine 7.6.

Member Function Documentation

format_as_header_param

(

$version = null

)

Formats authentication parameters.

Parameters

$version

[in] Format string representation according to provided version information.

Returns

array representing authentication.

Implements AfsAuthentication.

format_as_url_param

(

$version = null

)

Formats authentication parameters.

Parameters

$version

[in] Format string representation according to provided version information.

Returns

array representing authentication.

Implements AfsAuthentication.