vB_Library_Article
extends vB_Library
in package
vB_Library_Article
Tags
Table of Contents
- $articleHomeChannel : mixed
- $instance : mixed
- __serialize() : mixed
- __sleep() : mixed
- __unserialize() : mixed
- __wakeup() : mixed
- 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() : vB_PageCache
- 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.
- __construct() : mixed
- This class is based on vB_Library_Blog
- getLibraryClassNameInternal() : mixed
Properties
$articleHomeChannel
protected
mixed
$articleHomeChannel
= alse
$instance
protected
static mixed
$instance
= array()
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 —clearCache()
public
static clearCache() : mixed
Return values
mixed —createArticleCategory()
public
createArticleCategory(mixed $input) : mixed
Parameters
- $input : mixed
Return values
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
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
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
bool —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 —__construct()
This class is based on vB_Library_Blog
protected
__construct() : mixed
Return values
mixed —getLibraryClassNameInternal()
protected
static getLibraryClassNameInternal(mixed $controller) : mixed
Parameters
- $controller : mixed