vB_Library_Styleschedule
extends vB_Library
in package
vB_Library
Table of Contents
Constants
- DATASTOREKEY_CURRENTSCHEDULE = 'vbStyleSchedule'
Methods
- __serialize() : array<string|int, mixed>
- __sleep() : array<string|int, mixed>
- __unserialize() : void
- __wakeup() : void
- clearCache() : mixed
- deleteSchedule() : mixed
- disableSchedule() : mixed
- enableSchedule() : mixed
- getContentInstance() : mixed
- getCurrentActiveScheduledStyle() : array<string|int, mixed>
- getStyleidFromScheduleid() : int
- getStyleSchedule() : vB_Entity_Styleschedule
- getStyleSchedules() : array<string|int, vB_Entity_Styleschedule>
- 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.
- rebuildAllStyleScheduleDatastores() : mixed
- saveStyleSchedule() : int|false
- saveStyleSchedulesBulk() : array<string|int, mixed>
Constants
DATASTOREKEY_CURRENTSCHEDULE
public
mixed
DATASTOREKEY_CURRENTSCHEDULE
= 'vbStyleSchedule'
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
clearCache()
public
static clearCache() : mixed
deleteSchedule()
public
deleteSchedule(int $scheduleid) : mixed
Parameters
- $scheduleid : int
disableSchedule()
public
disableSchedule(int $scheduleid) : mixed
Parameters
- $scheduleid : int
enableSchedule()
public
enableSchedule(int $scheduleid) : mixed
Parameters
- $scheduleid : int
getContentInstance()
public
static getContentInstance(mixed $contenttypeid) : mixed
Parameters
- $contenttypeid : mixed
getCurrentActiveScheduledStyle()
public
getCurrentActiveScheduledStyle() : array<string|int, mixed>
Return values
array<string|int, mixed>getStyleidFromScheduleid()
public
getStyleidFromScheduleid(int $scheduleid) : int
Parameters
- $scheduleid : int
Return values
intgetStyleSchedule()
public
getStyleSchedule(int $scheduleid) : vB_Entity_Styleschedule
Parameters
- $scheduleid : int
Tags
Return values
vB_Entity_Styleschedule —vB_Entity_Styleschedule instance
getStyleSchedules()
public
getStyleSchedules([array<string|int, mixed> $scheduleids = [] ]) : array<string|int, vB_Entity_Styleschedule>
Parameters
- $scheduleids : array<string|int, mixed> = []
Return values
array<string|int, vB_Entity_Styleschedule> —vB_Entity_Styleschedule instances keyed by scheduleid
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
use the functions from the notification library directly.
Parameters
- $text : mixed
- $type : mixed
- $nodeid : mixed
- $userid : mixed = null
- $insertNotifications : mixed = true
- $currentuserid : mixed = 0
rebuildAllStyleScheduleDatastores()
public
rebuildAllStyleScheduleDatastores() : mixed
saveStyleSchedule()
public
saveStyleSchedule(vB_Entity_Styleschedule $newSchedule[, bool $dorebuild = true ]) : int|false
Parameters
- $newSchedule : vB_Entity_Styleschedule
- $dorebuild : bool = true
Return values
int|false —Affected scheduleid, or false on failure
saveStyleSchedulesBulk()
public
saveStyleSchedulesBulk(array<string|int, mixed> $newschedules) : array<string|int, mixed>
Parameters
- $newschedules : array<string|int, mixed>
Return values
array<string|int, mixed> —Array of int|false, affected scheduleid(s) or false(s) on DB failure.