interface UserServiceInterface

Interface to be called for DI for User Main related services

Methods

add($user)

Adds the user

array
addAttempt($error)

Adds attempt for signin

addRole($user, string $role)

Adds role to user

archive($userId)

Archives the user using Stored Procedure

checkProfile($user)

Checks if profile is well filled

delete($user)

Deletes the user

deleteRole($user, string $role)

Deletes role to user

Response
export($user, $format)

Exports user's data

findUserByEmail($email)

Finds user by email

findUserById($id)

Finds user by id

findUserByIdentifier($identifier)

Finds user by identifier

findUserBySocialId($socialId)

Finds user by socialId

findUserByToken($token)

Finds user by token

array
getUsersAll()

Gets all the users

string
getUserEntity()

Gets the User entity used

modify($user)

Modifies the user

modifyRoles($user, array $roles)

Modifies role to user

signup($user)

Registers the user

signupConfirm($user)

Confirms user's signup

Details

at line 26
add($user)

Adds the user

Parameters

$user

at line 32
array addAttempt($error)

Adds attempt for signin

Parameters

$error

Return Value

array

at line 37
addRole($user, string $role)

Adds role to user

Parameters

$user
string $role

at line 42
archive($userId)

Archives the user using Stored Procedure

Parameters

$userId

at line 47
checkProfile($user)

Checks if profile is well filled

Parameters

$user

at line 52
delete($user)

Deletes the user

Parameters

$user

at line 57
deleteRole($user, string $role)

Deletes role to user

Parameters

$user
string $role

at line 63
Response export($user, $format)

Exports user's data

Parameters

$user
$format

Return Value

Response

at line 69
UserLight findUserByEmail($email)

Finds user by email

Parameters

$email

Return Value

UserLight

at line 75
UserLight findUserById($id)

Finds user by id

Parameters

$id

Return Value

UserLight

at line 81
UserLight findUserByIdentifier($identifier)

Finds user by identifier

Parameters

$identifier

Return Value

UserLight

at line 87
UserLight findUserBySocialId($socialId)

Finds user by socialId

Parameters

$socialId

Return Value

UserLight

at line 93
UserLight findUserByToken($token)

Finds user by token

Parameters

$token

Return Value

UserLight

at line 99
array getUsersAll()

Gets all the users

Return Value

array

at line 105
string getUserEntity()

Gets the User entity used

Return Value

string

at line 110
modify($user)

Modifies the user

Parameters

$user

at line 115
modifyRoles($user, array $roles)

Modifies role to user

Parameters

$user
array $roles

at line 120
signup($user)

Registers the user

Parameters

$user

at line 125
signupConfirm($user)

Confirms user's signup

Parameters

$user