Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes

oxRssFeed Class Reference

Inheritance diagram for oxRssFeed:
Collaboration diagram for oxRssFeed:

List of all members.

Public Member Functions

 getChannel ()
 getTopInShopTitle ()
 getTopInShopUrl ()
 loadTopInShop ()
 getNewestArticlesTitle ()
 getNewestArticlesUrl ()
 loadNewestArticles ()
 getCategoryArticlesTitle (oxCategory $oCat)
 getCategoryArticlesUrl (oxCategory $oCat)
 loadCategoryArticles (oxCategory $oCat)
 getSearchArticlesTitle ($sSearch, $sCatId, $sVendorId, $sManufacturerId)
 getSearchArticlesUrl ($sSearch, $sCatId, $sVendorId, $sManufacturerId)
 loadSearchArticles ($sSearch, $sCatId, $sVendorId, $sManufacturerId)
 getRecommListsTitle (oxArticle $oArticle)
 getRecommListsUrl (oxArticle $oArticle)
 loadRecommLists (oxArticle $oArticle)
 getRecommListArticlesTitle (oxRecommList $oRecommList)
 getRecommListArticlesUrl (oxRecommList $oRecommList)
 loadRecommListArticles (oxRecommList $oRecommList)
 getBargainTitle ()
 getBargainUrl ()
 loadBargain ()
 getCacheTtl ()

Public Attributes

const CACHE_TTL = 10800
const RSS_TOPSHOP = 'RSS_TopShop'
const RSS_NEWARTS = 'RSS_NewArts'
const RSS_CATARTS = 'RSS_CatArts'
const RSS_ARTRECOMMLISTS = 'RSS_ARTRECOMMLISTS'
const RSS_RECOMMLISTARTS = 'RSS_RECOMMLISTARTS'
const RSS_BARGAIN = 'RSS_Bargain'

Protected Member Functions

 _loadBaseChannel ()
 _getCacheId ($name)
 _loadFromCache ($name)
 _getLastBuildDate ($name, $aData)
 _saveToCache ($name, $aContent)
 _getArticleItems (oxArticleList $oList)
 _prepareUrl ($sUri, $sTitle)
 _prepareFeedName ($sTitle)
 _getShopUrl ()
 _loadData ($sTag, $sTitle, $sDesc, $aItems, $sRssUrl, $sTargetUrl=null)
 _getCatPath ($oCat)
 _getSearchParamsUrl ($sSearch, $sCatId, $sVendorId, $sManufacturerId)
 _getObjectField ($sId, $sObject, $sField)
 _getSearchParamsTranslation ($sSearch, $sId, $sCatId, $sVendorId, $sManufacturerId)
 _getRecommListItems ($oList)

Protected Attributes

 $_aChannel = array()

Detailed Description

Rss feed manager loads needed rss data

Definition at line 8 of file oxrssfeed.php.

Member Function Documentation

oxRssFeed._getArticleItems ( oxArticleList $  oList  )  [protected]

_getArticleItems create channel items from article list

Parameters:
oxArticleList $oList article list

protected

Returns:
array

Definition at line 160 of file oxrssfeed.php.

oxRssFeed._getCacheId ( $  name  )  [protected]

_getCacheId retrieve cache id

Parameters:
string $name cache name

protected

Returns:
string

Definition at line 85 of file oxrssfeed.php.

oxRssFeed._getCatPath ( $  oCat  )  [protected]

Returns string built from category titles

Parameters:
oxCategory $oCat category object
Returns:
string

Definition at line 435 of file oxrssfeed.php.

oxRssFeed._getLastBuildDate ( $  name,
$  aData 
) [protected]

_getLastBuildDate check if changed data and renew last build date if needed returns result as string

Parameters:
string $name Rss data Id
array $aData channel data

protected

Returns:
string

Definition at line 120 of file oxrssfeed.php.

oxRssFeed._getObjectField ( $  sId,
$  sObject,
$  sField 
) [protected]

loads object and returns specified field

Parameters:
string $sId object id
string $sObject object class
string $sField object field to be taken

protected

Returns:
string

Definition at line 554 of file oxrssfeed.php.

oxRssFeed._getRecommListItems ( $  oList  )  [protected]

make rss data array from given oxlist

Parameters:
oxList $oList recommlist object
Returns:
array

Definition at line 700 of file oxrssfeed.php.

oxRssFeed._getSearchParamsTranslation ( $  sSearch,
$  sId,
$  sCatId,
$  sVendorId,
$  sManufacturerId 
) [protected]

_getSearchParamsTranslation translates text for given lang id loads category and vendor to take their titles.

Parameters:
string $sSearch search param
string $sId language id
string $sCatId category id
string $sVendorId vendor id
string $sManufacturerId Manufacturer id

