includes/class/Authentication.class.php
Show:
inherited
inherited
Classes
Broker
- Package
- Broker
\Broker\Authentication
Package: Broker
Handle authentication based on IP, key or login/password
Properties
boolean $accessBasedOnIPAccess based on IP
Details
- Type
- boolean
boolean $accessBasedOnKeyAccess based on key
Details
- Type
- boolean
boolean $accessBasedOnLoginAccess based on login
Details
- Type
- boolean
boolean $accessWithAdminPrivilegesAccess with admin privileges
Details
- Type
- boolean
object $configurationConfiguration
Details
- Type
- object
Methods
__construct(object $configuration) : voidConstructor
Parameters
| Name | Type | Description |
|---|---|---|
| $configuration | object |
access() : booleanCheck for access
Returns
| Type | Description |
|---|---|
| boolean |
accessBasedOnIP() : booleanCheck for access based on IP
Returns
| Type | Description |
|---|---|
| boolean |
accessBasedOnKey() : booleanCheck for access based on key
Returns
| Type | Description |
|---|---|
| boolean |
accessBasedOnLogin() : booleanCheck for access based on login
Returns
| Type | Description |
|---|---|
| boolean |
accessWithAdminPrivileges() : booleanCheck for access with admin privileges
Returns
| Type | Description |
|---|---|
| boolean |
getIP() : stringGet ip
Returns
| Type | Description |
|---|---|
| string |
getLogin() : string | booleanGet login
Returns
| Type | Description |
|---|---|
| string | boolean |
getName() : string | booleanGet name
Returns
| Type | Description |
|---|---|
| string | boolean |
login(string $login, string $name, boolean $admin) : voidLogin
Parameters
| Name | Type | Description |
|---|---|---|
| $login | string | |
| $name | string | |
| $admin | boolean |
logout() : voidLogout
reset() : voidReset
validateIP(string $ip) : booleanValidate IP
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $ip | string |
| Type | Description |
|---|---|
| boolean |
validateKey(string $key) : booleanValidate key
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $key | string |
| Type | Description |
|---|---|
| boolean |
validateLogin(string $login, string $password) : booleanValidate login
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $login | string | |
| $password | string |
| Type | Description |
|---|---|
| boolean |