vB_Library_Article
extends vB_Library
in package
vB_Library_Article
Tags
Table of Contents
Methods
- __serialize() : array<string|int, mixed>
- __sleep() : array<string|int, mixed>
- __unserialize() : void
- __wakeup() : void
- clearCache() : mixed
- createArticleCategory() : mixed
- createChannel() : int
- Create an article category channel. This function works basically like the blog library's version
- getArticleChannel() : int
- getContentInstance() : mixed
- instance() : static
- Returns singleton instance of self.
- isArticleNode() : bool
- Determines if the given node is under the Articles Home Channel
- monitorWords() : mixed
- Checks if the text contains monitored words, and if so, sends notifications to admins and moderators if the setting is on.
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
createArticleCategory()
public
createArticleCategory(mixed $input) : mixed
Parameters
- $input : mixed
createChannel()
Create an article category channel. This function works basically like the blog library's version
public
createChannel(array<string|int, mixed> $input, int $channelid, int $channelConvTemplateid, int $channelPgTemplateId, int $ownerSystemGroupId) : int
Parameters
- $input : array<string|int, mixed>
-
data array, should have standard channel data like title, parentid,
- $channelid : int
-
parentid that the new channel should fall under.
- $channelConvTemplateid : int
-
"Conversation" level pagetemplate to use. Typically vB_Page::getArticleConversPageTemplate()
- $channelPgTemplateId : int
-
"Channel" level pagetemplate to use. Typically vB_Page::getArticleChannelPageTemplate()
- $ownerSystemGroupId : int
Return values
int —The nodeid of the new blog channel
getArticleChannel()
public
getArticleChannel() : int
Tags
Return values
int —nodeid of actual Articles Home Channel
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
isArticleNode()
Determines if the given node is under the Articles Home Channel
public
isArticleNode(mixed $nodeId[, mixed $node = false ]) : bool
Parameters
- $nodeId : mixed
- $node : mixed = false
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
Parameters
- $text : mixed
- $type : mixed
- $nodeid : mixed
- $userid : mixed = null
- $insertNotifications : mixed = true
- $currentuserid : mixed = 0