protected

Returns:
string

Definition at line 579 of file oxrssfeed.php.

oxRssFeed._getSearchParamsUrl ( $  sSearch,
$  sCatId,
$  sVendorId,
$  sManufacturerId 
) [protected]

_getSearchParamsUrl return search parameters for url

Parameters:
string $sSearch search string
string $sCatId category id
string $sVendorId vendor id
string $sManufacturerId Manufacturer id

protected

Returns:
string

Definition at line 526 of file oxrssfeed.php.

oxRssFeed._getShopUrl (  )  [protected]

_getShopUrl returns shop home url

protected

Returns:
string

Definition at line 255 of file oxrssfeed.php.

oxRssFeed._loadBaseChannel (  )  [protected]

_loadBaseChannel loads basic channel data

protected

Returns:
void

Definition at line 50 of file oxrssfeed.php.

oxRssFeed._loadData ( $  sTag,
$  sTitle,
$  sDesc,
$  aItems,
$  sRssUrl,
$  sTargetUrl = null 
) [protected]

_loadData loads given data to channel

Parameters:
string $sTag tag
string $sTitle object title
string $sDesc object description
array $aItems items data to be put to rss
string $sRssUrl url of rss page
string $sTargetUrl url of page rss represents

protected

Returns:
void

Definition at line 282 of file oxrssfeed.php.

oxRssFeed._loadFromCache ( $  name  )  [protected]

_loadFromCache load data from cache, requires Rss data Id

Parameters:
string $name Rss data Id

protected

Returns:
array

Definition at line 99 of file oxrssfeed.php.

oxRssFeed._prepareFeedName ( $  sTitle  )  [protected]

_prepareFeedName adds shop name to feed title

Parameters:
string $sTitle page title

protected

Returns:
string

Definition at line 242 of file oxrssfeed.php.

oxRssFeed._prepareUrl ( $  sUri,
$  sTitle 
) [protected]

_prepareUrl make url from uri

Parameters:
string $sUri standard uri
string $sTitle page title

protected

Returns:
string

Definition at line 219 of file oxrssfeed.php.

oxRssFeed._saveToCache ( $  name,
$  aContent 
) [protected]

_saveToCache writes generated rss data to cache returns true on successfull write, false otherwise A successfull write means only write ok AND data has actually changed if give

Parameters:
string $name cache name
array $aContent data to be saved

protected

Returns:
void

Definition at line 145 of file oxrssfeed.php.

oxRssFeed.getBargainTitle (  ) 

getBargainTitle get title for 'Bargain' rss feed

public

Returns:
string

Definition at line 811 of file oxrssfeed.php.

oxRssFeed.getBargainUrl (  ) 

getBargainUrl get url for 'Bargain' rss feed

public

Returns:
string

Definition at line 825 of file oxrssfeed.php.

oxRssFeed.getCacheTtl (  ) 

Returns timestamp of defind cache time to live

Returns:
integer

Definition at line 861 of file oxrssfeed.php.

oxRssFeed.getCategoryArticlesTitle ( oxCategory $  oCat  ) 

get title for 'Category Articles' rss feed

Parameters:
oxCategory $oCat category object

public

Returns:
string

Definition at line 420 of file oxrssfeed.php.

oxRssFeed.getCategoryArticlesUrl ( oxCategory $  oCat  ) 

getCategoryArticlesUrl get url for 'Category Articles' rss feed

Parameters:
oxCategory $oCat category object

public

Returns:
string

Definition at line 458 of file oxrssfeed.php.

oxRssFeed.getChannel (  ) 

getChannel retrieve channel data

public

Returns:
array

Definition at line 39 of file oxrssfeed.php.

oxRssFeed.getNewestArticlesTitle (  ) 

get title for 'Newest Shop Articles' rss feed

public

Returns:
string

Definition at line 366 of file oxrssfeed.php.

oxRssFeed.getNewestArticlesUrl (  ) 

getNewestArticlesUrl get url for 'Newest Shop Articles' rss feed

public

Returns:
string

Definition at line 380 of file oxrssfeed.php.

oxRssFeed.getRecommListArticlesTitle ( oxRecommList $  oRecommList  ) 

get title for 'Recommendation list articles' rss feed

Parameters:
oxRecommList $oRecommList recomm list to load articles from
Returns:
string

Definition at line 755 of file oxrssfeed.php.

oxRssFeed.getRecommListArticlesUrl ( oxRecommList $  oRecommList  ) 

get url for 'Recommendation lists' rss feed

Parameters:
oxRecommList $oRecommList recomm list to load articles from
Returns:
string

Definition at line 769 of file oxrssfeed.php.

