oxRecommList Class Reference

Inheritance diagram for oxRecommList:
[legend]
Collaboration diagram for oxRecommList:
[legend]

List of all members.


Detailed Description

Recommendation list manager class.

Definition at line 6 of file oxrecommlist.php.


Public Member Functions

 __construct ()
 getArticles ($iStart=null, $iNrofArticles=null, $blReload=false)
 getArtCount ()
 getFirstArticle ()
 delete ($sOXID=null)
 getArtDescription ($sOXID)
 removeArticle ($sOXID)
 addArticle ($sOXID, $sDesc)
 getRecommListsByIds ($aArticleIds)
 getSearchRecommLists ($sSearchStr)
 getSearchRecommListCount ($sSearchStr)
 addToRatingAverage ($iRating)
 getReviews ()
 getLink ()
 setArticlesFilter ($sArticlesFilter)

Protected Member Functions

 _getArticleSelect ()
 _loadFirstArticles (oxList $oRecommList, $aIds)
 _getSearchSelect ($sSearchStr)

Protected Attributes

 $_sClassName = 'oxRecommList'
 $_oArticles = null
 $_sArticlesFilter = ''

Constructor & Destructor Documentation

oxRecommList.__construct (  ) 

Class constructor, initiates parent constructor (parent.oxBase()).

Returns:
null

Reimplemented from oxBase.

Definition at line 34 of file oxrecommlist.php.


Member Function Documentation

oxRecommList.getArticles ( iStart = null,
iNrofArticles = null,
blReload = false 
)

Returns list of recommendation list items

Parameters:
integer $iStart start for sql limit
integer $iNrofArticles nr of items per page
bool $blReload if TRUE forces to reload list
Returns:
oxList

Definition at line 49 of file oxrecommlist.php.

oxRecommList.getArtCount (  ) 

Returns count of recommendation list items

Returns:
array of oxUserBasketItems

Definition at line 73 of file oxrecommlist.php.

oxRecommList._getArticleSelect (  )  [protected]

Returns the appropriate SQL select

Returns:
string

Definition at line 88 of file oxrecommlist.php.

oxRecommList.getFirstArticle (  ) 

returns first article from this list's article list

Returns:
oxArticle

Definition at line 103 of file oxrecommlist.php.

oxRecommList.delete ( sOXID = null  ) 

Removes articles from the recommlist and deletes list

Parameters:
string $sOXID Object ID(default null)
Returns:
bool

Reimplemented from oxBase.

Definition at line 119 of file oxrecommlist.php.

oxRecommList.getArtDescription ( sOXID  ) 

Returns article description for recommendation list

Parameters:
string $sOXID Object ID
Returns:
string

Definition at line 143 of file oxrecommlist.php.

oxRecommList.removeArticle ( sOXID  ) 

Remove article from recommendation list

Parameters:
string $sOXID Object ID
Returns:
bool

Definition at line 161 of file oxrecommlist.php.

oxRecommList.addArticle ( sOXID,
sDesc 
)

Add article to recommendation list

Parameters:
string $sOXID Object ID
string $sDesc recommended article description
Returns:
bool

Definition at line 179 of file oxrecommlist.php.

oxRecommList.getRecommListsByIds ( aArticleIds  ) 

get recommendation lists wich include given article ids also sort these lists by these criterias: 1. show lists, that has more requested articles first 2. show lists, that have more any articles

Parameters:
array $aArticleIds Object IDs
Returns:
oxList

Definition at line 204 of file oxrecommlist.php.

oxRecommList._loadFirstArticles ( oxList oRecommList,
aIds 
) [protected]

loads first articles to recomm list also ordering them and clearing not usable list objects ordering priorities: 1. first show articles from our search 2. do not shown articles as 1st, which are shown in other recomm lists as 1st

Parameters:
oxList $oRecommList recommendation list
array $aIds article ids
Returns:
null

Definition at line 270 of file oxrecommlist.php.

oxRecommList.getSearchRecommLists ( sSearchStr  ) 

Returns user recommendation list objects

Parameters:
string $sSearchStr Search string
Returns:
object oxlist with oxrecommlist objects

Definition at line 306 of file oxrecommlist.php.

oxRecommList.getSearchRecommListCount ( sSearchStr  ) 

Returns the amount of lists according to search parameters.

Parameters:
string $sSearchStr Search string
Returns:
int

Definition at line 334 of file oxrecommlist.php.

oxRecommList._getSearchSelect ( sSearchStr  )  [protected]

Returns the appropriate SQL select according to search parameters

Parameters:
string $sSearchStr Search string
Returns:
string

Definition at line 354 of file oxrecommlist.php.

oxRecommList.addToRatingAverage ( iRating  ) 

Calculates and saves product rating average

Parameters:
integer $iRating new rating value
Returns:
null

Definition at line 374 of file oxrecommlist.php.

oxRecommList.getReviews (  ) 

Collects user written reviews about an article.

Returns:
oxList

Definition at line 388 of file oxrecommlist.php.

oxRecommList.getLink (  ) 

return url to this recomm list page

Returns:
string

Definition at line 404 of file oxrecommlist.php.

oxRecommList.setArticlesFilter ( sArticlesFilter  ) 

set sql filter for article loading

Parameters:
string $sArticlesFilter article filter
Returns:
null

Definition at line 425 of file oxrecommlist.php.


Member Data Documentation

oxRecommList.$_sClassName = 'oxRecommList' [protected]

Reimplemented from oxBase.

Definition at line 13 of file oxrecommlist.php.

oxRecommList.$_oArticles = null [protected]

Definition at line 20 of file oxrecommlist.php.

oxRecommList.$_sArticlesFilter = '' [protected]

Definition at line 27 of file oxrecommlist.php.


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

Generated on Thu Dec 4 12:05:30 2008 for OXID eShop CE by  doxygen 1.5.5