MetaFox

UserContract
in

Interface UserContract.

Table of Contents

Methods

getAddress()  : string|null
getFirstName()  : string
getFriendship()  : int|null
getGender()  : string|null
getGuestUser()  : Authenticatable
getLastName()  : string
getMentions()  : array<string|int, int>
getNotificationSettingsByChannel()  : mixed
getPossessiveGender()  : string
getShortName()  : string
getSummary()  : string|null
getTimeZoneForForm()  : array<int, mixed>
getTimeZoneNameById()  : string|null
getUserAge()  : int|null
getUsersByRoleId()  : Collection|null
getVideoSettings()  : array<string, mixed>
hasPendingSubscription()  : array<string|int, mixed>|null
isBan()  : bool
isFollowing()  : bool
splitName()  : array<string|int, mixed>
totalFollowers()  : int
updateNotificationSettingsByChannel()  : mixed

Methods

getAddress()

public getAddress(User $context, User $user) : string|null
Parameters
$context : User
$user : User
Return values
string|null

getFirstName()

public getFirstName(string $name) : string
Parameters
$name : string
Return values
string

getFriendship()

public getFriendship(User $user, User $targetUser) : int|null
Parameters
$user : User
$targetUser : User
Return values
int|null

getGuestUser()

public getGuestUser() : Authenticatable
Return values
Authenticatable

getLastName()

public getLastName(string $name) : string
Parameters
$name : string
Return values
string

getMentions()

public getMentions(string $content) : array<string|int, int>
Parameters
$content : string
Return values
array<string|int, int>

getNotificationSettingsByChannel()

public getNotificationSettingsByChannel(User $user, string $channel) : mixed
Parameters
$user : User
$channel : string

getShortName()

public getShortName(string $name) : string
Parameters
$name : string
Return values
string

getSummary()

public getSummary(User $context, User $user) : string|null
Parameters
$context : User
$user : User
Return values
string|null

getTimeZoneForForm()

public getTimeZoneForForm() : array<int, mixed>
Return values
array<int, mixed>

getTimeZoneNameById()

public getTimeZoneNameById(int $id) : string|null
Parameters
$id : int
Return values
string|null

getUserAge()

public getUserAge(string|null $birthday) : int|null
Parameters
$birthday : string|null
Return values
int|null

getUsersByRoleId()

public getUsersByRoleId(int $roleId) : Collection|null
Parameters
$roleId : int
Return values
Collection|null

getVideoSettings()

public getVideoSettings(User $user) : array<string, mixed>
Parameters
$user : User
Return values
array<string, mixed>

hasPendingSubscription()

public hasPendingSubscription(Request $request, User $user[, bool $isMobile = false ]) : array<string|int, mixed>|null
Parameters
$request : Request
$user : User
$isMobile : bool = false
Return values
array<string|int, mixed>|null

isBan()

public isBan(int $userId) : bool
Parameters
$userId : int
Return values
bool

splitName()

public splitName(string $name) : array<string|int, mixed>
Parameters
$name : string
Return values
array<string|int, mixed>

totalFollowers()

public totalFollowers(User $user) : int
Parameters
$user : User
Return values
int

updateNotificationSettingsByChannel()

public updateNotificationSettingsByChannel(User $context, array<string|int, mixed> $attributes) : mixed
Parameters
$context : User
$attributes : array<string|int, mixed>

        
On this page

Search results