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
Return values
string|nullgetFirstName()
public
getFirstName(string $name) : string
Parameters
- $name : string
Return values
stringgetFriendship()
public
getFriendship(User $user, User $targetUser) : int|null
Parameters
Return values
int|nullgetGender()
public
getGender(UserProfile $profile) : string|null
Parameters
- $profile : UserProfile
Return values
string|nullgetGuestUser()
public
getGuestUser() : Authenticatable
Return values
AuthenticatablegetLastName()
public
getLastName(string $name) : string
Parameters
- $name : string
Return values
stringgetMentions()
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
getPossessiveGender()
public
getPossessiveGender(UserGender|null $gender) : string
Parameters
- $gender : UserGender|null
Return values
stringgetShortName()
public
getShortName(string $name) : string
Parameters
- $name : string
Return values
stringgetSummary()
public
getSummary(User $context, User $user) : string|null
Parameters
Return values
string|nullgetTimeZoneForForm()
public
getTimeZoneForForm() : array<int, mixed>
Return values
array<int, mixed>getTimeZoneNameById()
public
getTimeZoneNameById(int $id) : string|null
Parameters
- $id : int
Return values
string|nullgetUserAge()
public
getUserAge(string|null $birthday) : int|null
Parameters
- $birthday : string|null
Return values
int|nullgetUsersByRoleId()
public
getUsersByRoleId(int $roleId) : Collection|null
Parameters
- $roleId : int
Return values
Collection|nullgetVideoSettings()
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>|nullisBan()
public
isBan(int $userId) : bool
Parameters
- $userId : int
Return values
boolisFollowing()
public
isFollowing(User $context, User $user) : bool
Parameters
Return values
boolsplitName()
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
intupdateNotificationSettingsByChannel()
public
updateNotificationSettingsByChannel(User $context, array<string|int, mixed> $attributes) : mixed
Parameters
- $context : User
- $attributes : array<string|int, mixed>