oxRssFeed.getRecommListsTitle ( oxArticle $  oArticle  ) 

get title for 'Recommendation lists' rss feed

Parameters:
oxArticle $oArticle load lists for this article
Returns:
string

Definition at line 671 of file oxrssfeed.php.

oxRssFeed.getRecommListsUrl ( oxArticle $  oArticle  ) 

get url for 'Recommendation lists' rss feed

Parameters:
oxArticle $oArticle load lists for this article
Returns:
string

Definition at line 685 of file oxrssfeed.php.

oxRssFeed.getSearchArticlesTitle ( $  sSearch,
$  sCatId,
$  sVendorId,
$  sManufacturerId 
)

get title for 'Search Articles' rss feed

Parameters:
string $sSearch search string
string $sCatId category id
string $sVendorId vendor id
string $sManufacturerId Manufacturer id

public

Returns:
string

Definition at line 509 of file oxrssfeed.php.

oxRssFeed.getSearchArticlesUrl ( $  sSearch,
$  sCatId,
$  sVendorId,
$  sManufacturerId 
)

getSearchArticlesUrl get url for 'Search Articles' rss feed

Parameters:
string $sSearch search string
string $sCatId category id
string $sVendorId vendor id
string $sManufacturerId Manufacturer id

public

Returns:
string

Definition at line 616 of file oxrssfeed.php.

oxRssFeed.getTopInShopTitle (  ) 

getTopShopTitle get title for 'Top of the Shop' rss feed

public

Returns:
string

Definition at line 312 of file oxrssfeed.php.

oxRssFeed.getTopInShopUrl (  ) 

getTopShopUrl get url for 'Top of the Shop' rss feed

public

Returns:
string

Definition at line 326 of file oxrssfeed.php.

oxRssFeed.loadBargain (  ) 

loadBargain loads 'Bargain' rss data

public

Returns:
void

Definition at line 837 of file oxrssfeed.php.

oxRssFeed.loadCategoryArticles ( oxCategory $  oCat  ) 

loadCategoryArticles loads 'Category Articles' rss data

Parameters:
oxCategory $oCat category object

public

Returns:
void

Definition at line 474 of file oxrssfeed.php.

oxRssFeed.loadNewestArticles (  ) 

loadNewestArticles loads 'Newest Shop Articles' rss data

public

Returns:
void

Definition at line 392 of file oxrssfeed.php.

oxRssFeed.loadRecommListArticles ( oxRecommList $  oRecommList  ) 

loads 'Recommendation lists' rss data

Parameters:
oxRecommList $oRecommList recomm list to load articles from
Returns:
null

Definition at line 784 of file oxrssfeed.php.

oxRssFeed.loadRecommLists ( oxArticle $  oArticle  ) 

loads 'Recommendation lists' rss data

Parameters:
oxArticle $oArticle load lists for this article
Returns:
null

Definition at line 723 of file oxrssfeed.php.

oxRssFeed.loadSearchArticles ( $  sSearch,
$  sCatId,
$  sVendorId,
$  sManufacturerId 
)

loadSearchArticles loads 'Search Articles' rss data

Parameters:
string $sSearch search string
string $sCatId category id
string $sVendorId vendor id
string $sManufacturerId Manufacturer id

public

Returns:
void

Definition at line 640 of file oxrssfeed.php.

oxRssFeed.loadTopInShop (  ) 

loadTopShop loads 'Top of the Shop' rss data

public

Returns:
void

Definition at line 338 of file oxrssfeed.php.

Member Data Documentation

oxRssFeed.$_aChannel = array() [protected]

Definition at line 31 of file oxrssfeed.php.

const oxRssFeed.CACHE_TTL = 10800

timeout in seconds for regenerating data (3h)

Definition at line 13 of file oxrssfeed.php.

const oxRssFeed.RSS_ARTRECOMMLISTS = 'RSS_ARTRECOMMLISTS'

Definition at line 21 of file oxrssfeed.php.

const oxRssFeed.RSS_BARGAIN = 'RSS_Bargain'

Definition at line 23 of file oxrssfeed.php.

const oxRssFeed.RSS_CATARTS = 'RSS_CatArts'

Definition at line 20 of file oxrssfeed.php.

const oxRssFeed.RSS_NEWARTS = 'RSS_NewArts'

Definition at line 19 of file oxrssfeed.php.

const oxRssFeed.RSS_RECOMMLISTARTS = 'RSS_RECOMMLISTARTS'

Definition at line 22 of file oxrssfeed.php.

const oxRssFeed.RSS_TOPSHOP = 'RSS_TopShop'

Rss data Ids for cache

Definition at line 18 of file oxrssfeed.php.

The documentation for this class was generated from the following file:
Generated by  doxygen 1.7.1