MetaFox

UserItem extends JsonResource
in package
Uses ExtraTrait, UserStatisticTrait, UserLocationTrait, FriendStatisticTrait

Class UserItem.

Tags
SuppressWarnings

(PHPMD.UnusedFormalParameter)

Table of Contents

Properties

$resource  : User

Methods

canViewLocation()  : bool
getExtra()  : array<string|int, mixed>
getExtraAttributes()  : array<string|int, mixed>
getLocation()  : array<string, mixed>
getLocationValue()  : string
toArray()  : array<string, mixed>
Transform the resource collection into an array.
getAvatarId()  : int|null
This method shall be removed from version 5.2 Temporary solution for mobile app to avoid crash.
getFriendStatistic()  : array<string, mixed>
getStatistic()  : array<string, mixed>
isBlocked()  : bool

Properties

Methods

getExtra()

public getExtra([mixed $resolution = null ]) : array<string|int, mixed>
Parameters
$resolution : mixed = null
Return values
array<string|int, mixed>

getExtraAttributes()

public getExtraAttributes(User $context) : array<string|int, mixed>
Parameters
$context : User
Return values
array<string|int, mixed>

getLocation()

public getLocation(User $context, User $resource) : array<string, mixed>
Parameters
$context : User
$resource : User
Return values
array<string, mixed>

getLocationValue()

public getLocationValue(User $context, mixed $resource) : string
Parameters
$context : User
$resource : mixed
Return values
string

toArray()

Transform the resource collection into an array.

public toArray(Request $request) : array<string, mixed>
Parameters
$request : Request
Tags
throws
AuthenticationException
Return values
array<string, mixed>

getAvatarId()

This method shall be removed from version 5.2 Temporary solution for mobile app to avoid crash.

protected getAvatarId(User $context, User|null $user) : int|null
Parameters
$context : User
$user : User|null
Tags
deprecated
5.2
Return values
int|null

getFriendStatistic()

protected getFriendStatistic() : array<string, mixed>
Return values
array<string, mixed>

getStatistic()

protected getStatistic() : array<string, mixed>
Tags
throws
AuthenticationException
Return values
array<string, mixed>

isBlocked()

protected isBlocked() : bool
Tags
throws
AuthenticationException
Return values
bool

        
On this page

Search results