oxRssFeed Class Reference

Inheritance diagram for oxRssFeed:

[legend]

Collaboration diagram for oxRssFeed:

[legend]

List of all members.

---

Detailed Description

Rss feed manager loads needed rss data

Public Member Functions
	getChannel ()
	getTopInShopTitle ()
	getTopInShopUrl ()
	loadTopInShop ()
	getNewestArticlesTitle ()
	getNewestArticlesUrl ()
	loadNewestArticles ()
	getCategoryArticlesTitle (oxCategory $oCat)
	getCategoryArticlesUrl (oxCategory $oCat)
	loadCategoryArticles (oxCategory $oCat)
	getSearchArticlesTitle ($sSearch, $sCatId, $sVendorId)
	getSearchArticlesUrl ($sSearch, $sCatId, $sVendorId)
	loadSearchArticles ($sSearch, $sCatId, $sVendorId)
	getRecommListsTitle (oxArticle $oArticle)
	getRecommListsUrl (oxArticle $oArticle)
	loadRecommLists (oxArticle $oArticle)
	getRecommListArticlesTitle (oxRecommList $oRecommList)
	getRecommListArticlesUrl (oxRecommList $oRecommList)
	loadRecommListArticles (oxRecommList $oRecommList)
	getBargainTitle ()
	getBargainUrl ()
	loadBargain ()
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)
	_getObjectField ($sId, $sObject, $sField)
	_getSearchParamsTranslation ($sId, $sSearch, $sCatId, $sVendorId)
	_getRecommListItems ($oList)
Protected Attributes
	$_aChannel = array()

---

Member Function Documentation

oxRssFeed.getChannel

(

)

getChannel retrieve channel data

public

Returns:

array

oxRssFeed._loadBaseChannel

(

)

[protected]

_loadBaseChannel loads basic channel data

protected

Returns:

void

oxRssFeed._getCacheId

(

$

name

)

[protected]

_getCacheId retrieve cache id

Parameters:

string

$name cache name

protected

Returns:

string

oxRssFeed._loadFromCache

(

$

name

)

[protected]

_loadFromCache load data from cache, requires Rss data Id

Parameters:

string

$name Rss data Id

protected

Returns:

array

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

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

oxRssFeed._getArticleItems

(

oxArticleList $

oList

)

[protected]

_getArticleItems create channel items from article list

Parameters:

oxArticleList

$oList article list

protected

Returns:

array

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

_prepareUrl make url from uri

Parameters:

	string	$sUri standart uri
	string	$sTitle page title

protected

Returns:

string

oxRssFeed._prepareFeedName

(

$

sTitle

)

[protected]

_prepareFeedName adds shop name to feed title

Parameters:

string

$sTitle page title

protected

Returns:

string

oxRssFeed._getShopUrl

(

)

[protected]

_getShopUrl returns shop home url

protected

Returns:

string

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

oxRssFeed.getTopInShopTitle

(

)

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

public

Returns:

string

oxRssFeed.getTopInShopUrl

(

)

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

public

Returns:

string

oxRssFeed.loadTopInShop

(

)

loadTopShop loads 'Top of the Shop' rss data

public

Returns:

void

oxRssFeed.getNewestArticlesTitle

(

)

get title for 'Newest Shop Articles' rss feed

public

Returns:

string

oxRssFeed.getNewestArticlesUrl

(

)

getNewestArticlesUrl get url for 'Newest Shop Articles' rss feed

public

Returns:

string

oxRssFeed.loadNewestArticles

(

)

loadNewestArticles loads 'Newest Shop Articles' rss data

public

Returns:

void

oxRssFeed.getCategoryArticlesTitle

(

oxCategory $

oCat

)

get title for 'Category Articles' rss feed

Parameters:

oxCategory

$oCat category object

public

Returns:

string

oxRssFeed._getCatPath

(

$

oCat

)

[protected]

Returns string built from category titles

Returns:

string

oxRssFeed.getCategoryArticlesUrl

