AuthClientService
in package
AuthClientService
Tags
Table of Contents
Properties
Methods
- __construct() : mixed
- allowSelfRegistration() : bool
- autoMapToExistingUser() : void
- createRegistration() : Registration|null
- createUser() : User|null
- Automatically creates user by auth client attributes
- getCollection() : Collection
- getUser() : User|null
- Returns the user object which is linked against given authClient
- getUsersQuery() : ActiveQueryUser
- Returns all users which are using an given authclient
- updateUser() : bool
- Updates (or creates) a user in HumHub using AuthClients Attributes This method will be called after login or by cron sync.
Properties
$authClient
public
ClientInterface
$authClient
Methods
__construct()
public
__construct(ClientInterface $authClient) : mixed
Parameters
- $authClient : ClientInterface
allowSelfRegistration()
public
allowSelfRegistration() : bool
Tags
Return values
boolautoMapToExistingUser()
public
autoMapToExistingUser() : void
createRegistration()
public
createRegistration() : Registration|null
Return values
Registration|nullcreateUser()
Automatically creates user by auth client attributes
public
createUser() : User|null
Return values
User|null —the created user
getCollection()
public
static getCollection() : Collection
Return values
CollectiongetUser()
Returns the user object which is linked against given authClient
public
getUser() : User|null
Return values
User|null —the user model or null if not found
getUsersQuery()
Returns all users which are using an given authclient
public
getUsersQuery() : ActiveQueryUser
Return values
ActiveQueryUserupdateUser()
Updates (or creates) a user in HumHub using AuthClients Attributes This method will be called after login or by cron sync.
public
updateUser([User|null $user = null ]) : bool
Parameters
- $user : User|null = null
Return values
bool —succeed