HumHub Documentation (unofficial)

ClientInterface

ClientInterface declares basic interface all Auth clients should follow.

Tags
author

Paul Klimov klimov.paul@gmail.com

since
2.0

Table of Contents

Methods

getId()  : string
getName()  : string
getTitle()  : string
getUserAttributes()  : array<string|int, mixed>
getViewOptions()  : array<string|int, mixed>
setId()  : mixed
setName()  : mixed
setTitle()  : mixed

Methods

getName()

public getName() : string
Return values
string

service name.

getTitle()

public getTitle() : string
Return values
string

service title.

getUserAttributes()

public getUserAttributes() : array<string|int, mixed>
Return values
array<string|int, mixed>

list of user attributes

getViewOptions()

public getViewOptions() : array<string|int, mixed>
Return values
array<string|int, mixed>

view options in format: optionName => optionValue

setId()

public setId(string $id) : mixed
Parameters
$id : string

service id.

setName()

public setName(string $name) : mixed
Parameters
$name : string

service name.

setTitle()

public setTitle(string $title) : mixed
Parameters
$title : string

service title.


        
On this page

Search results