Class flUserServerApiV1

flUserServerApiV1 Class

Class to act as an authentication server for flUserAdapterRemote.

flApiService

flUserServerApiV1

Package: fusionLib
Copyright: Copyright (c) 2013 - 2016 fusionLib. All rights reserved.
See: flUserAdapterRemote
Located at system/libs/User/flUserServerApiV1.php

Methods summary

`public`	# `__construct( flDb $db, flApiServer $apiServer, flRequest $request, flResponse $response )` Construct the service object. Construct the service object. Parameters `$db` The database object. `$apiServer` The API server object. `$request` The request object. `$response` The response object. Throws `flExceptionForbidden` Overrides `flApiService::__construct`
`public`	# `authenticatePost( )` Handle authentication. Handle authentication. Throws `flExceptionBadRequest`
`public`	# `validatePost( )` Validate the user id and get the access token, higher level functions must check the access token is valid. Validate the user id and get the access token, higher level functions must check the access token is valid. Throws `flExceptionBadRequest`
`public`	# `regeneratePost( )` Regenerate the authentication token. Regenerate the authentication token. Throws `flExceptionBadRequest`
`public`	# `changePost( )` Change a field. Change a field. Throws `flExceptionBadRequest`
`public`	# `checkGet( )` Check for the presence of a username or email address. Check for the presence of a username or email address. Throws `flExceptionBadRequest`
`public`	# `infoGet( )` Get the information on a user. Get the information on a user. Throws `flExceptionBadRequest`
`public`	# `blockPost( )` Block a user. Block a user. Throws `flExceptionBadRequest`
`public`	# `blockinfoGet( )` Get the information about a block on a user. Get the information about a block on a user. Throws `flExceptionBadRequest`
`public`	# `createPost( )` Create a user within the system. Create a user within the system. Throws `flExceptionBadRequest`
`public`	# `deletePost( )` Delete the user. Delete the user. Throws `flExceptionBadRequest`
`public`	# `rolesGet( )` Get the names of the roles assigned to the user. Get the names of the roles assigned to the user. Throws `flExceptionBadRequest`
`public`	# `rolesPost( )` Set the roles for a user. Set the roles for a user. Throws `flExceptionBadRequest`

Properties summary

`protected flUserAdapter`	`$adapter` The adapter to use for user authentication. The adapter to use for user authentication.	#
`protected flResponse`	`$response` The response object. The response object.	#

Properties inherited from flApiService

$apiServer, $db, $request

Packages

Classes

Interfaces

Exceptions

Functions

Class flUserServerApiV1

Methods summary

Parameters

Throws

Overrides

Throws

Throws

Throws

Throws

Throws

Throws

Throws

Throws

Throws

Throws

Throws

Throws

Properties summary

Properties inherited from flApiService