(

oxCategory $

oCat

)

getCategoryArticlesUrl get url for 'Category Articles' rss feed

Parameters:

oxCategory

$oCat category object

public

Returns:

string

oxRssFeed.loadCategoryArticles

(

oxCategory $

oCat

)

loadCategoryArticles loads 'Category Articles' rss data

Parameters:

oxCategory

$oCat category object

public

Returns:

void

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

get title for 'Search Articles' rss feed

Parameters:

	string	$sSearch search string
	string	$sCatId category id
	string	$sVendorId vendor id

public

Returns:

string

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

_getSearchParamsUrl return search parameters for url

Parameters:

	string	$sSearch search string
	string	$sCatId category id
	string	$sVendorId vendor id

protected

Returns:

string

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

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

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

Parameters:

	string	$sId language id
	string	$sSearch search param
	string	$sCatId category id
	string	$sVendorId vendor id

protected

Returns:

string

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

getSearchArticlesUrl get url for 'Search Articles' rss feed

Parameters:

	string	$sSearch search string
	string	$sCatId category id
	string	$sVendorId vendor id

public

Returns:

string

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

loadSearchArticles loads 'Search Articles' rss data

Parameters:

	string	$sSearch search string
	string	$sCatId category id
	string	$sVendorId vendor id

public

Returns:

void

oxRssFeed.getRecommListsTitle

(

oxArticle $

oArticle

)

get title for 'Recommendation lists' rss feed

Parameters:

oxArticle

$oArticle load lists for this article

Returns:

string

oxRssFeed.getRecommListsUrl

(

oxArticle $

oArticle

)

get url for 'Recommendation lists' rss feed

Parameters:

oxArticle

$oArticle load lists for this article

Returns:

string

oxRssFeed._getRecommListItems

(

$

oList

)

[protected]

make rss data array from given oxlist

Parameters:

oxList

$oList

Returns:

array

oxRssFeed.loadRecommLists

(

oxArticle $

oArticle

)

loads 'Recommendation lists' rss data

Parameters:

oxArticle

$oArticle load lists for this article

Returns:

null

oxRssFeed.getRecommListArticlesTitle

(

oxRecommList $

oRecommList

)

get title for 'Recommendation list articles' rss feed

Parameters:

oxRecommList

$oRecommList recomm list to load articles from

Returns:

string

oxRssFeed.getRecommListArticlesUrl

(

oxRecommList $

oRecommList

)

get url for 'Recommendation lists' rss feed

Parameters:

oxRecommList

$oRecommList recomm list to load articles from

Returns:

string

oxRssFeed.loadRecommListArticles

(

oxRecommList $

oRecommList

)

loads 'Recommendation lists' rss data

Parameters:

oxRecommList

$oRecommList recomm list to load articles from

Returns:

null

oxRssFeed.getBargainTitle

(

)

getBargainTitle get title for 'Bargain' rss feed

public

Returns:

string

oxRssFeed.getBargainUrl

(

)

getBargainUrl get url for 'Bargain' rss feed

public

Returns:

string

oxRssFeed.loadBargain

(

)

loadBargain loads 'Bargain' rss data

public

Returns:

void

---

Member Data Documentation

const oxRssFeed.CACHE_TTL = 10800

timeout in seconds for regenerating data (3h)

const oxRssFeed.RSS_TOPSHOP = 'RSS_TopShop'

Rss data Ids for cache

const oxRssFeed.RSS_NEWARTS = 'RSS_NewArts'

const oxRssFeed.RSS_CATARTS = 'RSS_CatArts'

const oxRssFeed.RSS_ARTRECOMMLISTS = 'RSS_ARTRECOMMLISTS'

const oxRssFeed.RSS_RECOMMLISTARTS = 'RSS_RECOMMLISTARTS'

const oxRssFeed.RSS_BARGAIN = 'RSS_Bargain'

oxRssFeed.$_aChannel = array() [protected]

---

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

• core/oxrssfeed.php