class vB_Library_External extends vB_Library

vB_Library_External

Traits

Constants

ROUTE_PATH

Properties

static protected $instance from vB_Library

Methods

__sleep()

No description

__wakeup()

No description

__construct()

No description

static vB_PageCache
instance($class)

Returns singleton instance of self.

static 
getLibraryClassNameInternal($controller)

No description

static 
getContentInstance($contenttypeid)

No description

static 
clearCache()

No description

Array
checkExternalForChannels(Array $channelids, String $type)

Check if the external data provider type is available and it actually produces a valid output for given channels.

Array
getExternalRouteForChannels(Array $channelids, String $type)

Build external type route for each individual channel specified.

Array
getExternalDataForChannels(Array $channelids, String $type)

Get external data information for each channel specified such as external type is actually available, produces a valid output for channel and external route.

Array
validateExternalType(string $type)

Perform checks on the given external type.

String
getExternalRoute(array $data = array(), array $options = array())

Builds an external data provider route depending on the data specified and options to consider.

Details

in vB_Trait_NoSerialize at line 15
__sleep()

in vB_Trait_NoSerialize at line 20
__wakeup()

in vB_Library at line 25
protected __construct()

in vB_Library at line 35
static vB_PageCache instance($class)

Returns singleton instance of self.

Parameters

$class

Return Value

vB_PageCache
  • Reference to singleton instance of the cache handler

in vB_Library at line 52
static protected getLibraryClassNameInternal($controller)

Parameters

$controller

in vB_Library at line 91
static getContentInstance($contenttypeid)

Parameters

$contenttypeid

in vB_Library at line 99
static clearCache()

at line 34
Array checkExternalForChannels(Array $channelids, String $type)

Check if the external data provider type is available and it actually produces a valid output for given channels.

Parameters

Array $channelids List of channel ids to check external status from.
String $type External type. Supported: vB_Api_External::TYPE_JS, vB_Api_External::TYPE_XML, vB_Api_External::TYPE_RSS, vB_Api_External::TYPE_RSS1, vB_Api_External::TYPE_RSS2

Return Value

Array Associative array with external status information for each given channel. Status will be added to each array element as '$type_enabled' key.

at line 65
Array getExternalRouteForChannels(Array $channelids, String $type)

Build external type route for each individual channel specified.

Parameters

Array $channelids Channels to get route for.
String $type External type. Supported: vB_Api_External::TYPE_JS, vB_Api_External::TYPE_XML, vB_Api_External::TYPE_RSS, vB_Api_External::TYPE_RSS1, vB_Api_External::TYPE_RSS2

Return Value

Array Associative array with external route for each given channel. Status will be added to each array element as '$type_route' key.

at line 97
Array getExternalDataForChannels(Array $channelids, String $type)

Get external data information for each channel specified such as external type is actually available, produces a valid output for channel and external route.

Parameters

Array $channelids Channels to get data for.
String $type External type. Supported: vB_Api_External::TYPE_JS, vB_Api_External::TYPE_XML, vB_Api_External::TYPE_RSS, vB_Api_External::TYPE_RSS1, vB_Api_External::TYPE_RSS2

Return Value

Array 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.

at line 120
Array validateExternalType(string $type)

Perform checks on the given external type.

Parameters

string $type External type.

Return Value

Array 'valid' defines whether external type is valid or not. 'phraseid' used in case of not valid type.

at line 164
String getExternalRoute(array $data = array(), array $options = array())

Builds an external data provider route depending on the data specified and options to consider.

Parameters

array $data Data to build route querystring from. If specified, 'type' is the one and only exception on $options check since it always gets added first.
array $options Options to consider for querystring while building route.

Return Value

String External route.