MetaFox

ActivitySubscription
in package

Table of Contents

Methods

addSubscription()  : Subscription
buildSubscriptions()  : mixed
deleteSubscription()  : bool
getSubscription()  : Subscription|null
getSubscriptions()  : Collection
isExist()  : bool
updateSubscription()  : false|Subscription

Methods

addSubscription()

public addSubscription(int $userId, int $ownerId[, bool $active = true ][, string|null $specialType = null ]) : Subscription
Parameters
$userId : int
$ownerId : int
$active : bool = true
$specialType : string|null = null
Return values
Subscription

buildSubscriptions()

public buildSubscriptions(array<string|int, mixed> $attributes) : mixed
Parameters
$attributes : array<string|int, mixed>

deleteSubscription()

public deleteSubscription(int $userId, int $ownerId[, string|null $specialType = null ]) : bool
Parameters
$userId : int
$ownerId : int
$specialType : string|null = null
Return values
bool

getSubscription()

public getSubscription(int $userId, int $ownerId[, string|null $specialType = null ]) : Subscription|null
Parameters
$userId : int
$ownerId : int
$specialType : string|null = null
Return values
Subscription|null

getSubscriptions()

public getSubscriptions(array<string|int, mixed> $attributes) : Collection
Parameters
$attributes : array<string|int, mixed>
Return values
Collection

isExist()

public isExist(int $userId, int $ownerId) : bool
Parameters
$userId : int
$ownerId : int
Return values
bool

updateSubscription()

public updateSubscription(int $userId, int $ownerId[, bool $active = false ][, string|null $specialType = null ]) : false|Subscription
Parameters
$userId : int
$ownerId : int
$active : bool = false
$specialType : string|null = null
Tags
SuppressWarnings

(PHPMD.BooleanArgumentFlag)

Return values
false|Subscription

        
On this page

Search results