vB_Library_Unsubscribe
extends vB_Library
in package
vB_Library_Unsubscribe
Table of Contents
Constants
Methods
- __serialize() : array<string|int, mixed>
- __sleep() : array<string|int, mixed>
- __unserialize() : void
- __wakeup() : void
- afterUserDelete() : mixed
- bulkUpdateTokenLastused() : mixed
- clearCache() : mixed
- ensureUserHash() : array<string|int, mixed>
- fetchUrlParameters() : array<string|int, mixed>
- getContentInstance() : mixed
- instance() : static
- Returns singleton instance of self.
- isUserOptedOutOfEmail() : bool
- monitorWords() : mixed
- Checks if the text contains monitored words, and if so, sends notifications to admins and moderators if the setting is on.
- prefetchUserHashes() : void
- Prepare user hash for bulk mail sending operations.
- prefetchUserMailOptions() : void
- Prefetch user `mailoption` for bulk mail sending operations.
- resetAllHashes() : mixed
- resetSingleHash() : mixed
- trackEmailOptInOut() : void
- verifyHash() : bool
Constants
EMAILOPTION_DEFAULT
public
mixed
EMAILOPTION_DEFAULT
= 0
EMAILOPTION_OPTED_IN
public
mixed
EMAILOPTION_OPTED_IN
= 2
EMAILOPTION_UNSUBSCRIBED
public
mixed
EMAILOPTION_UNSUBSCRIBED
= 1
Methods
__serialize()
public
__serialize() : array<string|int, mixed>
Return values
array<string|int, mixed>__sleep()
public
__sleep() : array<string|int, mixed>
Return values
array<string|int, mixed>__unserialize()
public
__unserialize(array<string|int, mixed> $serialized) : void
Parameters
- $serialized : array<string|int, mixed>
__wakeup()
public
__wakeup() : void
afterUserDelete()
public
afterUserDelete(int $userid) : mixed
Parameters
- $userid : int
bulkUpdateTokenLastused()
public
bulkUpdateTokenLastused(array<string|int, mixed> $useridHashArray[, bool $shutdown = false ]) : mixed
Parameters
- $useridHashArray : array<string|int, mixed>
- $shutdown : bool = false
clearCache()
public
static clearCache() : mixed
ensureUserHash()
public
ensureUserHash(int $userid) : array<string|int, mixed>
Parameters
- $userid : int
Return values
array<string|int, mixed>fetchUrlParameters()
public
fetchUrlParameters(int $userid) : array<string|int, mixed>
Parameters
- $userid : int
Return values
array<string|int, mixed>getContentInstance()
public
static getContentInstance(mixed $contenttypeid) : mixed
Parameters
- $contenttypeid : mixed
instance()
Returns singleton instance of self.
public
static instance(mixed $class) : static
Parameters
- $class : mixed
Return values
static —- Reference to singleton instance of the requested library class
isUserOptedOutOfEmail()
public
isUserOptedOutOfEmail(int $userid) : bool
Parameters
- $userid : int
Return values
boolmonitorWords()
Checks if the text contains monitored words, and if so, sends notifications to admins and moderators if the setting is on.
public
monitorWords(mixed $text, mixed $type, mixed $nodeid[, mixed $userid = null ][, mixed $insertNotifications = true ][, mixed $currentuserid = 0 ]) : mixed
use the functions from the notification library directly.
Parameters
- $text : mixed
- $type : mixed
- $nodeid : mixed
- $userid : mixed = null
- $insertNotifications : mixed = true
- $currentuserid : mixed = 0
prefetchUserHashes()
Prepare user hash for bulk mail sending operations.
public
prefetchUserHashes(array<string|int, mixed> $userids) : void
Warning, this will reset $this->mailhashCache.
Parameters
- $userids : array<string|int, mixed>
prefetchUserMailOptions()
Prefetch user `mailoption` for bulk mail sending operations.
public
prefetchUserMailOptions(array<string|int, mixed> $userids) : void
Warning, this will reset $this->mailoptionCache.
Parameters
- $userids : array<string|int, mixed>
resetAllHashes()
public
resetAllHashes() : mixed
resetSingleHash()
public
resetSingleHash(int $userid) : mixed
Parameters
- $userid : int
trackEmailOptInOut()
public
trackEmailOptInOut(int $userid[, int $option = self::EMAILOPTION_DEFAULT ]) : void
Parameters
- $userid : int
- $option : int = self::EMAILOPTION_DEFAULT
verifyHash()
public
verifyHash(int $userid, string $hash) : bool
Parameters
- $userid : int
- $hash : string