ParticipantBlacklistHandler
in package
Table of Contents
Methods
- addToBlacklist() : BlacklistResult
- getCentralParticipantFromToken() : Participant|null
- Returns the CPDB participant corresponding to the given Token.
- isTokenBlacklisted() : bool
- Returns true if the token is globally blocklisted
- removeFromBlacklist() : BlacklistResult
- optoutParticipantFromAllSurveys() : array<string|int, int>
- Marks the participant as "opted out" on all surveys currently present in the system that use tokens
- removeParticipantFromAllSurveys() : array<string|int, int>
- Removes the participant from all surveys currently present in the system that use tokens
Methods
addToBlacklist()
public
addToBlacklist(Token $token) : BlacklistResult
Parameters
- $token : Token
Return values
BlacklistResultgetCentralParticipantFromToken()
Returns the CPDB participant corresponding to the given Token.
public
getCentralParticipantFromToken(Token $token) : Participant|null
Parameters
- $token : Token
Return values
Participant|nullisTokenBlacklisted()
Returns true if the token is globally blocklisted
public
isTokenBlacklisted(Token $token) : bool
Parameters
- $token : Token
Return values
boolremoveFromBlacklist()
public
removeFromBlacklist(Token $token) : BlacklistResult
Parameters
- $token : Token
Return values
BlacklistResultoptoutParticipantFromAllSurveys()
Marks the participant as "opted out" on all surveys currently present in the system that use tokens
private
optoutParticipantFromAllSurveys(Participant $participant) : array<string|int, int>
Parameters
- $participant : Participant
Return values
array<string|int, int> —the list of survey IDs from which the participant was opted out
removeParticipantFromAllSurveys()
Removes the participant from all surveys currently present in the system that use tokens
private
removeParticipantFromAllSurveys(Participant $participant) : array<string|int, int>
Parameters
- $participant : Participant
Return values
array<string|int, int> —the list of survey IDs from which the participant was removed