vB_Library_Notice
extends vB_Library
in package
vB_Library_Options
Tags
Table of Contents
Methods
- __serialize() : array<string|int, mixed>
- __sleep() : array<string|int, mixed>
- __unserialize() : void
- __wakeup() : void
- buildNoticeDatastore() : mixed
- clearCache() : mixed
- delete() : array<string|int, mixed>
- Delete notices
- getContentInstance() : mixed
- getNotice() : mixed
- getNoticeCache() : mixed
- instance() : static
- Returns singleton instance of self.
- monitorWords() : mixed
- Checks if the text contains monitored words, and if so, sends notifications to admins and moderators if the setting is on.
- save() : array<string|int, mixed>
- Save a notice
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
buildNoticeDatastore()
public
buildNoticeDatastore() : mixed
clearCache()
public
static clearCache() : mixed
delete()
Delete notices
public
delete(int|array<string|int, mixed> $noticeid) : array<string|int, mixed>
Parameters
- $noticeid : int|array<string|int, mixed>
Return values
array<string|int, mixed> —-- standard success array
getContentInstance()
public
static getContentInstance(mixed $contenttypeid) : mixed
Parameters
- $contenttypeid : mixed
getNotice()
public
getNotice(mixed $noticeid) : mixed
Parameters
- $noticeid : mixed
getNoticeCache()
public
getNoticeCache() : 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
monitorWords()
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
Parameters
- $text : mixed
- $type : mixed
- $nodeid : mixed
- $userid : mixed = null
- $insertNotifications : mixed = true
- $currentuserid : mixed = 0
Tags
save()
Save a notice
public
save(array<string|int, mixed> $data) : array<string|int, mixed>
Parameters
- $data : array<string|int, mixed>
-
int noticeid (optional) -- if given update the notice otherwise save a new one. string title string text int displayorder boolean active boolean persistent boolean dismissible array criteria -- criteriaid => [ 'condition1' => string $condition1 'condition2' => string $condition2 'condition3' => string $condition3 ]
Return values
array<string|int, mixed> —-- standard success array