vB_Library_Product
extends vB_Library
in package
vB_Library_Product
Tags
Table of Contents
- $instance : mixed
- $fullProductList : mixed
- __serialize() : mixed
- __sleep() : mixed
- __unserialize() : mixed
- __wakeup() : mixed
- 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() : vB_PageCache
- 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
- __construct() : mixed
- getLibraryClassNameInternal() : mixed
- loadProductXml() : mixed
- gets the list of xml files in a given folder (and of optional type).
Properties
$instance
protected
static mixed
$instance
= array()
$fullProductList
private
mixed
$fullProductList
= alse
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 —buildProductDatastore()
Saves the list of currently installed products into the datastore.
public
buildProductDatastore() : mixed
Return values
mixed —clearCache()
public
static clearCache() : mixed
Return values
mixed —getContentInstance()
public
static getContentInstance(mixed $contenttypeid) : mixed
Parameters
- $contenttypeid : mixed
Return values
mixed —getFullProducts()
public
getFullProducts() : mixed
Return values
mixed —getPackages()
gets the list of packages (folder names).
public
getPackages(mixed $packagesDir[, mixed $folders = array() ]) : mixed
Parameters
- $packagesDir : mixed
- $folders : mixed = array()
Return values
mixed —getProducts()
public
getProducts() : mixed
Return values
mixed —getProductTitles()
public
getProductTitles() : 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
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) : mixed
Parameters
- $text : mixed
- $type : mixed
- $nodeid : mixed
- $userid : mixed = null
- $insertNotifications : mixed = true
- $currentuserid : mixed
Return values
mixed —resetProductInfo()
public
resetProductInfo() : mixed
Return values
mixed —__construct()
protected
__construct() : mixed
Return values
mixed —getLibraryClassNameInternal()
protected
static getLibraryClassNameInternal(mixed $controller) : mixed
Parameters
- $controller : mixed
Return values
mixed —loadProductXml()
gets the list of xml files in a given folder (and of optional type).
private
loadProductXml(mixed $eDir, mixed $package[, mixed $xml = '' ][, mixed $typekey = true ]) : mixed
Parameters
- $eDir : mixed
- $package : mixed
- $xml : mixed = ''
- $typekey : mixed = true