Interface IAuthentication

Authentication related functions

Implements authentication using HTTP\s BASIC AUTHENTICATION This class should be extended, this implementation will allways return false

Namespace: Phramework\Authentication
License: Apache-2.0
Author: Xenofon Spafaridis nohponex@gmail.com
Since: 1
Located at Authentication/IAuthentication.php

Methods summary

`public array\|false`	# `check( array $params, string $method, array $headers )` Check user's authentication Check user's authentication Parameters `$params` Request parameters `$method` Request method `$headers` Request headers Returns array\|false Returns false on error or the user object on success
`public array\|false`	# `authenticate( array $params, string $method, array $headers )` Autheticate a user, using user's email and password Always returns false You must extend this class and implement this method Autheticate a user, using user's email and password Always returns false You must extend this class and implement this method Parameters `$params` Request parameters `$method` Request method `$headers` Request headers Returns array\|false Returns false on error or the user object on success Throws `Phramework\Exceptions\PermissionException`
`public boolean`	# `testProvidedMethod( array $params, string $method, array $headers )` Test if current request holds authoratation data Test if current request holds authoratation data Parameters `$params` Request parameters `$method` Request method `$headers` Request headers Returns boolean

`public array\|false`	# `check( array $params, string $method, array $headers )` Check user's authentication Check user's authentication Parameters `$params` Request parameters `$method` Request method `$headers` Request headers Returns array\|false Returns false on error or the user object on success
`public array\|false`	# `authenticate( array $params, string $method, array $headers )` Autheticate a user, using user's email and password Always returns false You must extend this class and implement this method Autheticate a user, using user's email and password Always returns false You must extend this class and implement this method Parameters `$params` Request parameters `$method` Request method `$headers` Request headers Returns array\|false Returns false on error or the user object on success Throws `Phramework\Exceptions\PermissionException`
`public boolean`	# `testProvidedMethod( array $params, string $method, array $headers )` Test if current request holds authoratation data Test if current request holds authoratation data Parameters `$params` Request parameters `$method` Request method `$headers` Request headers Returns boolean

Namespaces

Classes

Interfaces

Interface IAuthentication

Methods summary

Parameters

Returns

Parameters

Returns

Throws

Parameters

Returns