MetaFox

ActivityPoint
in

Table of Contents

Methods

addPoints()  : int
adjustPoints()  : int|null
convertPointFromPrice()  : int
createTransaction()  : PointTransaction
decreaseUserPointsWithAction()  : bool
getConversionRate()  : float
getMinPointByIds()  : int
getTotalActivityPoints()  : int
getUserPointBalance()  : int
giftPoints()  : bool
installCustomPointSettings()  : void
isAdded()  : bool
isCustomInstalled()  : bool
isPackageAvailableForPurchase()  : bool
isSubtracted()  : bool
proceedPayment()  : bool
updateActivityPoints()  : bool
updateStatistic()  : PointStatistic
updateUserPoints()  : int

Methods

addPoints()

public addPoints(User $context, User $owner, int $amount, int|null $type[, array<string, mixed> $extra = [] ]) : int
Parameters
$context : User
$owner : User
$amount : int
$type : int|null
$extra : array<string, mixed> = []
Return values
int

adjustPoints()

public adjustPoints(User $context, User $user, int $type, int $amount) : int|null
Parameters
$context : User
$user : User
$type : int
$amount : int
Return values
int|null

convertPointFromPrice()

public convertPointFromPrice(string $currency, float $amount) : int
Parameters
$currency : string
$amount : float
Return values
int

decreaseUserPointsWithAction()

public decreaseUserPointsWithAction(User $user, int $points, string $action, string $actionTypeName[, array<string|int, mixed> $actionParams = [] ]) : bool
Parameters
$user : User
$points : int
$action : string
$actionTypeName : string
$actionParams : array<string|int, mixed> = []
Return values
bool

getConversionRate()

public getConversionRate(string $currency) : float
Parameters
$currency : string
Return values
float

getMinPointByIds()

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

getTotalActivityPoints()

public getTotalActivityPoints(User $context) : int
Parameters
$context : User
Return values
int

getUserPointBalance()

public getUserPointBalance(User $context) : int
Parameters
$context : User
Return values
int

giftPoints()

public giftPoints(User $context, User $owner, int $points) : bool
Parameters
$context : User
$owner : User
$points : int
Return values
bool

installCustomPointSettings()

public installCustomPointSettings([array<string, mixed> $default = [] ]) : void
Parameters
$default : array<string, mixed> = []

isAdded()

public isAdded(int $type) : bool
Parameters
$type : int
Return values
bool

isCustomInstalled()

public isCustomInstalled(string $packageId) : bool
Parameters
$packageId : string
Return values
bool

isSubtracted()

public isSubtracted(int $type) : bool
Parameters
$type : int
Return values
bool

proceedPayment()

public proceedPayment(Order $order) : bool
Parameters
$order : Order
Return values
bool

updateActivityPoints()

public updateActivityPoints(User $context, int $amount) : bool
Parameters
$context : User
$amount : int
Return values
bool

updateUserPoints()

public updateUserPoints(User $user, Entity $content, string $action, int $type[, bool $allowMultiTransactionsPerItem = false ]) : int
Parameters
$user : User
$content : Entity
$action : string
$type : int
$allowMultiTransactionsPerItem : bool = false
Return values
int 

        

        
    




    

    

                                

                

                            
    

        On this page

        
    


                

                            

            

    

        

            
Search results