Documentation

UserComponent extends BaseComponent
in package

Class UserComponent.

Table of Contents

Properties

$trans  : Translator

Methods

addUser()  : UserAccount
createExportDataJob()  : mixed
formatExportIntegrationStatus()  : string
formatUserPermission()  : mixed
formatUserStatus()  : string
This method returns the user status as string
getFilterLink()  : string|null
getHashByUser()  : string
getLoginLink()  : string|null
getModules()  : mixed
getUserActionLink()  : stdClass
getUserIntegrationStatusList()  : array<string|int, mixed>
sendActivationMail()  : mixed
_()  : mixed
doAddUser()  : UserAccount
getHash()  : string
getHashKey()  : mixed
getModuleFor()  : mixed
getUrlByPermission()  : mixed
loadModules()  : mixed

Properties

Methods

addUser()

public addUser(array<string|int, mixed> $data) : UserAccount
Parameters
$data : array<string|int, mixed>

$data = [ "email" => (string) Required. Not validated here. "password" => (string|null) Optional. If null, email login is impossible. "amazon_user_id" => (string|null) Optional. "firstname" => (string) "lastname" => (string) "lang" => (string) Language code. Optional. Default: "en" "phone_code" => (int) Optional. "phone" => (string) Optional "source" => (integer) Optional. Default 1|2. "sendmail" => (bool) Optional. Default: true "access_blocked" => (bool) Optional. Default: false ]

Tags
throws
Exception
Return values
UserAccount

createExportDataJob()

public createExportDataJob(mixed $requestId, mixed $userId) : mixed
Parameters
$requestId : mixed
$userId : mixed

formatExportIntegrationStatus()

public formatExportIntegrationStatus(mixed $integrationStatusList) : string
Parameters
$integrationStatusList : mixed
Return values
string

formatUserPermission()

public formatUserPermission(mixed $user) : mixed
Parameters
$user : mixed

formatUserStatus()

This method returns the user status as string

public formatUserStatus(Client $client) : string
Parameters
$client : Client
Return values
string

getHashByUser()

public getHashByUser(mixed $user) : string
Parameters
$user : mixed
Tags
throws
Exception
Return values
string

getUserActionLink()

public getUserActionLink(mixed $user) : stdClass
Parameters
$user : mixed
Return values
stdClass

getUserIntegrationStatusList()

public getUserIntegrationStatusList(Client $client) : array<string|int, mixed>
Parameters
$client : Client
Return values
array<string|int, mixed>

sendActivationMail()

public sendActivationMail(mixed $user[, mixed $redirect = null ]) : mixed
Parameters
$user : mixed
$redirect : mixed = null

_()

protected static _(mixed $string[, array<string|int, mixed> $params = [] ]) : mixed
Parameters
$string : mixed
$params : array<string|int, mixed> = []

getHash()

private getHash(mixed $user) : string
Parameters
$user : mixed
Tags
throws
Exception
Return values
string

getModuleFor()

private getModuleFor(mixed $moduleId) : mixed
Parameters
$moduleId : mixed 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results