vB_Library_Product
extends vB_Library
in package
vB_Library_Product
Tags
Table of Contents
Methods
- __serialize() : array<string|int, mixed>
- __sleep() : array<string|int, mixed>
- __unserialize() : void
- __wakeup() : void
- buildProductDatastore() : mixed
- Saves the list of currently installed products into the datastore.
- clearCache() : mixed
- getContentInstance() : mixed
- getFullProducts() : mixed
- getPackages() : mixed
- gets the list of packages (folder names).
- getProducts() : mixed
- getProductTitles() : mixed
- instance() : static
- Returns singleton instance of self.
- loadProductXmlList() : array<string|int, mixed>
- Loads an array of all package xml files (optionally of one type).
- loadProductXmlListParsed() : array<string|int, mixed>
- Returns parsed xml for package xml files
- monitorWords() : mixed
- Checks if the text contains monitored words, and if so, sends notifications to admins and moderators if the setting is on.
- resetProductInfo() : mixed
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
buildProductDatastore()
Saves the list of currently installed products into the datastore.
public
buildProductDatastore() : mixed
clearCache()
public
static clearCache() : mixed
getContentInstance()
public
static getContentInstance(mixed $contenttypeid) : mixed
Parameters
- $contenttypeid : mixed
getFullProducts()
public
getFullProducts() : mixed
getPackages()
gets the list of packages (folder names).
public
getPackages(mixed $packagesDir[, mixed $folders = array() ]) : mixed
Parameters
- $packagesDir : mixed
- $folders : mixed = array()
getProducts()
public
getProducts() : mixed
getProductTitles()
public
getProductTitles() : 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
loadProductXmlList()
Loads an array of all package xml files (optionally of one type).
public
loadProductXmlList([string $type = '' ][, bool $typekey = false ]) : array<string|int, mixed>
Load from core\packages\packagename\xml as well as core\includes\xml\ (for the vbulletin package) Files will be interpreted as: {type}{subtype}.xml (or {type}{subtype}_someotherstring.xml
Parameters
- $type : string = ''
-
-- the file prefix for the xml file to load. If the type of the file does not match the passed type it will be ignored.
- $typekey : bool = false
-
-- whether to return the values by subtype. If false then a single array of all files will be returned. Otherwise the return will be an array of arrays by subtype. If there is no subtype (for example sometype.xml) then "none" will be used.
Return values
array<string|int, mixed> —either an array of file names or an array of the form $subtype => array(files)
loadProductXmlListParsed()
Returns parsed xml for package xml files
public
loadProductXmlListParsed([string $type = '' ][, bool $typekey = false ]) : array<string|int, mixed>
Returns the file list from loadProductXmlList but includes the parsed array from the xml contents instead of the filenames
Parameters
- $type : string = ''
- $typekey : bool = false
Tags
Return values
array<string|int, mixed>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
resetProductInfo()
public
resetProductInfo() : mixed