vB_Library_External
extends vB_Library
in package
vB_Library_External
Table of Contents
- ROUTE_PATH = '/external'
- $instance : mixed
- __serialize() : mixed
- __sleep() : mixed
- __unserialize() : mixed
- __wakeup() : mixed
- checkExternalForChannels() : array<string|int, mixed>
- Check if the external data provider type is available and it actually produces a valid output for given channels.
- clearCache() : mixed
- getContentInstance() : mixed
- getExternalDataForChannels() : array<string|int, mixed>
- Get external data information for each channel specified such as external type is actually available, produces a valid output for channel and external route.
- getExternalRoute() : string
- Builds an external data provider route depending on the data specified and options to consider.
- getExternalRouteForChannels() : array<string|int, mixed>
- Build external type route for each individual channel specified.
- instance() : vB_PageCache
- 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.
- validateExternalType() : array<string|int, mixed>
- Perform checks on the given external type.
- __construct() : mixed
- getLibraryClassNameInternal() : mixed
Constants
ROUTE_PATH
public
mixed
ROUTE_PATH
= '/external'
Properties
$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 —checkExternalForChannels()
Check if the external data provider type is available and it actually produces a valid output for given channels.
public
checkExternalForChannels(mixed $channelids, mixed $type) : array<string|int, mixed>
Parameters
- $channelids : mixed
- $type : mixed
Return values
array<string|int, mixed> —Associative array with external status information for each given channel. Status will be added to each array element as '$type_enabled' key.
clearCache()
public
static clearCache() : mixed
Return values
mixed —getContentInstance()
public
static getContentInstance(mixed $contenttypeid) : mixed
Parameters
- $contenttypeid : mixed
Return values
mixed —getExternalDataForChannels()
Get external data information for each channel specified such as external type is actually available, produces a valid output for channel and external route.
public
getExternalDataForChannels(mixed $channelids, mixed $type) : array<string|int, mixed>
Parameters
- $channelids : mixed
- $type : mixed
Return values
array<string|int, mixed> —Associative array with external data for each given channel. Status will be added to each array element as '$type_enabled' key. Status will be added to each array element as '$type_route' key.
getExternalRoute()
Builds an external data provider route depending on the data specified and options to consider.
public
getExternalRoute([mixed $data = array() ][, mixed $options = array() ]) : string
Parameters
- $data : mixed = array()
- $options : mixed = array()
Return values
string —External route.
getExternalRouteForChannels()
Build external type route for each individual channel specified.
public
getExternalRouteForChannels(mixed $channelids, mixed $type) : array<string|int, mixed>
Parameters
- $channelids : mixed
- $type : mixed
Return values
array<string|int, mixed> —Associative array with external route for each given channel. Status will be added to each array element as '$type_route' key.
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
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 —validateExternalType()
Perform checks on the given external type.
public
validateExternalType(mixed $type) : array<string|int, mixed>
Parameters
- $type : mixed
Return values
array<string|int, mixed> —'valid' defines whether external type is valid or not. 'phraseid' used in case of not valid type.
__construct()
protected
__construct() : mixed
Return values
mixed —getLibraryClassNameInternal()
protected
static getLibraryClassNameInternal(mixed $controller) : mixed
Parameters
- $controller : mixed