MetaFox

UserBlockedSupportContract
in

Interface UserBlockedSupportContract.

Table of Contents

Methods

blockUser()  : bool
Block user.
clearCache()  : void
Use for clearing cache of the user.
getBlockedUserIds()  : array<string|int, int>
Get blocked user IDs of the user.
getBlockedUsers()  : array<int, int>
Get blocked users of the user.
getBlockedUsersCollection()  : Collection
Return a collection of the user entity.
getBlockUserDetail()  : UserEntity|null
Get user blocked detail based on user_id and owner_id.
getCacheName()  : string
isBlocked()  : bool
unBlockUser()  : bool
Unblock the user.

Methods

clearCache()

Use for clearing cache of the user.

public clearCache(int $userId) : void
Parameters
$userId : int

getBlockedUserIds()

Get blocked user IDs of the user.

public getBlockedUserIds(User $user) : array<string|int, int>

Stored user ids only.

Parameters
$user : User
Return values
array<string|int, int>

getBlockedUsers()

Get blocked users of the user.

public getBlockedUsers(User $user[, string|null $search = null ]) : array<int, int>

Stored user ids only.

Parameters
$user : User
$search : string|null = null
Return values
array<int, int>

getBlockedUsersCollection()

Return a collection of the user entity.

public getBlockedUsersCollection(User $user, string|null $search) : Collection
Parameters
$user : User
$search : string|null
Return values
Collection

        
On this page

Search results