vB_Library_Notice
extends vB_Library
in package
vB_Library_Options
Tags
Table of Contents
- $instance : mixed
- $validNoticeOptions : mixed
- __serialize() : mixed
- __sleep() : mixed
- __unserialize() : mixed
- __wakeup() : mixed
- buildNoticeDatastore() : mixed
- clearCache() : mixed
- delete() : array<string|int, mixed>
- Delete notices
- getContentInstance() : mixed
- getNotice() : mixed
- getNoticeCache() : mixed
- instance() : vB_PageCache
- 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
- __construct() : mixed
- getLibraryClassNameInternal() : mixed
- arrayToOptions() : mixed
- cleanCriteria() : mixed
- optionsToArray() : mixed
- saveNoticeInfo() : mixed
- saveNoticePhrase() : mixed
Properties
$instance
protected
static mixed
$instance
= array()
$validNoticeOptions
private
mixed
$validNoticeOptions
= array('allowhtml', 'allowbbcode', 'allowsmilies', 'parseurl')
Methods
__serialize()
public
__serialize() : mixed
Return values
mixed —__sleep()
public
__sleep() : mixed
Return values
mixed —__unserialize()
public
__unserialize(mixed $serialized) : mixed
Parameters
- $serialized : mixed
Return values
mixed —__wakeup()
public
__wakeup() : mixed
Return values
mixed —buildNoticeDatastore()
public
buildNoticeDatastore() : mixed
Return values
mixed —clearCache()
public
static clearCache() : mixed
Return values
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
Return values
mixed —getNotice()
public
getNotice(mixed $noticeid) : mixed
Parameters
- $noticeid : mixed
Return values
mixed —getNoticeCache()
public
getNoticeCache() : mixed
Return values
mixed —instance()
Returns singleton instance of self.
public
static instance(mixed $class) : vB_PageCache
Parameters
- $class : mixed
Return values
vB_PageCache —- Reference to singleton instance of the cache handler
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) : mixed
Parameters
- $text : mixed
- $type : mixed
- $nodeid : mixed
- $userid : mixed = null
- $insertNotifications : mixed = true
- $currentuserid : mixed
Return values
mixed —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 int displayorder boolean active boolean persistent boolean dismissible array criteria -- criteriaid => array( string $condition1 string $condition2 string $condition3 )
Return values
array<string|int, mixed> —-- standard success array
__construct()
protected
__construct() : mixed
Return values
mixed —getLibraryClassNameInternal()
protected
static getLibraryClassNameInternal(mixed $controller) : mixed
Parameters
- $controller : mixed
Return values
mixed —arrayToOptions()
private
arrayToOptions(mixed $datastore, mixed $options) : mixed
Parameters
- $datastore : mixed
- $options : mixed
Return values
mixed —cleanCriteria()
private
cleanCriteria(mixed $criteria_array) : mixed
Parameters
- $criteria_array : mixed
Return values
mixed —optionsToArray()
private
optionsToArray(mixed $datastore, mixed $options) : mixed
Parameters
- $datastore : mixed
- $options : mixed
Return values
mixed —saveNoticeInfo()
private
saveNoticeInfo(mixed $noticeid, mixed $title, mixed $displayorder, mixed $active, mixed $persistent, mixed $dismissible, mixed $noticeoptions, mixed $criteria_array) : mixed
Parameters
- $noticeid : mixed
- $title : mixed
- $displayorder : mixed
- $active : mixed
- $persistent : mixed
- $dismissible : mixed
- $noticeoptions : mixed
- $criteria_array : mixed
Return values
mixed —saveNoticePhrase()
private
saveNoticePhrase(mixed $noticeid, mixed $text) : mixed
Parameters
- $noticeid : mixed
- $text : mixed