Documentation

FirstPromoterComponent
in package

Table of Contents

Constants

KEY_REFERRAL_ID  = '_fprom_code'
KEY_TRACKING_ID  = '_fprom_track'
COOKIE_LIFE  = 60 * 60 * 24 * 60

Properties

$auth  : AuthComponent
$client  : FirstPromoterClient
$redis  : Redis
$request  : Request

Methods

__construct()  : mixed
getLeadByClient()  : mixed
getPromoterByReferralId()  : mixed
getReferralId()  : string|null
getTrackingId()  : string|null
handleConsent()  : void
registerTrackingCode()  : mixed
trackSignup()  : mixed
accept()  : mixed
deleteTrackingValue()  : mixed
deny()  : mixed
doSaveTrackingValue()  : mixed
getLastKnownTrackingValueByKey()  : string|null
getResourceVersionKeyByCacheKey()  : mixed
getTrackingCacheKeyWithClientByKey()  : mixed
getTrackingCacheKeyWithoutClientByKey()  : mixed
getTrackingValueByKey()  : string|null
isValidClientSession()  : mixed
saveTrackingValue()  : mixed
signupNew()  : mixed
signupSubscribed()  : mixed

Constants

Properties

Methods

getPromoterByReferralId()

public getPromoterByReferralId(string $referralId) : mixed
Parameters
$referralId : string

getReferralId()

public getReferralId([Client|null $client = null ][, bool $forceCheck = false ]) : string|null
Parameters
$client : Client|null = null
$forceCheck : bool = false
Return values
string|null

getTrackingId()

public getTrackingId([Client|null $client = null ][, bool $forceCheck = false ]) : string|null
Parameters
$client : Client|null = null
$forceCheck : bool = false
Return values
string|null

handleConsent()

public handleConsent(bool $allow, string|null $trackingId, string|null $referralId, Client|null $client) : void
Parameters
$allow : bool
$trackingId : string|null
$referralId : string|null
$client : Client|null

accept()

private accept(string|null $trackingId, string|null $referralId, Client|null $client) : mixed
Parameters
$trackingId : string|null
$referralId : string|null
$client : Client|null

deleteTrackingValue()

private deleteTrackingValue(string $cacheKey) : mixed
Parameters
$cacheKey : string

deny()

private deny(string|null $trackingId, string|null $referralId, Client|null $client) : mixed
Parameters
$trackingId : string|null
$referralId : string|null
$client : Client|null

doSaveTrackingValue()

private doSaveTrackingValue(string $cacheKey, string $value) : mixed
Parameters
$cacheKey : string
$value : string

getLastKnownTrackingValueByKey()

private getLastKnownTrackingValueByKey([Client|null $client = null ], string $key) : string|null
Parameters
$client : Client|null = null
$key : string
Return values
string|null

getResourceVersionKeyByCacheKey()

private getResourceVersionKeyByCacheKey(mixed $key) : mixed
Parameters
$key : mixed

getTrackingCacheKeyWithClientByKey()

private getTrackingCacheKeyWithClientByKey(Client $client, string $key) : mixed
Parameters
$client : Client
$key : string

getTrackingCacheKeyWithoutClientByKey()

private getTrackingCacheKeyWithoutClientByKey(string $key) : mixed
Parameters
$key : string

getTrackingValueByKey()

private getTrackingValueByKey([Client|null $client = null ], string $key[, bool $forceCheck = false ]) : string|null
Parameters
$client : Client|null = null
$key : string
$forceCheck : bool = false
Return values
string|null

saveTrackingValue()

private saveTrackingValue([Client|null $client = null ], string $key, string|null $value) : mixed
Parameters
$client : Client|null = null
$key : string
$value : string|null

        
On this page

Search results