UNA
Loading...
Searching...
No Matches
BxDolRss Class Reference
Inheritance diagram for BxDolRss:
BxDolFactory iBxDolFactoryObject BxBaseRss BxTemplRss BxDolRssBoonEx BxDolRssPageBlock BxDolStudioRssModuleHelp BxDolStudioRssPageHelp

Public Member Functions

 getUrl ($mixedId)
 

Static Public Member Functions

static getObjectInstance ($sObject)
 

Static Public Attributes

static $bInitialized = false
 

Protected Member Functions

 __construct ($aObject)
 

Protected Attributes

 $_oDb
 
 $_sObject
 
 $_aObject
 

Detailed Description

This class unifies the usage of RSS feeds in the script.

Usage.

Step 1: Add record to sys_objects_rss table, like you are doing this for Comments or Voting objects:

  • object: your rss object name, usually it is in the following format - vendor prefix, underscore, module prefix;
  • class_name: user defined class name which is derived from BxTemplRss.
  • class_file: the location of the user defined class, leave it empty if class is located in system folders.

Step 2: Write a code for getUrl method in your class (MyModuleRss) which is derived from BxTemplRss.

public function getUrl($mixedId) {
if(!isset($this->aFeeds[$mixedId]))
return false;
return $this->aFeeds[$mixedId];
}

Step 2: Get an RSS placeholder to display somewhere on a page

BxDolRss::getObjectInstance('my_module_rss_object')->getHolder($mixedRssId, $iRssNum);
static getObjectInstance($sObject)
Definition BxDolRss.php:67

Constructor & Destructor Documentation

◆ __construct()

BxDolRss::__construct ( $aObject)
protected

Member Function Documentation

◆ getObjectInstance()

static BxDolRss::getObjectInstance ( $sObject)
static

Get rss object instance by object name

Parameters
$sObjectobject name
Returns
object instance or false on error

Implements iBxDolFactoryObject.


The documentation for this class was generated from the following file: